From 63b9eb32b6c6639138f674a82e04254725fc3048 Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Mon, 6 Feb 2023 13:20:18 -0500 Subject: [PATCH 01/20] Update cmd structure --- usage-guide/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/usage-guide/README.md b/usage-guide/README.md index b549e73..5c5d92c 100644 --- a/usage-guide/README.md +++ b/usage-guide/README.md @@ -5,27 +5,27 @@ description: How to use modmail # How to use modmail After initial setup is done, you can use modmail by using the in text commands. These use the prefix you set with the `prefix` command. The default prefix is `?`. -Users can DM the bot to start a thread. Any users or roles set with the `permissions` command can then see the thread in the server and reply to it. +Users can DM the bot to start a thread. Any users or roles set with the `?permissions` command can then see the thread in the server and reply to it. ## Replying -To reply to a thread, use the `reply` command inside the thread you wish to reply in. This will send a message to the thread. Image attachments and stickers are supported and will also be sent to the user. -Without command, any message sent in the thread will be seen as an internal message. This will not be visible to the user, but will still be logged to be viewed later in logviewer. If rather you want to send a message to the user without command, set the config variable `reply_without_command` to `true` using the `config` command. +To reply to a thread, use the `?reply` command inside the thread you wish to reply in. This will send a message to the thread. Image attachments and stickers are supported and will also be sent to the user. +Without command, any message sent in the thread will be seen as an internal message. This will not be visible to the user, but will still be logged to be viewed later in logviewer. If rather you want to send a message to the user without command, set the config variable `reply_without_command` to `true` using the `?config` command ## Closing When communications with a user have come to a conclusion, the thread can be closed in a multitude of ways. -The recommended way is using the `close` command. By default, this will close the thread on invoking the command. A message will be sent to the user containing the value of the `thread_close_response` config variable. This can be changed using the `config` command. A one time override can be given by adding text to the `close` command. E.g. `?close Thanks for contacting us!` will send the message `Thanks for contacting us!` to the user instead of the default message. +The recommended way is using the `?close` command. By default, this will close the thread on invoking the command. A message will be sent to the user containing the value of the `thread_close_response` config variable. This can be changed using the `?config` command. A one time override can be given by adding text to the `close` command. E.g. `?close Thanks for contacting us!` will send the message `Thanks for contacting us!` to the user instead of the default message. A time can also be provided to the close command. This will result in the close being scheduled and will automatically close the thread after the given time has expired. Multiple formats for time are accepted, like `2m30s` or `5 hours`. A response message can also be added to a timed close. When either a staff member, or the user themselves, replies to the thread after the close has been scheduled, the close will be cancelled. ## Help command -To assist with command usage, every command has a description. This description can be retrieved by using the `help` command followed by the name of the command. E.g. `?help close` will show the description of the `close` command. Most command descriptions also contain examples of how to use the command. The `help` command can also be used without a command name to show a list of all commands. +To assist with command usage, every command has a description. This description can be retrieved by using the `?help` command followed by the name of the command. E.g. `?help close` will show the description of the `?close` command. Most command descriptions also contain examples of how to use the command. The `?help` command can also be used without a command name to show a list of all commands. ## Snippets -The modmail bot has a snippet system to make frequent responses easier. Snippets can be created using the `snippet` command. This will create a snippet with the given name and content. The snippet can then be used by using the snippet name as a command. E.g. `?snippetname` will send the content of the snippet named `snippetname` to the thread. Using the `snippets` command will list all currently defined snippets. Using `snippet (snippet name)` will show the content of the snippet without sending it to the thread. +The modmail bot has a snippet system to make frequent responses easier. Snippets can be created using the `?snippet` command. This will create a snippet with the given name and content. The snippet can then be used by using the snippet name as a command. E.g. `?snippetname` will send the content of the snippet named `?snippetname` to the thread. Using the `?snippets` command will list all currently defined snippets. Using `?snippet (snippet name)` will show the content of the snippet without sending it to the thread. ## Logging -All messages sent in a thread, including internal notes, are logged to the bot's database. When a thread is closed, a message will be sent by the bot in the logs channel containing a link to the log. This link can be used to view the log in the logviewer. In a thread, the `loglink` command can be used to retrieve the loglink before it is closed. This allows the user to view the log before it appears in the logs channel if required. Logviewer is read only, and cannot be used to edit or delete messages. \ No newline at end of file +All messages sent in a thread, including internal notes, are logged to the bot's database. When a thread is closed, a message will be sent by the bot in the logs channel containing a link to the log. This link can be used to view the log in the logviewer. In a thread, the `loglink` command can be used to retrieve the loglink before it is closed. This allows the user to view the log before it appears in the logs channel if required. Logviewer is read only, and cannot be used to edit or delete messages. From 3a7e857786b2d44b4095ce82c2edcbbbe5dfbca2 Mon Sep 17 00:00:00 2001 From: Taku <45324516+Taaku18@users.noreply.github.com> Date: Mon, 6 Feb 2023 18:31:40 +0000 Subject: [PATCH 02/20] Fixed TODO, create development branch --- installation/community-guides.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/installation/community-guides.md b/installation/community-guides.md index cdaf7cd..6dd8c81 100644 --- 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 From 4b761617d1708717745426ff442886965c894829 Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Mon, 6 Feb 2023 18:01:11 -0500 Subject: [PATCH 03/20] Update README.md (#6) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 99852e3..5fd38cb 100644 --- a/README.md +++ b/README.md @@ -64,3 +64,5 @@ 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 , for example ``?permissions add ` {% endhint %} From 8ccd90ab840226f0e13ca2e9389d41109cc94dae Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Mon, 6 Feb 2023 18:52:49 -0500 Subject: [PATCH 04/20] Stephendadev patch1 (#7) * Update README.md * fix poor formatting --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5fd38cb..7c19ad0 100644 --- a/README.md +++ b/README.md @@ -65,4 +65,5 @@ 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 , for example ``?permissions add ` {% endhint %} + +{% 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 , for example `?permissions add ` {% endhint %} From cc203216240f906cda377889217d7a781794a6c8 Mon Sep 17 00:00:00 2001 From: Taku Date: Tue, 7 Feb 2023 07:00:58 +0000 Subject: [PATCH 05/20] GitBook: [#1] Start the Ubuntu guide --- installation/local-hosting-vps/ubuntu.md | 65 ++++++++++++++++++++++-- 1 file changed, 62 insertions(+), 3 deletions(-) diff --git a/installation/local-hosting-vps/ubuntu.md b/installation/local-hosting-vps/ubuntu.md index e2e9229..72606a6 100644 --- 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 %} + +
+ +Failed to install Python 3.10? + +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 %} + +
+ + + + + ## Updating From 8d947eaabae333a50ba21e6629007d403f9c8ce6 Mon Sep 17 00:00:00 2001 From: sebkuip Date: Sat, 25 Feb 2023 23:23:23 +0100 Subject: [PATCH 06/20] Updated repo links --- README.md | 4 ++-- configuration-variables-config-vars.md | 2 +- configure-modmail-and-logviewer.md | 2 +- frequently-asked-questions.md | 6 +++--- installation-1.md | 2 +- installation-continued.md | 6 +++--- installation/heroku.md | 2 +- installation/railway.md | 2 +- plugins.md | 8 ++++---- updating.md | 8 ++++---- 10 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 7c19ad0..ccd2d75 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ --- -description: https://github.com/kyb3r/modmail +description: https://github.com/kyb3rr/modmail --- # Introduction @@ -58,7 +58,7 @@ If you like to show your appreciation, consider supporting us on [**Patreon**](h ### 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/kyb3rr/modmail/blob/master/.github/CONTRIBUTING.md) before you get started. ## Next steps diff --git a/configuration-variables-config-vars.md b/configuration-variables-config-vars.md index b295240..105caf7 100644 --- 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: https://github.com/kyb3rr/modmail/wiki/Color-Names. diff --git a/configure-modmail-and-logviewer.md b/configure-modmail-and-logviewer.md index 71a7684..218e55a 100644 --- a/configure-modmail-and-logviewer.md +++ b/configure-modmail-and-logviewer.md @@ -40,7 +40,7 @@ You will also need to deploy another separate log viewer application from [this 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/kyb3rr/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. diff --git a/frequently-asked-questions.md b/frequently-asked-questions.md index f777437..ad87f2a 100644 --- a/frequently-asked-questions.md +++ b/frequently-asked-questions.md @@ -8,7 +8,7 @@ Modmail is a Discord bot, similar to Reddit's Modmail feature. It serves as a sh #### 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/kyb3rr/modmail/wiki/Installation](https://github.com/kyb3rr/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,7 +24,7 @@ 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/kyb3rr/modmail/blob/master/CONTRIBUTING.md) #### How do I become a support member? @@ -32,7 +32,7 @@ To join our support team, join our [Discord server](https://discord.gg/etJNHCQ). #### 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/kyb3rr/modmail/wiki/Unofficial-List-of-Plugins) for an unofficial list of plugins. #### My bot is offline, what do I do? diff --git a/installation-1.md b/installation-1.md index e9c5206..5d2afae 100644 --- a/installation-1.md +++ b/installation-1.md @@ -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/kyb3rr/modmail/wiki/Installation-\(cont.\)) diff --git a/installation-continued.md b/installation-continued.md index 4c9d084..ec87f6f 100644 --- a/installation-continued.md +++ b/installation-continued.md @@ -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/kyb3rr/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` @@ -114,7 +114,7 @@ After that's done configuring, click the `View` button. It will redirect you to 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). -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/kyb3rr/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/heroku.md b/installation/heroku.md index 3a090c8..538a359 100644 --- a/installation/heroku.md +++ b/installation/heroku.md @@ -27,7 +27,7 @@ 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. -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/kyb3rr/modmail/fork), leave all the settings as default, and click **Create fork**.
Screenshot of creating a Modmail fork.

