Docker Installation

📦 Docker Installation

Tip

Running on arm64 or arm? Don't worry, the image is multiarch and has you covered!

This image is automatically built by our CI on release.

Docker / Docker Desktop

1. ⬇️ Pull the Docker Image:

   • docker pull ghcr.io/whiteout-project/bot:latest

2. ▶️ Run the Docker Container:

   • docker run -e DISCORD_BOT_TOKEN=<your discord bot token> ghcr.io/whiteout-project/bot:latest

Docker Compose

1. ⬇️ Download docker-compose.yml:

   • docker-compose.yml

2. ⚙️ Configure Bot Token:

   • In docker-compose.yml, set the DISCORD_BOT_TOKEN value as your token.

3. ▶️ Run the Docker Container:

   • In the same directory as docker-compose.yml, run:
   • docker compose up

🚩 Optional Flags

The docker container supports a subset of the bot's custom flags, but all of the important ones are included. Here is a table detailing the environment variable equivalents to the arguments:

Name	Argument	Environment Variable	Note
Auto Update	--autoupdate	UPDATE=1	Not setting UPDATE will turn on --autoupdate
No Update	--no-update	UPDATE=0	None
Beta	--beta	BETA=1	None
Debug	--debug	DEBUG=1	None