Installation

This guide requires you to have a server on the specific pterodactyl that is able to run python applications. If you are unsure this is the case, ask the host provider.

1. Download the bot on GitHub

Visit https://github.com/modmail-dev/Modmail and download the bot as a zip file.

2. Upload the zip file into the server via the filemanager.

Your downloaded zip file needs to be uploaded into your server in the panel.

3. Unarchive the zip file

Unarchive the uploaded zip file and delete the original uploaded .zip file as we are using the Modmail-master folder.

4. Create .env file and fill out the required variables and save it.

Navigate into the Modmail-master folder and create a new file, fill it with the required environment vairables. See https://docs.modmail.dev/installation#preparing-your-environmental-variables

5. Startup settings

Navigate to the startup tab and edit the following sections: Docker Image: Python 3.10 (Recommended version) User uploaded files: enabled App py file: Modmail-master/bot.py Requirements file: Modmail-master/requirements.txt

6. Reinstall server

Navigate to the settings page and reinstall the server. This makes sure the selected python version 3.10 is installed properly. uploaded folder will not be deleted as it just reinstall the software that runs your application.

7. Start the bot

You can start the bot by navigating to the console. Press the start button to run the bot.

Last updated