modmail-dev · lorenzo132 · Mar 22, 2023 · Mar 16, 2023 · Mar 16, 2023 · Mar 18, 2023
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 ---
-description: https://github.com/kyb3r/modmail
+description: https://github.com/modmail-dev/modmail
 ---
 
 # Introduction
@@ -52,15 +52,18 @@ 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/etJNHCQ).&#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).&#x20;
 
 If you like to show your appreciation, consider supporting us on [**Patreon**](https://www.patreon.com/kyber)!
 
 ### 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/kyb3r/modmail/blob/master/.github/CONTRIBUTING.md) before you get started.
+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.
 
 ## Next steps
 
 * 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 %}
diff --git a/configuration-variables-config-vars.md b/configuration-variables-config-vars.md
@@ -35,4 +35,4 @@ These are currently all the valid configuration variables you can change with th
 | twitch\_url                                         | The twitch URL when activity\_type is set to 1 (streaming).                                                                                                                                                                                                                                                                                                      |
 | user\_typing                                        | Shows when user starts typing to bot. (default is off)                                                                                                                                                                                                                                                                                                           |
 
-Accepted color names can be found here: https://github.com/kyb3r/modmail/wiki/Color-Names.
+Accepted color names can be found here: {% page-ref page="color-names.md" %}.
diff --git a/configure-modmail-and-logviewer.md b/configure-modmail-and-logviewer.md
@@ -32,15 +32,15 @@ If your URI is followed by `test?retryWrites=true` or anything else, don't inclu
 
 ## Deploying the Log Viewer
 
-[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/kyb3r/logviewer)
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/modmail-dev/logviewer)
 
 You will also need to deploy another separate log viewer application from [this repo](https://github.com/kyb3r/logviewer). Click on the deploy button over there and fill in the configurations upon request. This is a **separate** Heroku application from the bot and is a simple website that will be used to display your thread logs.
 
 ## Modmail
 
 Star the repository before you start 😉
 
-[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/kyb3r/modmail)
+[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/modmail-dev/modmail)
 
 1. Input a name of your choice for your app, the Heroku app name is not important.
 2. Input your bot token into the `TOKEN` field.
@@ -54,6 +54,6 @@ Star the repository before you start 😉
 10. If you want, you can go over and check the application logs to see if everything is running smoothly.
 11. Once the bot is online in your server, do `[your prefix]setup` (defaults `?`) and you are good to go!
 
-Your bot is ready! Head over to Discord and try it out! If you have any issues, join the [Discord server](https://discord.gg/etJNHCQ).
+Your bot is ready! Head over to Discord and try it out! If you have any issues, join the [Discord server](https://discord.gg/cnUpwrnpYb).
 
 **Make sure to give the bot Manage Channels, Manage Messages and View Audit Logs permissions!**
diff --git a/frequently-asked-questions.md b/frequently-asked-questions.md
@@ -1,14 +1,14 @@
 # Frequently Asked Questions
 
-> Last Updated: October 12th, 2020
+> 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/kyb3r/modmail/wiki/Installation](https://github.com/kyb3r/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).
+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?
 
@@ -24,30 +24,30 @@ All your data including settings, blocked users, logs, installed plugins etc. ar
 
 #### 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/kyb3r/modmail/blob/master/CONTRIBUTING.md)
+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/etJNHCQ). One of the more experienced members will hold an interview to check if you fit the requirements.
+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/kyb3r/modmail/wiki/Unofficial-List-of-Plugins) for an unofficial list of plugins.
+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/etJNHCQ) and DM Modmail. One of our support members will assist you and help you fix the issue.
+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?
+#### 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/etJNHCQ). People will gladly help you with any questions that you have!
+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-1.md b/installation-1.md
@@ -1,6 +1,6 @@
 # Installation
 
