# Installation

{% hint style="info" %}
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.
{% endhint %}

### 1. Download the bot on GitHub

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

<figure><img src="/files/M6WGJmfKK4AUfCfX5FyJ" alt=""><figcaption></figcaption></figure>

### 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.

<figure><img src="/files/mJCSrC1DCLhTypcTtyT8" alt=""><figcaption></figcaption></figure>

### 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.

<figure><img src="/files/ShntySfX5ueVMqcopv5F" alt=""><figcaption></figcaption></figure>

### 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>

<figure><img src="/files/UIBgI3qzRvYfQ2YzljKl" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/uovofDUW61wGN5BWMeQm" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/NCElGngWEm9Zh41nnEku" alt=""><figcaption></figcaption></figure>

### 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`<br>

<figure><img src="/files/a1Nd0RgjhgYmIPfMAhPR" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/FTSyFFzEK8qA9kuKcZzL" alt=""><figcaption></figcaption></figure>

### 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.

<figure><img src="/files/42EbgrfnW1y2C3nB28k3" alt=""><figcaption></figcaption></figure>

### 7. Start the bot

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

<figure><img src="/files/1lFY1wUhIBoEw9rBG7fy" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/7z0M5zn89vaPJbvRamIX" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://martinbndr.gitbook.io/modmail-hosting-on-pterodactyl/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.