Quickstart

RequirementsCopy Anchor Link

• Docker with Compose 2.24.4 or newer
• Port 3000 free on the host

StartCopy Anchor Link

powershell -NoProfile -ExecutionPolicy Bypass -File infra/setup.ps1
docker compose up -d --build --wait
docker compose ps

setup writes independent random secrets to .env. It never prints them and never overwrites an existing file. Then open http://localhost:3000.

First administratorCopy Anchor Link

The initial administrator comes from BOOTSTRAP_ADMIN_USERNAME and BOOTSTRAP_ADMIN_PASSWORD in .env. After signing in, clear all three BOOTSTRAP_ADMIN_* values and recreate Sanctuary:

docker compose up -d --force-recreate sanctuary

NextCopy Anchor Link

• Public domain with HTTPS: Deployment.
• Let players download the launcher: set KALEIDOSCOPE_DOWNLOAD_URL (Configuration).