Create a GitHub fork for the Modmail Repository.

diff --git a/installation/railway.md b/installation/railway.md index 21931bc..b8c0740 100644 --- a/installation/railway.md +++ b/installation/railway.md @@ -29,7 +29,7 @@ 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. -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/kyb3rr/modmail/fork), leave all the settings as default, and click **Create fork**.
Screenshot of creating a Modmail fork.

Create a GitHub fork for the Modmail Repository.

diff --git a/plugins.md b/plugins.md index 461144b..30af776 100644 --- a/plugins.md +++ b/plugins.md @@ -2,7 +2,7 @@ ## Plugins -Visit the [Unofficial List of Plugins](https://github.com/kyb3r/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins. +Visit the [Unofficial List of Plugins](https://github.com/kyb3rr/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins. ## Guidelines @@ -10,7 +10,7 @@ To get approved and officially verified, you need to ensure you follow these gui * Supporting Python 3.8 (and above). * No malicious intent. -* The plugin cannot be a feature pending to be added into [Modmail](https://github.com/kyb3r/modmail/issues). You can submit a PR to add it to the core Modmail. +* The plugin cannot be a feature pending to be added into [Modmail](https://github.com/kyb3rr/modmail/issues). You can submit a PR to add it to the core Modmail. * Core Modmail still needs to 100% function. * Cog name cannot be the same as any current class (`Core`, `Modmail`). * It cannot have the same name as another approved plugin. @@ -68,7 +68,7 @@ To install a plugin that is not in the official registry, type: ?plugin add githubusername/plugin_repo/plugin_name[@branch] ``` -An example of a plugin can be seen at [`fourjr/modmail-plugins`](https://github.com/fourjr/modmail-plugins) or any of the plugins in our [registry](https://github.com/kyb3r/modmail/blob/master/plugins/registry.json). +An example of a plugin can be seen at [`fourjr/modmail-plugins`](https://github.com/fourjr/modmail-plugins) or any of the plugins in our [registry](https://github.com/kyb3rr/modmail/blob/master/plugins/registry.json). #### Branch parameter @@ -144,4 +144,4 @@ async def on_thread_ready(self, thread, creator, category, initial_message): ### Approval request -Create a [Pull Request](https://github.com/kyb3r/modmail/pulls) adding your plugin into [`plugins/registry.json`](https://github.com/kyb3r/modmail/blob/master/plugins/registry.json) and we will take a look at it. +Create a [Pull Request](https://github.com/kyb3rr/modmail/pulls) adding your plugin into [`plugins/registry.json`](https://github.com/kyb3rr/modmail/blob/master/plugins/registry.json) and we will take a look at it. diff --git a/updating.md b/updating.md index 0449f7b..0fb63eb 100644 --- a/updating.md +++ b/updating.md @@ -6,7 +6,7 @@ You can update Modmail on your Heroku account whenever changes are made to the r ## Forking the repo -Before you get started, you must [fork](https://github.com/kyb3r/modmail/fork) the repo first if you are using Heroku and want to update the bot. +Before you get started, you must [fork](https://github.com/kyb3rr/modmail/fork) the repo first if you are using Heroku and want to update the bot. ### Syncing a fork branch from the web UI @@ -23,15 +23,15 @@ If the changes from the upstream repository cause conflicts, GitHub will prompt ### I want to enable automatic updates 1. Create a GitHub account -2. [Fork](https://github.com/kyb3r/modmail/fork) the repository -3. Add GITHUB\_TOKEN into your configuration variables from https://github.com/settings/tokens with the repo scope ([Guide](https://github.com/kyb3r/modmail/wiki/Installation-\(cont.\)#4-how-to-obtain-your-github\_token---required-for-the-update-command-)). +2. [Fork](https://github.com/kyb3rr/modmail/fork) the repository +3. Add GITHUB\_TOKEN into your configuration variables from https://github.com/settings/tokens with the repo scope ([Guide](https://github.com/kyb3rr/modmail/wiki/Installation-\(cont.\)#4-how-to-obtain-your-github\_token---required-for-the-update-command-)). 4. Link your GitHub account to heroku ![](https://i.imgur.com/qjWraS0.png) 5. Turn on automatic deploys ![](https://i.imgur.com/jgUVl7f.png) 6. Restart the bot ### I want to update the bot once -[Click here to create a new pull request to your fork](https://github.com/kyb3r/modmail/pull/new/master). Select `compare across forks`, make the base repository `yourusername/modmail` and ensure the branch is set to master. Put any title you want and create the pull request. On the page that comes after this, merge the pull request. +[Click here to create a new pull request to your fork](https://github.com/kyb3rr/modmail/pull/new/master). Select `compare across forks`, make the base repository `yourusername/modmail` and ensure the branch is set to master. Put any title you want and create the pull request. On the page that comes after this, merge the pull request. You then want to go to your modmail application in Heroku, connect your modmail fork via the `Deploy` tab and deploy the `master` branch. From 2216eac6c3765f549f4c8406d79854fd7d88c285 Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Thu, 16 Mar 2023 11:00:51 -0400 Subject: [PATCH 07/20] Update repo name --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ccd2d75..26fb9c4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ --- -description: https://github.com/kyb3rr/modmail +description: https://github.com/modmail-dev/modmail --- # Introduction @@ -58,7 +58,7 @@ If you like to show your appreciation, consider supporting us on [**Patreon**](h ### 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/kyb3rr/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 From e30158ca60b1a2be657132eea3cb400663197c47 Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Thu, 16 Mar 2023 11:04:46 -0400 Subject: [PATCH 08/20] Update repo link --- configure-modmail-and-logviewer.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/configure-modmail-and-logviewer.md b/configure-modmail-and-logviewer.md index 218e55a..9d07f4f 100644 --- a/configure-modmail-and-logviewer.md +++ b/configure-modmail-and-logviewer.md @@ -32,7 +32,7 @@ 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. @@ -40,7 +40,7 @@ You will also need to deploy another separate log viewer application from [this Star the repository before you start 😉 -[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/kyb3rr/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. From d20972441ac5445b1e0c84d6b63624c00bd711f1 Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Thu, 16 Mar 2023 11:07:06 -0400 Subject: [PATCH 09/20] Update repo and fix typo --- frequently-asked-questions.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/frequently-asked-questions.md b/frequently-asked-questions.md index ad87f2a..d1b58c7 100644 --- a/frequently-asked-questions.md +++ b/frequently-asked-questions.md @@ -1,6 +1,6 @@ # Frequently Asked Questions -> Last Updated: October 12th, 2020 +> Last Updated: March 16, 2023 #### What is Modmail? @@ -8,7 +8,7 @@ Modmail is a Discord bot, similar to Reddit's Modmail feature. It serves as a sh #### 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/kyb3rr/modmail/wiki/Installation](https://github.com/kyb3rr/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,7 +24,7 @@ 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/kyb3rr/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? @@ -32,7 +32,7 @@ To join our support team, join our [Discord server](https://discord.gg/etJNHCQ). #### 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/kyb3rr/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? @@ -42,7 +42,7 @@ Join our [Discord server](https://discord.gg/etJNHCQ) and DM Modmail. One of our 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 ) From 98d6e159eb8b9de5e26f1f67516374ddc6efdb8b Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Thu, 16 Mar 2023 11:09:23 -0400 Subject: [PATCH 10/20] Update repo --- installation-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/installation-1.md b/installation-1.md index 5d2afae..a84c5fa 100644 --- a/installation-1.md +++ b/installation-1.md @@ -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/kyb3rr/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.\)) From f07c7c4db78e56062d9b659a0418dc55322b78e3 Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Thu, 16 Mar 2023 11:10:25 -0400 Subject: [PATCH 11/20] Update repo links --- installation-continued.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/installation-continued.md b/installation-continued.md index ec87f6f..83856b9 100644 --- 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,7 +82,7 @@ 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/kyb3rr/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. @@ -114,7 +114,7 @@ After that's done configuring, click the `View` button. It will redirect you to 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). -Make sure to setup permissions using this [handy guide](https://github.com/kyb3rr/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! From fac2fc70eb1b19452343f2968744b30906c7ae24 Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Thu, 16 Mar 2023 11:12:09 -0400 Subject: [PATCH 12/20] Update repo links --- installation/heroku.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/installation/heroku.md b/installation/heroku.md index 538a359..804e9e5 100644 --- 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. -First we fork the Modmail repository. Head over to [https://github.com/kyb3rr/modmail/fork](https://github.com/kyb3rr/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**.
Screenshot of creating a Modmail fork.

