Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
8152017
GitBook: No commit message
Apr 7, 2023
6e1f692
Merge pull request #19 from modmail-dev/main
raidensakura Apr 7, 2023
12f447f
Merge branch 'modmail-dev:development' into development
raidensakura Apr 7, 2023
f554e3d
MMM Sus
raidensakura Apr 7, 2023
a4aa466
GITBOOK-1: No subject
Apr 7, 2023
485f4e2
GITBOOK-2: Specify to run all 3 lines at once
Apr 7, 2023
0132448
Update configuration.md
Zinoviya99 Apr 10, 2023
909121d
Merge pull request #21 from modmail-dev/Zinoviya99-patch-1
Zinoviya99 Apr 10, 2023
edf5e04
GITBOOK-13: Add Fedora guide
raidensakura Apr 10, 2023
4119d90
Update configuration.md
Zinoviya99 Apr 10, 2023
1708538
Merge pull request #22 from modmail-dev/Zinoviya99-patch-2
lorenzo132 Apr 10, 2023
46ea0a4
Update configuration.md
Zinoviya99 Apr 10, 2023
484202a
Update configuration.md
Zinoviya99 Apr 10, 2023
b5ba00b
Update configuration.md
Zinoviya99 Apr 10, 2023
74d9412
Update configuration.md
Zinoviya99 Apr 10, 2023
40b9343
Finished Config Page
Zinoviya99 Apr 10, 2023
fd95889
Merge branch 'development' into Zinoviya99-patch-4
sebkuip Apr 10, 2023
e1f50d3
Merge pull request #24 from modmail-dev/Zinoviya99-patch-4
Zinoviya99 Apr 10, 2023
6b8c884
Add base logviewer instructions
sebkuip Mar 30, 2023
61e2f05
Add a patreon logviewer hosting setup
sebkuip Mar 30, 2023
3097d6e
Added info on how to clone a private repo
sebkuip Mar 30, 2023
9d4aaa4
Added logviewer links to summary
sebkuip Mar 30, 2023
7373c16
Fix links
sebkuip Mar 30, 2023
eb865e2
Fix patreon underscore
sebkuip Mar 30, 2023
8699e67
Fix another underscore
sebkuip Mar 30, 2023
59c4e73
Apply stephen's suggestions
sebkuip Mar 31, 2023
f09e980
Change extra line in premium logviewer guide
sebkuip Mar 31, 2023
ad764f4
Fix for stephen's review
sebkuip Apr 10, 2023
9a94c4c
Fix small oversight
sebkuip Apr 10, 2023
d6f1b47
Fix some additional formatting
sebkuip Apr 10, 2023
f8ec24a
Merge branch 'development' into development
raidensakura Apr 11, 2023
72a89d5
GITBOOK-14: Add Alma Linux guide
raidensakura Apr 11, 2023
ca3b54f
GITBOOK-15: Minor tweaks and correction
raidensakura Apr 11, 2023
47dfdb7
GITBOOK-16: Update links
raidensakura Apr 11, 2023
b3b52bd
GITBOOK-17: Move auto-restart guide to its own page
raidensakura Apr 11, 2023
50277c1
GITBOOK-18: Add pm2 auto-restart
raidensakura Apr 11, 2023
471d33d
GITBOOK-19: Add community guide description
raidensakura Apr 11, 2023
cb82ac1
Merge pull request #20 from raidensakura/development
Zinoviya99 Apr 11, 2023
f542172
Self-hosting correction and enhancement (#26)
raidensakura May 7, 2023
dfcfefe
Small correction (#27)
raidensakura Jul 14, 2023
12335a3
Update windows.md (#29)
StephenDaDev Nov 1, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/Screenshot 2023-04-13 224748.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (10).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (11).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (3).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (4).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (5).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (6).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (7).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (8).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (9).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This bot is free for everyone and always will be. If you like this project and w

## What is Modmail used for?

When a member sends a direct message to Modmail, the bot will create a channel (we call it a "thread") into a designated category. All further DM messages will automatically relay to that channel, then any available staff can respond within the channel. Compared to ticketing bots, Modmail allows easier and more organised discussions among staff.  
When a member sends a direct message to Modmail, the bot will create a channel (we call it a "thread") into a designated category. All further DM messages will automatically relay to that channel, then any available staff can respond within the channel. Compared to ticketing bots, Modmail allows easier and more organised discussions among staff.

<figure><img src="https://i.imgur.com/fru5Q07.png" alt=""><figcaption><p>An example of a Modmail thread.</p></figcaption></figure>

Expand Down Expand Up @@ -52,11 +52,11 @@ Visit our [installation page](installation/) for detailed instructions on settin

## Supporting the project

You have various options to help the project. Giving this repository a star is greatly appreciated. You can also help people that have trouble setting up Modmail at our [Discord server](https://discord.gg/cnUpwrnpYb).&#x20;
You have various options to help the project. Giving this repository a star is greatly appreciated. You can also help people that have trouble setting up Modmail at our [Discord server](https://discord.gg/cnUpwrnpYb).

If you like to show your appreciation, consider supporting us on [**Patreon**](https://www.patreon.com/kyber)!

### Contributing
## Contributing

Support Modmail with your contributions! Whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out our [contributing guidelines](https://github.com/modmail-dev/modmail/blob/master/.github/CONTRIBUTING.md) before you get started.

Expand All @@ -65,5 +65,12 @@ Support Modmail with your contributions! Whether it be improvements to the docum
* Read about [installing Modmail](installation/).
* Become familiar with [Modmail commands and functionalities](getting-started.md).


{% hint style="info" %} In this guide when we refer to bot commands, we will assume the prefix to be `?` and will display them like in this example. `?help`. Optional arguments will be in [brackets], for example `?close [time] [reason] [silently].` Required arguments will be put in <andled brackets>, for example `?permissions add <command/level> <name> <user/role>` {% endhint %}
{% hint style="info" %}
Throughout this documentation when we're referring to bot commands, we will assume the prefix of the bot to be <mark style="color:green;">?</mark> and will display them like in this example: <mark style="color:green;">?help</mark>.\
\
Optional arguments will be enclosed in square brackets:\
Example: <mark style="color:green;">?close \[time] \[reason] \[silently]</mark>\
\
Required arguments will be enclosed in angle brackets:\
Example: <mark style="color:green;">?contact \<user></mark>
{% endhint %}
16 changes: 9 additions & 7 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,31 @@
* [Ubuntu](installation/local-hosting-vps/ubuntu.md)
* [Debian](installation/local-hosting-vps/debian.md)
* [Fedora](installation/local-hosting-vps/fedora.md)
* [AlmaLinux](installation/local-hosting-vps/almalinux.md)
* [CentOS](installation/local-hosting-vps/centos.md)
* [Raspberry Pi](installation/local-hosting-vps/raspberry-pi.md)
* [Alma Linux](installation/local-hosting-vps/almalinux.md)
* [Logviewer](installation/local-hosting-vps/logviewer.md)
* [Patreon logviewer](installation/local-hosting-vps/patreon\_logviewer.md)
* [Railway](installation/railway.md)
* [Heroku](installation/heroku.md)
* [Replit](installation/replit.md)
* [Community Guides](installation/community-guides.md)
* [Setting up auto-restart](setting-up-auto-restart.md)
* [Updating](updating.md)
* [Getting Started](getting-started.md)
* [Usage](usage-guide/README.md)
* [Plugins](usage-guide/plugins.md)
* [Configuration](usage-guide/configuration.md)
* [Permissions](usage-guide/permissions.md)
* [Getting Started](getting-started.md)
* [Frequently Asked Questions](frequently-asked-questions.md)
* [OLD DOCS](old-docs/README.md)
* [Installation](installation-1.md)
* [Installation (continued)](installation-continued.md)
* [Color Names](color-names.md)
* [Configuration Variables (Config Vars)](configuration-variables-config-vars.md)
* [Configure Modmail and Logviewer](configure-modmail-and-logviewer.md)
* [Frequently Asked Questions](frequently-asked-questions.md)
* [Frequently Asked Questions](<frequently-asked-questions (1).md>)
* [Modmail Usage](modmail-usage.md)
* [Permissions](permissions.md)
* [Plugins](plugins.md)
* [Seperate Server Setup](seperate-server-setup.md)
* [The Unofficial List of Plugins](the-unofficial-list-of-plugins.md)
* [Updating](updating.md)
* [Updating](<updating (1).md>)
* [Video Tutorials](video-tutorials.md)
53 changes: 53 additions & 0 deletions frequently-asked-questions (1).md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Frequently Asked Questions

> Last Updated: March 16, 2023

#### What is Modmail?

Modmail is a Discord bot, similar to Reddit's Modmail feature. It serves as a shared inbox for server staff to communicate with their users - and vice versa - in a seamless way.

#### Can I invite Modmail?

Unfortunately, due to the nature of the bot, there is not a global invite link. Nonetheless, you can obtain a free copy of Modmail for your server. Follow the official tutorial at [https://github.com/modmail-dev/modmail/wiki/Installation](https://github.com/modmail-dev/modmail/wiki/Installation). However, if you don’t want the hassle of installing and maintaining Modmail, we offer installation, hosting, and other cool perks for [Patrons](https://patreon.com/kyber).

#### How does Modmail work?

Modmail uses the Discord API to interact with the platform. When someone sends a DM to the bot, it will create a new thread. Members of the moderation team can help the user and once the conversation ended, you will have access to a beautiful log of it online.

#### Is Modmail safe?

Your Modmail bot is safe as long as you don't share your bot's token. If you share your token, a "hacker" can take control over your bot. If you shared your bot token by mistake, regenerate a new token via the Discord Developer Portal.

#### Where is my data stored?

All your data including settings, blocked users, logs, installed plugins etc. are stored in your MongoDB database. The bot files only contain the stuff needed to run the bot. This means you can move your bot to a different host and still have your data intact, as long as you use the same MongoDB URI.

#### Can I request new features?

Modmail is an open-source project, which means you can easily add or request new features. You can make an issue or submit a pull request to the development branch on the repository. [Check out the contribution guidelines.](https://github.com/modmail-dev/modmail/blob/master/CONTRIBUTING.md)

#### How do I become a support member?

To join our support team, join our [Discord server](https://discord.gg/cnUpwrnpYb). One of the more experienced members will hold an interview to check if you fit the requirements.

#### Can I add commands to the bot?

You can add commands to the bot using plugins. All currently approved plugins can be found in the `?plugin registry` command. You can also see [this page](https://github.com/modmail-dev/modmail/wiki/Unofficial-List-of-Plugins) for an unofficial list of plugins.

#### My bot is offline, what do I do?

Join our [Discord server](https://discord.gg/cnUpwrnpYb) and DM Modmail. One of our support members will assist you and help you fix the issue.

#### How can I donate the developers?

You can support the developers on the [Patreon page](https://patreon.com/kyber). You will also receive various rewards for it.

#### Does anyone get any info when I create my own modmail?

There is not much information we get about your instance of modmail, The only thing what we recieve is the guild-info, For example: The guildname, The amount of members of the guild, the botname, and the bot-owner. Using this we keep track of how many modmail-instances get created on a monthly/yearly base. ( Only modmail-developers can see this )

***

#### Answer not found?

Feel free to join our [Discord server](https://discord.gg/cnUpwrnpYb). People will gladly help you with any questions that you have!
62 changes: 18 additions & 44 deletions frequently-asked-questions.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,27 @@
# Frequently Asked Questions

> Last Updated: March 16, 2023

#### What is Modmail?

Modmail is a Discord bot, similar to Reddit's Modmail feature. It serves as a shared inbox for server staff to communicate with their users - and vice versa - in a seamless way.

#### Can I invite Modmail?

Unfortunately, due to the nature of the bot, there is not a global invite link. Nonetheless, you can obtain a free copy of Modmail for your server. Follow the official tutorial at [https://github.com/modmail-dev/modmail/wiki/Installation](https://github.com/modmail-dev/modmail/wiki/Installation). However, if you don’t want the hassle of installing and maintaining Modmail, we offer installation, hosting, and other cool perks for [Patrons](https://patreon.com/kyber).

#### How does Modmail work?

Modmail uses the Discord API to interact with the platform. When someone sends a DM to the bot, it will create a new thread. Members of the moderation team can help the user and once the conversation ended, you will have access to a beautiful log of it online.

#### Is Modmail safe?

Your Modmail bot is safe as long as you don't share your bot's token. If you share your token, a "hacker" can take control over your bot. If you shared your bot token by mistake, regenerate a new token via the Discord Developer Portal.
---
description: A list of commonly asked questions or problems related to Modmail.
---

#### Where is my data stored?

All your data including settings, blocked users, logs, installed plugins etc. are stored in your MongoDB database. The bot files only contain the stuff needed to run the bot. This means you can move your bot to a different host and still have your data intact, as long as you use the same MongoDB URI.

#### Can I request new features?

Modmail is an open-source project, which means you can easily add or request new features. You can make an issue or submit a pull request to the development branch on the repository. [Check out the contribution guidelines.](https://github.com/modmail-dev/modmail/blob/master/CONTRIBUTING.md)

#### How do I become a support member?

To join our support team, join our [Discord server](https://discord.gg/cnUpwrnpYb). One of the more experienced members will hold an interview to check if you fit the requirements.

#### Can I add commands to the bot?

You can add commands to the bot using plugins. All currently approved plugins can be found in the `?plugin registry` command. You can also see [this page](https://github.com/modmail-dev/modmail/wiki/Unofficial-List-of-Plugins) for an unofficial list of plugins.

#### My bot is offline, what do I do?
# Frequently Asked Questions

Join our [Discord server](https://discord.gg/cnUpwrnpYb) and DM Modmail. One of our support members will assist you and help you fix the issue.
### I tried installing the dependencies with another Python version and it messed up my Pipfile! How can I get the original Pipfile back?

#### How can I donate the developers?
First remove the broken `Pipfile` and `Pipfile.lock` with:

You can support the developers on the [Patreon page](https://patreon.com/kyber). You will also receive various rewards for it.
```bash
rm Pipfile && rm Pipfile.lock
```

#### Does anyone get any info when I create my own modmail?
Fetch in the changes from the remote repository:

There is not much information we get about your instance of modmail, The only thing what we recieve is the guild-info, For example: The guildname, The amount of members of the guild, the botname, and the bot-owner. Using this we keep track of how many modmail-instances get created on a monthly/yearly base. ( Only modmail-developers can see this )
```bash
git fetch origin
```

***
And then, fetch the original files with:

#### Answer not found?
```bash
git checkout FETCH_HEAD -- Pipfile && git checkout FETCH_HEAD -- Pipfile.lock
```

Feel free to join our [Discord server](https://discord.gg/cnUpwrnpYb). People will gladly help you with any questions that you have!
###
Loading