modmail-dev · StephenDaDev · May 7, 2023 · Apr 13, 2023 · Apr 13, 2023 · Apr 13, 2023
diff --git a/...tainerization-docker-explained-edureka-docker-explanation-hd-png-1221238558.png b/...tainerization-docker-explained-edureka-docker-explanation-hd-png-1221238558.png
diff --git a/.gitbook/assets/Screenshot 2023-04-13 224748.png b/.gitbook/assets/Screenshot 2023-04-13 224748.png
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -16,22 +16,24 @@
   * [Heroku](installation/heroku.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)
+* [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)
diff --git a/frequently-asked-questions (1).md b/frequently-asked-questions (1).md
@@ -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!
diff --git a/frequently-asked-questions.md b/frequently-asked-questions.md
@@ -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!
+###
diff --git a/installation/community-guides.md b/installation/community-guides.md
@@ -12,6 +12,6 @@ Community guides are not verified by the Modmail team, so use them at your own r
 
 An online code execution environment. You can host Modmail there for free using certain exploits. The legitimate method costs $7 USD per month. However, regardless if you pay or host for free, hosting on Replit are often unstable and thus not recommended. But for now, this is the only option for those without a payment method for hosting or verification.
 
-## [Northflank](https://blog.project-mei.xyz/2023/4/11/hosting-discord-modmail-with-northflank/) Guide by raidensakura
+## [Northflank](https://blog.project-mei.xyz/2023/04/11/hosting-discord-modmail-on-northflank/) Guide by raidensakura
 
 Northflank is a Platform as a Service (PaaS) like Railway that offers abilities to run micro-services like bots, schedule jobs that run periodically and databases with a powerful UI, API and CLI. Their panel is a bit more advanced as compared to Railway but comes with the perk of more customization and features. You will need a valid payment method to verify your account, but will unlock a free tier project that's separated from paid resources. They will not charge your card if you go over resource usage as you have limited allocation per service.
diff --git a/installation/local-hosting-vps/almalinux.md b/installation/local-hosting-vps/almalinux.md
@@ -4,14 +4,24 @@ description: Deploy Modmail on RHEL / Alma Linux / CentOS server.
 
 # Alma Linux
 
