diff --git a/docs/setup.md b/docs/setup.md index 4b68dbd..fc6ef10 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -13,10 +13,9 @@ 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. Invite the created bot to your server -3. Install Node.js 11, 12, 13, or 14 -4. Download the latest bot version from [the releases page](https://github.com/Dragory/modmailbot/releases) and extract it to a folder -5. In the bot's folder, make a copy of the file `config.example.ini` and rename the copy to `config.ini` +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` ## Single-server setup 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!** 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` - - Replace `CATEGORY_ID_HERE` with the ID of the category where new modmail threads should go -4. Make sure the bot has `Manage Channels`, `Manage Messages`, and `Attach Files` permissions in the category -5. **[🏃 Start the bot!](starting-the-bot.md)** -6. Want to change other bot options? See **[📝 Configuration](configuration.md)** -7. Have any other questions? Check out the **[🙋 Frequently Asked Questions](faq.md)** or +3. Invite the bot to the server +4. On a new line at the end of `config.ini`, add `categoryAutomation.newThread = CATEGORY_ID_HERE` + * Replace `CATEGORY_ID_HERE` with the ID of the category where new modmail threads should go +5. Make sure the bot has `Manage Channels`, `Manage Messages`, and `Attach Files` permissions in the category + * It is not recommended to give the bot Administrator permissions under *any* circumstances +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)** ## Two-server setup @@ -39,12 +40,16 @@ You might also want this setup for privacy concerns*. 1. **Go through the [prerequisites](#prerequisites) above first!** 2. Create an inbox server on Discord -3. Invite the bot to the inbox server. -4. Open `config.ini` in a text editor and fill in the values -5. Make sure the bot has the `Manage Channels`, `Manage Messages`, and `Attach Files` permissions on the **inbox** server -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 +3. Open `config.ini` in a text editor and fill in the required values + * Set `mainGuildId` to the ID of the *main* server where users will message the bot from + * Set `mailGuildId` to the ID of the *inbox* server created in step 2 +4. Invite the bot to both the main server and the newly-created inbox server +5. Open `config.ini` in a text editor and fill in the values +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)** *\* Since all channel names, even for channels you can't see, are public information through the API, a user with a