From 56bc9798633dc1329d1b5c6e178f096ca9e56b7f Mon Sep 17 00:00:00 2001 From: Dragory <2606411+Dragory@users.noreply.github.com> Date: Thu, 5 Dec 2019 20:53:38 +0200 Subject: [PATCH] Add FAQ --- README.md | 1 + docs/faq.md | 21 +++++++++++++++++++++ docs/setup.md | 4 ++++ 3 files changed, 26 insertions(+) create mode 100644 docs/faq.md diff --git a/README.md b/README.md index e20aee2..4863c7f 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Inspired by Reddit's modmail system. * [📝 Configuration](docs/configuration.md) * [🤖 Commands](docs/commands.md) * [🧩 Plugins](docs/plugins.md) +* [🙋 Frequently Asked Questions](docs/faq.md) * [Release notes](CHANGELOG.md) ## Support server diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000..29b0370 --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,21 @@ +# 🙋 Frequently Asked Questions + +## In a [single-server setup](setup.md#single-server-setup), how do I hide modmails from regular users? +1. Create a private category for modmail threads that only your server staff and the bot can see and set the option +`categoryAutomation.newThread = 1234` (replace `1234` with the ID of the category) +2. Set the `inboxServerPermission` option to limit who can use bot commands. + [Click here for more information.](configuration.md#inboxserverpermission) + +## My logs and/or attachments aren't loading! +Since logs and attachments are both stored and sent directly from the machine running the bot, you'll need to make sure +that the machine doesn't have a firewall blocking the bot and has the appropriate port forwardings set up. +[You can find more information and instructions for port forwarding here.](https://portforward.com/) +By default, the bot uses the port **8890**. + +## I don't want attachments saved on my computer +As an alternative to storing modmail attachments on the machine running the bot, they can be stored in a special Discord +channel instead. Create a new text channel and then set the options `attachmentStorage = discord` and +`attachmentStorageChannelId = 1234` (replace `1234` with the ID of the new channel). + +## I want to categorize my modmail threads in multiple categories +Set `allowMove = on` to allow your staff to move threads to other categories with `!move` diff --git a/docs/setup.md b/docs/setup.md index 8c22b00..ab724f0 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -29,6 +29,8 @@ This is the recommended setup for small and medium sized servers. 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)** +6. Have any other questions? Check out the **[🙋 Frequently Asked Questions](faq.md)** or + **[join the support server!](../README.md#support-server)** ## Two-server setup In this setup, modmail threads are opened on a separate inbox server. @@ -41,6 +43,8 @@ You might also want this setup for privacy concerns*. 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)** +6. 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 modified client could see the names of all users contacting modmail through the modmail channel names.*