+{% hint style="warning" %}
+For safety reasons, **DO NOT** install Modmail with a root user. A misbehaving or malicious plugin installed on your Modmail bot can easily access your entire system. If you are unsure how to create a new user on Linux, see [DigitalOcean’s tutorial: How To Create a New Sudo-enabled User](https://www.digitalocean.com/community/tutorials/how-to-create-a-new-sudo-enabled-user-on-ubuntu-20-04-quickstart).
+{% endhint %}
+
 Alma Linux 8, 9 and CentOS Stream 8, 9 are based on Red Hat Enterprise Linux (RHEL) 8 and 9 respectively so you can essentially follow this guide if you're running any of the OS mentioned above.
 
 ## Prerequisites
 
-* Root access (**`sudo`**).
-* Minimum 1GB of RAM
-* At least 2GB available disk space.
-* Supported releases: Alma Linux 9, Alma Linux 8, CentOS Stream 9, CentOS Stream 8, RHEL 9 and RHEL 8
+1. Root access (**`sudo`**).
+2. Minimum 1GB of RAM
+3. At least 2GB available disk space.
+4. Supported releases:&#x20;
+   * Alma Linux 9
+   * Alma Linux 8
+   * CentOS Stream 9
+   * CentOS Stream 8
+   * Red Hat Enterprise Linux (RHEL) 9
+   * Red Hat Enterprise Linux (RHEL) 8
 
 ## Dependencies
 
@@ -24,14 +34,16 @@ All code blocks should be executed in bash and line by line unless specified oth
 
 ### RHEL 9 / Alma Linux 9 / CentOS Stream 9
 
-Alma Linux 9 have all required packages available in official repositories. Install them with `dnf`:
+RHEL 9 and its derivatives have all required packages available in official repositories. Install them with `dnf`:
 
 ```bash
 sudo dnf -y install python39 git @development nano
 ```
 
 ### RHEL 8 / Alma Linux 8 / CentOS Stream 8.4-8.x
 
+RHEL 8 and its derivatives have all required packages available in official repositories. Install them with `dnf`:
+
 ```bash
 sudo dnf -y update
 sudo dnf -y group install development
@@ -40,25 +52,24 @@ sudo dnf -y install python39 python39-pip python39-devel nano git
 
 ## Installing Bot
 
-In your home directory, clone and cd into the official Modmail repository with:
+Clone and change directory into the Modmail folder with:
 
 ```bash
-cd ~
 git clone https://github.com/modmail-dev/modmail
 cd modmail
 ```
 
 Inside the Modmail folder, ensure `pip` is installed correctly and is defaulting to Python 3.9 with:
 
 ```bash
-python3.9 -m ensurepip --default-pip
+python3.9 -m ensurepip --upgrade
 ```
 
 And then, install `pipenv` and the bot dependencies with:
 
 ```bash
-pip3.9 install pipenv
-pipenv install --python 3.9
+python3.9 -m pip install pipenv
+python3.9 -m pipenv install --python 3.9
 ```
 
 Create a file named `.env` with `nano` and paste all the environmental variables (secrets) needed to run the bot via right-clicking in the nano editor. Refer to the steps in the [parent Installation page](../#preparing-your-environmental-variables) to find where to obtain these.
@@ -78,19 +89,7 @@ If using the `nano` editor is a bit of a learning curve, you can always FTP into
 After your `.env` file is ready, you can now go ahead and try running your bot with:
 
 ```bash
-pipenv run bot
-```
-
-If no error shows up, it means your bot is now running correctly.
-
-## Updating
-
-Your Modmail is set to auto-update itself by default, but you can also run the `?update` command on your bot manually, replacing `?` with your bot prefix.
-
-If for some reason your update command isn't working correctly, you can update your bot by going into your modmail folder and pulling the latest changes from GitHub like so:
-
-```bash
-cd modmail && git pull
+python3.9 -m pipenv run bot
 ```
 
-Be sure to restart your bot to apply the uupdate.
+If no error shows up, it means your bot is now running correctly. You can stop the bot from running with `Ctrl+C` to continue using your terminal.
diff --git a/installation/local-hosting-vps/debian.md b/installation/local-hosting-vps/debian.md
@@ -4,14 +4,22 @@ description: Deploy Modmail on Debian / Raspberry Pi OS.
 
 # Debian
 
+{% hint style="warning" %}
+For safety reasons, **DO NOT** install Modmail with a root user. A misbehaving or malicious plugin installed on your Modmail bot can easily access your entire system. If you are unsure how to create a new user on Linux, see [DigitalOcean’s tutorial: How To Create a New Sudo-enabled User](https://www.digitalocean.com/community/tutorials/how-to-create-a-new-sudo-enabled-user-on-ubuntu-20-04-quickstart).
+{% endhint %}
+
 Raspberry Pi OS 11 Bullseye and Raspberry Pi OS 10 Buster are based on Debian 11 Bullseye and Debian 10 Buster respectively so you can essentially follow this guide if you're running any of the OS mentioned above.
 
 ## Prerequisites
 
-* Root access (**`sudo`**).
-* Minimum 1GB of RAM
-* At least 2GB available disk space.
-* Supported releases: Debian 11 Bullseye, Debian 10 Buster, Raspberry Pi OS 11 Bullseye, and Raspberry Pi OS 10 (Legacy) Buster
+1. Root access (**`sudo`**).
+2. Minimum 1GB of RAM
+3. At least 2GB available disk space.
+4. Supported releases:&#x20;
+   * Debian 11 Bullseye
+   * Debian 10 Buster
+   * Raspberry Pi OS 11 Bullseye
+   * Raspberry Pi OS 10 Buster
 
 ## Dependencies
 
@@ -36,8 +44,9 @@ At the time of writing, this will install Python 3.9 from Debian's repository.
 
 ### **Debian 10 Buster /** Raspberry Pi OS 10 Buster
 
-You will need to manually compile Python 3.10 from source. Compiling Python may take a while (est. 5-10 minutes).
+You will need to manually compile Python 3.10 from source. Compiling Python may take a while (est. 5-10 minutes). Make sure to run line 2-7 all at once.
 
+{% code lineNumbers="true" %}
 ```bash
 sudo apt update && sudo apt upgrade -y  # Update and upgrade all packages
 sudo apt install -y software-properties-common \
@@ -52,31 +61,36 @@ cd Python-3.10.9
 ./configure --enable-optimizations 
 sudo make altinstall
 ```
+{% endcode %}
 
-After following this step, make sure to specify the version when running user-level Python commands later in the guide.
+After that, ensure `pip` is installed and updated for Python 3.10 with:
 
-For example:
+```
+python3.10 -m ensurepip --upgrade
+```
 
-* `pip install pipenv` to `pip3.10 install pipenv`&#x20;
-* `python bot.py` to `python3.10 bot.py`
+Then **log out and log back in** to continue the installation steps.
 
 ## Installing Bot
 
-In your home directory, clone and cd into the official Modmail repository with:
+Clone and change directory into the Modmail folder with:
 
 ```bash
-cd ~
 git clone https://github.com/modmail-dev/modmail
 cd modmail
 ```
 
-Inside the Modmail folder, Install `pipenv` and the bot dependencies with:
+Inside the Modmail folder, Install `pipenv` and the bot dependencies with:&#x20;
 
 ```bash
-pip install pipenv
-pipenv install
+python3.9 -m pip install pipenv
+python3.9 -m pipenv install --python 3.9
 ```
 
+{% hint style="info" %}
+Replace <mark style="color:green;">`3.9`</mark> with <mark style="color:green;">`3.10`</mark> on the command above if you followed[ Debian 10 Buster](debian.md#debian-10-buster-raspberry-pi-os-10-buster) method previously.
+{% endhint %}
+
 Create a file named `.env` with `nano` and paste all the environmental variables (secrets) needed to run the bot via right-clicking in the nano editor. Refer to the steps in the [parent Installation page](../#preparing-your-environmental-variables) to find where to obtain these.
 
 ```bash
@@ -94,19 +108,11 @@ If using the `nano` editor is a bit of a learning curve, you can always FTP into
 After your `.env` file is ready, you can now go ahead and try running your bot with:
 
 ```bash
-pipenv run bot
+python3.9 -m pipenv run bot
 ```
 
-If no error shows up, it means your bot is now running correctly.
-
-## Updating
-
-Your Modmail is set to auto-update itself by default, but you can also run the `?update` command on your bot manually, replacing `?` with your bot prefix.
-
-If for some reason your update command isn't working correctly, you can update your bot by going into your modmail folder and pulling the latest changes from GitHub like so:
-
-```bash
-cd modmail && git pull
-```
+{% hint style="info" %}
+Replace <mark style="color:green;">`3.9`</mark> with <mark style="color:green;">`3.10`</mark> on the command above if you followed[ Debian 10 Buster](debian.md#debian-10-buster-raspberry-pi-os-10-buster) method previously.
+{% endhint %}
 
-Be sure to restart your bot to apply the update.
+If no error shows up, it means your bot is now running correctly. You can stop the bot from running with `Ctrl+C` to continue using your terminal.
diff --git a/installation/local-hosting-vps/docker.md b/installation/local-hosting-vps/docker.md
@@ -8,6 +8,8 @@ description: Deploy Modmail on Docker.
 Docker is considered an advanced setup, it is recommended that you understand how Docker works before deciding to use this method.
 {% endhint %}
 
+<figure><img src="../../.gitbook/assets/27-272811_containerization-docker-explained-edureka-docker-explanation-hd-png-1221238558.png" alt=""><figcaption><p>A simple illustration explaining how Docker works</p></figcaption></figure>
+
 ## Prerequisites
 
 * Supported OS for Docker
@@ -107,9 +109,9 @@ docker run -d --name modmail \
 --restart always myname/modmail:latest
 ```
 
-## Updating
+## Updating on Docker
 
-Auto-update is disabled when running Docker as Docker container state is not persistent across restarts. To update your bot, you will need to run the `docker pull` command in the previous step: [Running the official image for Modmail](docker.md#running-the-official-image-for-modmail) if your image is based from the official repository. After that, you must recreate your container using the `docker rm` and `docker run` command again.
+Auto-update is disabled when running Docker as Docker container state is not persistent across restarts. To update your bot, you will need to update the base image by running the `docker pull` command in the previous step: [Running the official image for Modmail](docker.md#running-the-official-image-for-modmail) if your image is based from the official repository. After that, you must recreate your container using the `docker rm` and `docker run` command again.
 
 If your image is created locally, simply replace the `docker pull` command with `git pull` and rebuilding your image again.