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

Add FAQ

master
Dragory 2019-12-05 20:53:38 +02:00
parent 528942594c
commit 56bc979863
3 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -11,6 +11,7 @@ Inspired by Reddit's modmail system.
* [📝 Configuration](docs/configuration.md) * [📝 Configuration](docs/configuration.md)
* [🤖 Commands](docs/commands.md) * [🤖 Commands](docs/commands.md)
* [🧩 Plugins](docs/plugins.md) * [🧩 Plugins](docs/plugins.md)
* [🙋 Frequently Asked Questions](docs/faq.md)
* [Release notes](CHANGELOG.md) * [Release notes](CHANGELOG.md)
## Support server ## Support server

21
docs/faq.md Normal file
View File

@ -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`

4
docs/setup.md
View File

@ -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 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)** 4. **[🏃 Start the bot!](starting-the-bot.md)**
5. Want to change other bot options? See **[📝 Configuration](configuration.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 ## Two-server setup
In this setup, modmail threads are opened on a separate inbox server. 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 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. **[🏃 Start the bot!](starting-the-bot.md)**
5. Want to change other bot options? See **[📝 Configuration](configuration.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 *\* 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.* modified client could see the names of all users contacting modmail through the modmail channel names.*