Docker Installation

📦 Docker Installation

Tip

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

This image is automatically built by our CI on every 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

Unlike a local install, the docker container does not (yet) support custom flags. The script is automatically run with the --autoupdate and is not changeable at the moment. If you would like to run it with custom flags, you can change the flags you want in bootstrap.sh and build the container yourself.