Create a GitHub fork for the Modmail Repository.

-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**.
Screenshot of creating a Logviewer fork.

Create a GitHub fork for the Logviewer Repository.

From d2e4709079031edf661fc848d87a447552ad4e75 Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Thu, 16 Mar 2023 11:15:06 -0400 Subject: [PATCH 13/20] update links --- installation/railway.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/installation/railway.md b/installation/railway.md index b8c0740..b15a2aa 100644 --- 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. -First we fork the Modmail repository. Head over to [https://github.com/kyb3rr/modmail/fork](https://github.com/kyb3rr/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**.
Screenshot of creating a Modmail fork.

Create a GitHub fork for the Modmail Repository.

-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**.
Screenshot of creating a Logviewer fork.

Create a GitHub fork for the Logviewer Repository.

From 6bd57184de34b1e27693d0d5974c966e65aec963 Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Thu, 16 Mar 2023 11:19:30 -0400 Subject: [PATCH 14/20] update links --- plugins.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/plugins.md b/plugins.md index 30af776..6110183 100644 --- a/plugins.md +++ b/plugins.md @@ -2,7 +2,7 @@ ## Plugins -Visit the [Unofficial List of Plugins](https://github.com/kyb3rr/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins. +Visit the [Unofficial List of Plugins](https://github.com/modmail-dev/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins. ## Guidelines @@ -10,7 +10,7 @@ To get approved and officially verified, you need to ensure you follow these gui * Supporting Python 3.8 (and above). * No malicious intent. -* The plugin cannot be a feature pending to be added into [Modmail](https://github.com/kyb3rr/modmail/issues). You can submit a PR to add it to the core Modmail. +* The plugin cannot be a feature pending to be added into [Modmail](https://github.com/modmail-dev/modmail/issues). You can submit a PR to add it to the core Modmail. * Core Modmail still needs to 100% function. * Cog name cannot be the same as any current class (`Core`, `Modmail`). * It cannot have the same name as another approved plugin. @@ -68,7 +68,7 @@ To install a plugin that is not in the official registry, type: ?plugin add githubusername/plugin_repo/plugin_name[@branch] ``` -An example of a plugin can be seen at [`fourjr/modmail-plugins`](https://github.com/fourjr/modmail-plugins) or any of the plugins in our [registry](https://github.com/kyb3rr/modmail/blob/master/plugins/registry.json). +An example of a plugin can be seen at [`fourjr/modmail-plugins`](https://github.com/fourjr/modmail-plugins) or any of the plugins in our [registry](https://github.com/modmail-dev/modmail/blob/master/plugins/registry.json). #### Branch parameter @@ -144,4 +144,4 @@ async def on_thread_ready(self, thread, creator, category, initial_message): ### Approval request -Create a [Pull Request](https://github.com/kyb3rr/modmail/pulls) adding your plugin into [`plugins/registry.json`](https://github.com/kyb3rr/modmail/blob/master/plugins/registry.json) and we will take a look at it. +Create a [Pull Request](https://github.com/modmail-dev/modmail/pulls) adding your plugin into [`plugins/registry.json`](https://github.com/kyb3rr/modmail/blob/master/plugins/registry.json) and we will take a look at it. From b5f8eefbcf27cfec4b18ad1b370eeb651d1eb00a Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Thu, 16 Mar 2023 11:20:11 -0400 Subject: [PATCH 15/20] Fix mistake in my commit to fix mistake with repo links --- plugins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins.md b/plugins.md index 6110183..2251102 100644 --- a/plugins.md +++ b/plugins.md @@ -144,4 +144,4 @@ async def on_thread_ready(self, thread, creator, category, initial_message): ### Approval request -Create a [Pull Request](https://github.com/modmail-dev/modmail/pulls) adding your plugin into [`plugins/registry.json`](https://github.com/kyb3rr/modmail/blob/master/plugins/registry.json) and we will take a look at it. +Create a [Pull Request](https://github.com/modmail-dev/modmail/pulls) adding your plugin into [`plugins/registry.json`](https://github.com/modmail-dev/modmail/blob/master/plugins/registry.json) and we will take a look at it. From d5d5f615eb1a24c719afc5dc2b1ccc6be8eb4596 Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Thu, 16 Mar 2023 11:21:28 -0400 Subject: [PATCH 16/20] update links --- updating.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/updating.md b/updating.md index 0fb63eb..e2485ce 100644 --- a/updating.md +++ b/updating.md @@ -6,7 +6,7 @@ You can update Modmail on your Heroku account whenever changes are made to the r ## Forking the repo -Before you get started, you must [fork](https://github.com/kyb3rr/modmail/fork) the repo first if you are using Heroku and want to update the bot. +Before you get started, you must [fork](https://github.com/modmail-dev/modmail/fork) the repo first if you are using Heroku and want to update the bot. ### Syncing a fork branch from the web UI @@ -23,15 +23,15 @@ If the changes from the upstream repository cause conflicts, GitHub will prompt ### I want to enable automatic updates 1. Create a GitHub account -2. [Fork](https://github.com/kyb3rr/modmail/fork) the repository -3. Add GITHUB\_TOKEN into your configuration variables from https://github.com/settings/tokens with the repo scope ([Guide](https://github.com/kyb3rr/modmail/wiki/Installation-\(cont.\)#4-how-to-obtain-your-github\_token---required-for-the-update-command-)). +2. [Fork](https://github.com/modmail-dev/modmail/fork) the repository +3. Add GITHUB\_TOKEN into your configuration variables from https://github.com/settings/tokens with the repo scope ([Guide](https://github.com/modmail-dev/modmail/wiki/Installation-\(cont.\)#4-how-to-obtain-your-github\_token---required-for-the-update-command-)). 4. Link your GitHub account to heroku ![](https://i.imgur.com/qjWraS0.png) 5. Turn on automatic deploys ![](https://i.imgur.com/jgUVl7f.png) 6. Restart the bot ### I want to update the bot once -[Click here to create a new pull request to your fork](https://github.com/kyb3rr/modmail/pull/new/master). Select `compare across forks`, make the base repository `yourusername/modmail` and ensure the branch is set to master. Put any title you want and create the pull request. On the page that comes after this, merge the pull request. +[Click here to create a new pull request to your fork](https://github.com/modmail-dev/modmail/pull/new/master). Select `compare across forks`, make the base repository `yourusername/modmail` and ensure the branch is set to master. Put any title you want and create the pull request. On the page that comes after this, merge the pull request. You then want to go to your modmail application in Heroku, connect your modmail fork via the `Deploy` tab and deploy the `master` branch. From 52161c1c3e9bd1c2ae4335afdabc0194f9f575cd Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Thu, 16 Mar 2023 15:21:35 -0400 Subject: [PATCH 17/20] Remove ref. to GH wiki and direct to built in page --- configuration-variables-config-vars.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/configuration-variables-config-vars.md b/configuration-variables-config-vars.md index 105caf7..27ac007 100644 --- 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/kyb3rr/modmail/wiki/Color-Names. +Accepted color names can be found here: {% page-ref page="color-names.md" %}. From f0f9e3af9afa5628539af1a588fd0f87093d7a90 Mon Sep 17 00:00:00 2001 From: lorenzo132 <50767078+lorenzo132@users.noreply.github.com> Date: Sat, 18 Mar 2023 02:41:28 +0100 Subject: [PATCH 18/20] update: loglink example (#14) This changes the link for a log example --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 26fb9c4..7c47dbd 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ When a member sends a direct message to Modmail, the bot will create a channel (

An example of a Modmail thread.

-Our Logviewer will save the threads so your staff can view previous threads through their corresponding log link. ~~Here is an~~ [~~**example**~~](https://logs.modmail.dev/example). +Our Logviewer will save the threads so your staff can view previous threads through their corresponding log link. ~~Here is an~~ [~~**example**~~](https://publicmodmail.logs.vodka/logs/example). ## Features From 14ddfe824d294d7c237ac1b8654eaa19d35c8c61 Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Fri, 17 Mar 2023 22:20:24 -0400 Subject: [PATCH 19/20] Update Invite Links in all Files --- README.md | 2 +- configure-modmail-and-logviewer.md | 2 +- frequently-asked-questions.md | 6 +++--- installation-1.md | 2 +- installation-continued.md | 4 ++-- installation/railway.md | 2 +- permissions.md | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 26fb9c4..347565e 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ 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). +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)! diff --git a/configure-modmail-and-logviewer.md b/configure-modmail-and-logviewer.md index 9d07f4f..160005f 100644 --- a/configure-modmail-and-logviewer.md +++ b/configure-modmail-and-logviewer.md @@ -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 index d1b58c7..e39b59f 100644 --- a/frequently-asked-questions.md +++ b/frequently-asked-questions.md @@ -28,7 +28,7 @@ Modmail is an open-source project, which means you can easily add or request new #### 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? @@ -36,7 +36,7 @@ You can add commands to the bot using plugins. All currently approved plugins ca #### 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? @@ -50,4 +50,4 @@ There is not much information we get about your instance of modmail, The only th #### 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 index a84c5fa..f9ab8c2 100644 --- 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/ diff --git a/installation-continued.md b/installation-continued.md index 83856b9..576999f 100644 --- a/installation-continued.md +++ b/installation-continued.md @@ -104,7 +104,7 @@ 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. @@ -112,7 +112,7 @@ After that's done configuring, click the `View` button. It will redirect you to *** -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/modmail-dev/modmail/wiki/Permissions)! diff --git a/installation/railway.md b/installation/railway.md index b15a2aa..b287180 100644 --- a/installation/railway.md +++ b/installation/railway.md @@ -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 index 609e287..bc4d852 100644 --- 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. From 79f62fc2636c5def949ef2f8e77e27bdeba8a82f Mon Sep 17 00:00:00 2001 From: Stephen <48072084+StephenDaDev@users.noreply.github.com> Date: Wed, 22 Mar 2023 09:59:52 -0400 Subject: [PATCH 20/20] Add Windows Tutorial (#11) * Update README.md * fix poor formatting * Add Windows Guide for Bot w/o update or Logviewer * updated req. seb * Remove add to PATH per disc. --- installation/local-hosting-vps/windows.md | 85 ++++++++++++++++++++++- 1 file changed, 83 insertions(+), 2 deletions(-) diff --git a/installation/local-hosting-vps/windows.md b/installation/local-hosting-vps/windows.md index 7f92b40..98d4c5f 100644 --- a/installation/local-hosting-vps/windows.md +++ b/installation/local-hosting-vps/windows.md @@ -4,8 +4,89 @@ description: Deploy Modmail on a Windows machine. # Windows -TODO - ## Prerequisites +* Somewhat recent hardware / software. +* Stable internet connection from hosting server. +* The hosting server remains online 24/7. +* You have completed the initial steps: [invited your bot](../#create-a-discord-bot) and [created a MongoDB database](../#create-a-mongodb-database). +* Windows 10 or 11 (any varient) + +## Filling Enviornment Variables +Once you have finished the prerequsite steps, gather your: +* BotToken +* Logviewer URL (or what you plan on using if you haven't set it up yet.) +* Primary Guild (Server) ID +* Inbox Guild (Server) ID (if applicable) +* Bot Owner's ID (usually just your ID) +* Completed MongoURI + +Once you have done so, open the file `.env.example` included in your download in your preferred raw text editor of choice (Usually Notepad or Notepad++, however others exist. *Do not use Word, WordPad, or similar*) + + +Begin to fill in the information required: +``TOKEN=`` your bot’s token. + + +``LOG_URL=`` the URL of your log viewer. + + +``GUILD_ID=`` the ID of the server your bot operates in. + + +``OWNERS=`` your user ID (ie. OWNERS=9821302031291298, or if multiple owners, OWNERS=9821302031291298,9781239213813229,924822913921391). + + +``MONGO_URI=`` your Mongo connection URI from the MongoDB setup. + + +Together, they should resemble something similar to the original ``.env.example`` file. + + +Save the file as ``.env`` when done. + +It should look something like this: +{% code title=".env" %} +```py +TOKEN=yourbottokengoeshere +LOG_URL=https://example.logs.vodka/ +GUILD_ID=1079074933008781362 +OWNERS=188363246695219201,231595246213922828 +MONGO_URI=mongodb+srv://username:password@cluster0-abcde.mongodb.net/ +``` +{% endcode %} + +## Installing Python + +Download Python and set up Python from official Python download page: https://www.python.org/downloads/. The pre-installed Python on your local machine is usually out of date, you need the version of Python 3.09 for Modmail. + +> The version of Python required may change overtime. Use the version that is recommended in this guide, and then reach out to us in the Support Server if that gives you problems. We will attempt to keep these guides as up to date as possible, however, this is the one place where a potiental version mismatch could occur. + +## Running Modmail + +Open Command Prompt, or "cmd". You can do this in one of two ways. + +1. Press the Windows Key, then type "cmd" and press enter. +2. Hold down the Windows Key + R, a Run Dialog will appear, type in "cmd" and press enter. + +### Navigate to where you stored Modmail + +Find the path of where you located your modmail in File Explorer, right click the folder name `modmail` or `modmail-master` and click "Copy Path". + +Then go back to your Command Prompt, and type ``cd `` then right click and press paste. This will paste in the path of the folder you just found in File Explorer. Press enter to change to that directory. + +### Install the requirements + +Run this command: +```py -3.9 -m pip install pipenv && py -3.9 -m pipenv install``` + +This will install the pipenv package, and then use it to install the most up-to-date list of dependencies from our dependency list. + +### Start your Modmail + +To start the Modmail bot itself, run this command: +```py -3.9 -m pipenv run python bot.py``` + +Your Modmail should now be working properly. If you are still having issues, let us know in our [support server](https://discord.gg/zmdYe3ZVHG). + ## Updating