-**If you need help beyond this tutorial please join our support server and the support team will be happy to help you** [https://discord.gg/etJNHCQ](https://discord.gg/etJNHCQ)
+**If you need help beyond this tutorial please join our support server and the support team will be happy to help you** [https://discord.gg/cnUpwrnpYb](https://discord.gg/cnUpwrnpYb)
 
 > **Self Hosting Tutorial**: https://taaku18.github.io/modmail/local-hosting/
 
@@ -56,4 +56,4 @@ Before you press "copy", scroll down and select the following permissions:
 
 ## ![Discord Invite](https://i.imgur.com/iAQ2u0w.png)
 
-[**To continue the setup, head over to the second page of this guide.**](https://github.com/kyb3r/modmail/wiki/Installation-\(cont.\))
+[**To continue the setup, head over to the second page of this guide.**](https://github.com/modmail-dev/modmail/wiki/Installation-\(cont.\))
diff --git a/installation-continued.md b/installation-continued.md
@@ -64,11 +64,11 @@ If those steps are done correctly you can use the `?update` command to update yo
 
 ### **Click the button below to deploy the logviewer to heroku!**
 
-[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/kyb3r/logviewer)
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/modmail-dev/logviewer)
 
 **This is not the bot!**
 
-You will need to deploy a separate log viewer application from [this repository](https://github.com/kyb3r/logviewer). This Heroku application is separate from the bot; it's a simple website that will be used to display your thread logs.
+You will need to deploy a separate log viewer application from [this repository](https://github.com/modmail-dev/logviewer). This Heroku application is separate from the bot; it's a simple website that will be used to display your thread logs.
 
 Choose a name for your app and paste your Mongo URI (from your notepad). After you click the `Deploy App` button, it will start creating the website.
 
@@ -82,11 +82,11 @@ After that's done configuring, click the `View` button. It will redirect you to
 
 **This is the second application you will be deploying**
 
-[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/kyb3r/modmail)
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/modmail-dev/modmail)
 
 **6.1.** Choose any name for your app. Note: this name doesn't matter at all.
 
-**6.2.** Put your [bot's token](https://github.com/kyb3r/modmail/wiki/Installation#creating-a-bot-account) in the `TOKEN` field.
+**6.2.** Put your [bot's token](https://github.com/kyb3rr/modmail/wiki/Installation#creating-a-bot-account) in the `TOKEN` field.
 
 **6.3.** In the `DATABASE_TYPE` You may fillout: `mongodb`
 
@@ -104,17 +104,17 @@ After that's done configuring, click the `View` button. It will redirect you to
 
 **6.10.** Click `Manage App` and go into the `Resources` tab, where you need to turn on the worker by clicking the pencil icon next to it.
 
-**6.11.** If you want, you can go over and check the application logs to see if everything is running smoothly. If any unexpected errors pop up, join our [Discord server](https://discord.gg/etJNHCQ) and DM Modmail. The support members will help you figure out the issue and show you how to fix it.
+**6.11.** If you want, you can go over and check the application logs to see if everything is running smoothly. If any unexpected errors pop up, join our [Discord server](https://discord.gg/cnUpwrnpYb) and DM Modmail. The support members will help you figure out the issue and show you how to fix it.
 
 **6.12.** Once the bot is online in your server, make sure to give it `Manage Channels`, `Manage Messages` and `View Audit Logs` permissions. If your bot is not online, recheck the previous steps above.
 
 **6.13.** Do the `?setup` command and you are good to go!
 
 ***
 
-Congratulations! Your bot is ready! Head over to Discord and try it out! If you have any issues or questions, join the [Discord server](https://discord.gg/etJNHCQ).
+Congratulations! Your bot is ready! Head over to Discord and try it out! If you have any issues or questions, join the [Discord server](https://discord.gg/cnUpwrnpYb).
 
-Make sure to setup permissions using this [handy guide](https://github.com/kyb3r/modmail/wiki/Permissions)!
+Make sure to setup permissions using this [handy guide](https://github.com/modmail-dev/modmail/wiki/Permissions)!
 
 [Taki's Blog](https://taaku18.github.io/modmail/customization/) contains many cool customizations for the bot, so you might want to check it out!
 

diff --git a/installation/community-guides.md b/installation/community-guides.md
@@ -8,4 +8,4 @@ description: Unofficial installation guides created by the community.
 Community guides are not verified by the Modmail team, so use them at your own risks.
 {% endhint %}
 
-ToDO
+TODO
diff --git a/installation/heroku.md b/installation/heroku.md
@@ -27,11 +27,11 @@ You will need to fork our repositories to deploy onto Heroku.
 
 Make sure you're logged in to [GitHub](https://github.com/). You will need to fork **two** repositories.&#x20;
 
-First we fork the Modmail repository. Head over to [https://github.com/kyb3r/modmail/fork](https://github.com/kyb3r/modmail/fork), leave all the settings as default, and click **Create fork**.
+First we fork the Modmail repository. Head over to [https://github.com/kyb3rr/modmail/fork](https://github.com/modmail-dev/modmail/fork), leave all the settings as default, and click **Create fork**.
 
 <figure><img src="../.gitbook/assets/RW1.png" alt="Screenshot of creating a Modmail fork."><figcaption><p>Create a GitHub fork for the Modmail Repository.</p></figcaption></figure>
 
-Next do the same for the Logviewer repository by heading over to [https://github.com/kyb3r/logviewer/fork](https://github.com/kyb3r/logviewer/fork), leave all the settings as default, and click **Create fork**.
+Next do the same for the Logviewer repository by heading over to [https://github.com/kyb3r/logviewer/fork](https://github.com/modmail-dev/logviewer/fork), leave all the settings as default, and click **Create fork**.
 
 <figure><img src="../.gitbook/assets/RW2.png" alt="Screenshot of creating a Logviewer fork."><figcaption><p>Create a GitHub fork for the Logviewer Repository.</p></figcaption></figure>
 

diff --git a/installation/local-hosting-vps/README.md b/installation/local-hosting-vps/README.md
@@ -13,7 +13,7 @@ description: Hosting on the cloud or on your own computer.
 
 ## Choose your Operating System
 
-* [Windows](./ubuntu.md)
+* [Windows](./windows.md)
 * [MacOS](./macos.md)
 * [Docker](./docker.md)
 * [Ubuntu](./ubuntu.md)

diff --git a/installation/local-hosting-vps/ubuntu.md b/installation/local-hosting-vps/ubuntu.md
@@ -1,11 +1,70 @@
 ---
-description: Deploy Modmail on a Ubuntu server.
+description: Deploy Modmail on an Ubuntu server.
 ---
 
 # Ubuntu
 
-TODO
-
 ## Prerequisites
 
+* Root access (**`sudo`**).
+* Minimum 1GB of RAM, 2GB recommended.
+* 2GB available disk space.
+* Supported releases: Ubuntu 18.04 LTS, Ubuntu 20.04 LTS, Ubuntu 22.04 LTS.
+
+## Dependencies
+
+We will be using the following dependencies:
+
+* Python 3.10
+* NGINX web server
+* Tools: `git`, `wget`, `software-properties-common`
+* Additional Modmail requirements: `libcairo2-dev`, `libffi-dev`, `g++`
+
+To install these dependencies, we will be using the **`apt`**.
+
+{% hint style="info" %}
+All code blocks should be executed in bash unless specified otherwise.
+{% endhint %}
+
+{% code title="bash" %}
+```bash
+sudo apt update && sudo apt upgrade -y  # Update and upgrade all packages
+sudo apt install -y software-properties-common
+sudo add-apt-repository ppa:deadsnakes/ppa  # Official Python PPA
+sudo apt update
+sudo apt install -y python3.10 python3.10-dev python3.10-venv \
+                    libcairo2-dev libffi-dev g++ \
+                    git wget nginx
+```
+{% endcode %}
+
+<details>
+
+<summary>Failed to install Python 3.10?</summary>
+
+You can manually compile Python instead of adding using the Deadsnakes PPA. Compiling Python may take a while (est. 5-10 minutes).
+
+{% code title="bash" %}
+```bash
+sudo apt update && sudo apt upgrade -y  # Update and upgrade all packages
+sudo apt install -y software-properties-common \
+                    libcairo2-dev libffi-dev g++ \
+                    git wget nginx \
+                    build-essential zlib1g-dev libncurses5-dev \
+                    libgdbm-dev libnss3-dev libssl-dev \
+                    libreadline-dev libffi-dev libsqlite3-dev libbz2-dev
+wget https://www.python.org/ftp/python/3.10.9/Python-3.10.9.tgz
+tar xzf Python-3.10.9.tgz
+cd Python-3.10.9
+./configure --enable-optimizations 
+make altinstall
+```
+{% endcode %}
+
+</details>
+
+
+
+
+
 ## Updating
diff --git a/installation/railway.md b/installation/railway.md
@@ -29,11 +29,11 @@ You will need to fork our repositories to deploy onto Railway.
 
 Make sure you're logged in to [GitHub](https://github.com/). You will need to fork **two** repositories.&#x20;
 
-First we fork the Modmail repository. Head over to [https://github.com/kyb3r/modmail/fork](https://github.com/kyb3r/modmail/fork), leave all the settings as default, and click **Create fork**.
+First we fork the Modmail repository. Head over to [https://github.com/modmail-dev/modmail/fork](https://github.com/modmail-dev/modmail/fork), leave all the settings as default, and click **Create fork**.
 
 <figure><img src="../.gitbook/assets/RW1.png" alt="Screenshot of creating a Modmail fork."><figcaption><p>Create a GitHub fork for the Modmail Repository.</p></figcaption></figure>
 
-Next do the same for the Logviewer repository by heading over to [https://github.com/kyb3r/logviewer/fork](https://github.com/kyb3r/logviewer/fork), leave all the settings as default, and click **Create fork**.
+Next do the same for the Logviewer repository by heading over to [https://github.com/modmail-dev/logviewer/fork](https://github.com/modmail-dev/logviewer/fork), leave all the settings as default, and click **Create fork**.
 
 <figure><img src="../.gitbook/assets/RW2.png" alt="Screenshot of creating a Logviewer fork."><figcaption><p>Create a GitHub fork for the Logviewer Repository.</p></figcaption></figure>
 
@@ -280,7 +280,7 @@ You can disable auto-updates by heading to the settings page for **both** your M
 
 Now that you've successfully set up Modmail, visit the [Getting Started](../getting-started.md) page to find information on using Modmail.
 
-You can also join our [**Discord Server**](https://discord.gg/etJNHCQ) to interact with our community or get support for Modmail.
+You can also join our [**Discord Server**](https://discord.gg/cnUpwrnpYb) to interact with our community or get support for Modmail.
 
 
 
diff --git a/permissions.md b/permissions.md
@@ -38,4 +38,4 @@ Examples:
 
 ***
 
-If you need help setting up permissions, feel free to join our [Discord server](https://discord.gg/etJNHCQ) and DM Modmail. One of our support members will help you.
+If you need help setting up permissions, feel free to join our [Discord server](https://discord.gg/cnUpwrnpYb) and DM Modmail. One of our support members will help you.
-Original file line number
+Diff line change
@@ Expand Up @@
     Community guides are not verified by the Modmail team, so use them at your own risks.
     {% endhint %}
-    ToDO
+    TODO
Original file line number	Diff line number	Diff line change
Expand Up		@@ -38,4 +38,4 @@ Examples:

		***

		If you need help setting up permissions, feel free to join our [Discord server](https://discord.gg/etJNHCQ) and DM Modmail. One of our support members will help you.
		If you need help setting up permissions, feel free to join our [Discord server](https://discord.gg/cnUpwrnpYb) and DM Modmail. One of our support members will help you.