Fedora

Deploy Modmail on a Fedora server.

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.

Prerequisites

1. Root access (sudo).

2. Minimum 1GB of RAM

3. At least 2GB available disk space.

4. Supported releases:

   • Fedora 38

   • Fedora 37

   • Fedora 36

   • Fedora 35

Dependencies

• Python 3.10

• Tools: git, wget, nano

• Additional Modmail requirements: g++

All code blocks should be executed in bash and line by line unless specified otherwise.

Fedora Linux 35 and above has all required packages available in official repositories. Install them with dnf.

sudo dnf -y install python310 git nano g++ gtk3

And then, make sure pip is installed for Python 3.10 with:

python3.10 -m ensurepip --upgrade

Installing Bot

Clone and change directory into the Modmail folder with:

git clone https://github.com/modmail-dev/modmail
cd modmail

And then, install pipenv and the bot dependencies with:

python3.10 -m pip install pipenv
python3.10 -m pipenv install --python 3.10

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 to find where to obtain these.

nano .env

After that, press Ctrl+O and Enter to save your changes. Exit the nano editor with Ctrl+X.

If using the nano editor is a bit of a learning curve, you can always FTP into your server using software like WinSCP to edit the .env file manually with your preferred GUI-based editor like Notepad.

After your .env file is ready, you can now go ahead and try running your bot with:

python3.10 -m pipenv run bot

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.