Installing and configuring Modmail

Installing Modmail

In order to install Modmail start by running:

git clone https://github.com/kyb3r/modmail

Go to the Modmail folder by running:

cd modmail

Configuring Modmail

To paste text in PuTTY, right click or press Shift+Insert.

Start by renaming the .env.example file by running:

mv .env.example .env

Edit your .env file by running:

nano .env

In TOKEN paste your bot token that you created in Making Bot Application In OWNERS paste the ID of all the users that will have owner privileges. In GUILD_ID paste the ID of your server In CONNECTION_URI enter your MongoDB connection URI In LOG_URL enter your logviewer link

To save your changes press Ctrl+X. On save modified buffer press Y. When File Name to Write: appears press enter.

Starting Modmail

Using Pipenv

Install dependencies by running:

pipenv install

Finally run it by using

pipenv run bot

Using PM2 (recommended)

You need to use pipenv at least once before using PM2.

To start your bot using PM2 run

pm2 start modmail.sh --name "modmail" && pm2 save && pm2 startup

Once you run this command, you should see a command below "[PM2] To setup the Startup Script, copy/paste the following command:". Copy and run the command. The command should look like this:

sudo env PATH=$PATH:/usr/bin /usr/local/lib/node_modules/pm2/bin/pm2 startup systemd -u ubuntu --hp /home/ubuntu

Congratulations! You now have a working Modmail. If you'd like to set up logviewer, continue to Installing dependencies (logviewer)

For any issues before the Installing dependencies step, please contact me (lidistat67). You can ping me in the server and I'll reply ASAP. For any issues during or after the Installing dependencies step, you may also contact the Modmail support team.