Skip to content
BoardGameTracker
These docs follow the beta image. Until the next stable release after v0.2.181, latest lacks some of the features described here; use uping/boardgametracker:beta to get them.

Quick start

  1. Download the compose file and the example environment file into an empty folder:

    Terminal
    wget https://raw.githubusercontent.com/mregni/BoardGameTracker/refs/heads/master/docker-compose.yml
    wget -O .env https://raw.githubusercontent.com/mregni/BoardGameTracker/refs/heads/master/.env.example

    The downloaded compose file needs Docker Compose 2.24 or newer (docker compose version). On an older version, for example on some NAS systems, use the compose file on the Docker page instead.

  2. Fill in .env:

    • DB_PASSWORD — a password for the database.
    • JWT_SECRET and DATA_PROTECTION_KEY — each its own random value of at least 32 characters. Run openssl rand -base64 48 once for each. Keep DATA_PROTECTION_KEY somewhere safe; see Data protection key.
    • TZ — your timezone, for example Europe/Brussels.

    The application does not start while JWT_SECRET is empty or still starts with CHANGEME.

  3. Start the stack. This starts BoardGameTracker together with its PostgreSQL (pgvector/pgvector:pg16) database:

    Terminal
    docker compose up -d

  4. Open http://localhost:5444 and sign in as admin, with the ADMIN_PASSWORD you set or admin when it is empty. Change the password straight away.