Docker

Prerequisites

Ensure you have the following installed:

Docker

• Visit the installation website.

Docker Compose

• Visit the installation website.

Setup

Download docker-compose.yml from the GitHub repository.

You can either edit docker-compose.yml to have the correct configuration or you can create a .env file in the same folder as docker-compose.yml.

Using a .env file:

.env

BOT_TOKEN=GET_FROM_DISCORD_DEVELOPER_PORTAL
SECRET_KEY=REPLACE_WITH_A_RANDOM_STRING
HEAD_BOT_ADMIN_USERNAME=Admin
HEAD_BOT_ADMIN_PASSWORD=CHOOSE_A_VERY_STRONG_PASSWORD
FRONTEND_URL=http://localhost:5000
API_URL=http://localhost:5003
DISCORD_CLIENT_ID=GET_FROM_DISCORD_DEVELOPER_PORTAL
DISCORD_CLIENT_SECRET=GET_FROM_DISCORD_DEVELOPER_PORTAL
JWT_SECRET=REPLACE_WITH_A_RANDOM_STRING
DATABASE_PATH=bot/bot.db
ENABLE_LEVELING=true
ENABLE_MODERATION=true
ENABLE_APPEALS=true
TWITCH_CLIENT_ID=GET_FROM_TWITCH_DEVELOPER_CONSOLE
TWITCH_CLIENT_SECRET=GET_FROM_TWITCH_DEVELOPER_CONSOLE
YOUTUBE_API_KEY=GET_FROM_GOOGLE_CLOUD_CONSOLE

Replace all placeholder values (like GET_FROM_DISCORD_DEVELOPER_PORTAL) with the actual values from your Discord Developer Portal.

⚠️ Never share your .env file publicly — it contains sensitive secrets!

Create a Discord Bot:

• Go to Discord Developer Portal.

• Create a new application and set up your bot.

Running the Bot and Dashboard

• Open a terminal (recommended).

• Run docker-compose up -d.

If you edit any files after starting the bot, restart it to apply the changes. You can restart the bot by running docker-compose down and docker-compose up -d again.

Once running, access the dashboard:

• Local access: http://localhost:5000

• Remote access: http://OtherPCsIPAddress:5000