From 63fa0a8b9ae45d9d4c5ae5e27710a2ef501b5c07 Mon Sep 17 00:00:00 2001 From: Dragory <2606411+Dragory@users.noreply.github.com> Date: Tue, 3 Dec 2019 02:49:37 +0200 Subject: [PATCH] docs: move two-server setup above single-server setup; wording/style tweaks --- docs/setup.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index 21409bf..5e65a2c 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,5 +1,6 @@ # 🛠️ Setting up the bot -**Note:** This bot is run on your own machine or a server. To keep it online, you need to have the bot process running at all time. +**Note:** This bot is run on your own machine or a server. +To keep it online, you need to keep the bot process running. ## Terminology * **Main server** (or main guild) is the server where users will be contacting modmail from @@ -18,15 +19,6 @@ 4. Download the latest bot version from [the releases page](https://github.com/Dragory/modmailbot/releases) and extract it to a folder 5. Make a copy of the file `config.example.ini` in the bot's folder and name the copy `config.ini` -## Single-server setup -In this setup, modmail threads are opened on the main server in a special category. -1. 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. 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 -3. Make sure the bot has `Manage Channels`, `Manage Messages`, and `Attach Files` permissions in the category -4. [🏃 Start the bot!](starting-the-bot.md) -5. Want to change other bot options? See [📝 Configuration](configuration.md). - ## Two-server setup In this setup, modmail threads are opened on a separate inbox server. 1. Create an inbox server on Discord @@ -35,3 +27,12 @@ In this setup, modmail threads are opened on a separate inbox server. 4. Make sure the bot has the `Manage Channels`, `Manage Messages`, and `Attach Files` permissions on the **inbox** server 5. [🏃 Start the bot!](starting-the-bot.md) 5. Want to change other bot options? See [📝 Configuration](configuration.md). + +## Single-server setup +In this setup, modmail threads are opened on the main server in a special category. +1. 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. 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 +3. Make sure the bot has `Manage Channels`, `Manage Messages`, and `Attach Files` permissions in the category +4. [🏃 Start the bot!](starting-the-bot.md) +5. Want to change other bot options? See [📝 Configuration](configuration.md).