Modmail Setup Guide (Patreon)

A setup guide for Patreon-hosted Modmail.

Project maintained by the Modmail Team Hosted on GitHub Pages — Theme by mattgraham

Transfer Existing Modmail Bot

Go Back

You have chosen to transfer over your existing Modmail bot to Patreon hosting. See below for your current hosting solution’s transfer guide.

Heroku

Navigate to Heroku Dashboard on the heroku.com website, login if prompted. Choose the Modmail Bot application (does not have the zzz logo).

Open Modmail Dashboard

Click on the Settings tab. Scroll down to the Config Vars section and click on Reveal Config Vars.

Reveal Config Vars

The page will display all your Modmail configs. Copy every field and send it back to Patreon Modmail DM.
Note: it must include the token, MongoDB connection string, and guild ID.

Config Example

If your bot is still running, navigate to the Resources tab. Click on the pencil icon, turn off the worker switch, and press confirm. Otherwise, your bot may send duplicate messages.

Turn off worker

Lastly, choose a memorable name for your Logviewer. You will be provided with a log URL under our .modmail.dev domain name. You can choose anything you like (with a few restrictions), if you feel it’s reasonable, then most likely we do too! Note: only 3-16 alphanumeric characters are allowed. Send this to Patreon Modmail DM as well.

Repl.it

Navigate to My Repls on the repl.it website, login if prompted. Choose the Modmail Bot repl (not the logviewer’s).

Open Modmail Repl

On the side panel, click on the lock icon (Secret environment variables). Scroll down to the bottom and click Open raw editor.

Find Repl Secret

You will be greeted with a pop-up text box containing your secrets, copy everything in there and send back it to Patreon Modmail DM.
Note: it must include the token, MongoDB connection string, and guild ID.

Secret Example

If your bot is still running, press the Stop button at the top and disable any uptime robots you may have enabled to stop the current bot from running. Otherwise, your bot may send duplicate messages.

Lastly, choose a memorable name for your Logviewer. You will be provided with a log URL under our .modmail.dev domain name. You can choose anything you like (with a few restrictions), if you feel it’s reasonable, then most likely we do too! Note: only 3-16 alphanumeric characters are allowed. Send this to Patreon Modmail DM as well.

Self Hosted (Other)

Whether you host with a Linux VPS, a Windows Server, a Raspberry PI, or even on your PC, the steps are similar.

  1. Navigate to the project’s root folder on your machine with the file explorer or the cd command.
  2. Open the .env file (cat .env on Linux Terminal or type .env on Windows CMD).
  3. Copy everything in there and send back it to Patreon Modmail DM.
    Note: it must include the token, MongoDB connection string, and guild ID.
  4. Stop the current bot from running.

Lastly, choose a memorable name for your Logviewer. You will be provided with a log URL under our .modmail.dev domain name. You can choose anything you like (with a few restrictions), if you feel it’s reasonable, then most likely we do too! Note: only 3-16 alphanumeric characters are allowed. Send this to Patreon Modmail DM as well.

What’s Next?

After sending all the details back to the Patreon Modmail DM, we will validate everything you sent us. This process might take a few hours depends on our availability, so please bear with us while you wait. We will contact you when the bot is running or if there are any problems!

This guide is written by taku#3343 with parts taken from the Modmail Wiki.
If you have found any issues with this guide, please report them to me. Thanks ❤️!