engineering
/
ramirez
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update prerequisite docs

cshd
Dragory 2020-08-16 23:44:48 +03:00
parent a863c1b382
commit 3f2948bbc1
No known key found for this signature in database
GPG Key ID: 5F387BA66DF8AAC1
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/setup.md
View File

@ -14,8 +14,11 @@ To keep it online, you need to keep the bot process running.
## Prerequisites
1. Create a bot account through the [Discord Developer Portal](https://discordapp.com/developers/)
2. Install Node.js 12, 13, or 14
3. Download the latest bot version from [the releases page](https://github.com/Dragory/modmailbot/releases) and extract it to a folder
4. In the bot's folder, make a copy of the file `config.example.ini` and rename the copy to `config.ini`
3. Download the latest bot version from [the releases page](https://github.com/Dragory/modmailbot/releases)
* Make sure the release doesn't say "Pre-release" next to it unless you want to run an unstable beta version!
4. Extract the zip file that you just downloaded
5. In the bot's folder (that you extracted from the zip file), make a copy of the file `config.example.ini` and rename the copy to `config.ini`
* If you're on Windows, the file may be named `config.example` (without `.ini` at the end)
## Single-server setup
In this setup, modmail threads are opened on the main server in a special category.