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

Update setup instructions

cshd
Dragory 2020-08-16 22:21:49 +03:00
parent 0ce73f9344
commit 60ae79d4e4
No known key found for this signature in database
GPG Key ID: 5F387BA66DF8AAC1
1 changed files with 21 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/setup.md
View File

@ -13,10 +13,9 @@ To keep it online, you need to keep the bot process running.
## Prerequisites ## Prerequisites
1. Create a bot account through the [Discord Developer Portal](https://discordapp.com/developers/) 1. Create a bot account through the [Discord Developer Portal](https://discordapp.com/developers/)
2. Invite the created bot to your server 2. Install Node.js 12, 13, or 14
3. Install Node.js 11, 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. 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`
5. In the bot's folder, make a copy of the file `config.example.ini` and rename the copy to `config.ini`
## Single-server setup ## Single-server setup
In this setup, modmail threads are opened on the main server in a special category. In this setup, modmail threads are opened on the main server in a special category.
@ -24,12 +23,14 @@ This is the recommended setup for small and medium sized servers.
1. **Go through the [prerequisites](#prerequisites) above first!** 1. **Go through the [prerequisites](#prerequisites) above first!**
2. Open `config.ini` in a text editor and fill in the required values. `mainGuildId` and `mailGuildId` should both be set to your server's id. 2. Open `config.ini` in a text editor and fill in the required values. `mainGuildId` and `mailGuildId` should both be set to your server's id.
3. On a new line at the end of `config.ini`, add `categoryAutomation.newThread = CATEGORY_ID_HERE` 3. Invite the bot to the server
- Replace `CATEGORY_ID_HERE` with the ID of the category where new modmail threads should go 4. On a new line at the end of `config.ini`, add `categoryAutomation.newThread = CATEGORY_ID_HERE`
4. Make sure the bot has `Manage Channels`, `Manage Messages`, and `Attach Files` permissions in the category * Replace `CATEGORY_ID_HERE` with the ID of the category where new modmail threads should go
5. **[🏃 Start the bot!](starting-the-bot.md)** 5. Make sure the bot has `Manage Channels`, `Manage Messages`, and `Attach Files` permissions in the category
6. Want to change other bot options? See **[📝 Configuration](configuration.md)** * It is not recommended to give the bot Administrator permissions under *any* circumstances
7. Have any other questions? Check out the **[🙋 Frequently Asked Questions](faq.md)** or 6. **[🏃 Start the bot!](starting-the-bot.md)**
7. Want to change other bot options? See **[📝 Configuration](configuration.md)**
8. Have any other questions? Check out the **[🙋 Frequently Asked Questions](faq.md)** or
**[join the support server!](../README.md#support-server)** **[join the support server!](../README.md#support-server)**
## Two-server setup ## Two-server setup
@ -39,12 +40,16 @@ You might also want this setup for privacy concerns*.
1. **Go through the [prerequisites](#prerequisites) above first!** 1. **Go through the [prerequisites](#prerequisites) above first!**
2. Create an inbox server on Discord 2. Create an inbox server on Discord
3. Invite the bot to the inbox server. 3. Open `config.ini` in a text editor and fill in the required values
4. Open `config.ini` in a text editor and fill in the values * Set `mainGuildId` to the ID of the *main* server where users will message the bot from
5. Make sure the bot has the `Manage Channels`, `Manage Messages`, and `Attach Files` permissions on the **inbox** server * Set `mailGuildId` to the ID of the *inbox* server created in step 2
6. **[🏃 Start the bot!](starting-the-bot.md)** 4. Invite the bot to both the main server and the newly-created inbox server
7. Want to change other bot options? See **[📝 Configuration](configuration.md)** 5. Open `config.ini` in a text editor and fill in the values
8. Have any other questions? Check out the **[🙋 Frequently Asked Questions](faq.md)** or 6. Make sure the bot has the `Manage Channels`, `Manage Messages`, and `Attach Files` permissions on the **inbox** server
* The bot does not need any permissions on the main server
7. **[🏃 Start the bot!](starting-the-bot.md)**
8. Want to change other bot options? See **[📝 Configuration](configuration.md)**
9. Have any other questions? Check out the **[🙋 Frequently Asked Questions](faq.md)** or
**[join the support server!](../README.md#support-server)** **[join the support server!](../README.md#support-server)**
*\* Since all channel names, even for channels you can't see, are public information through the API, a user with a *\* Since all channel names, even for channels you can't see, are public information through the API, a user with a