Skip to main content

Docker Quickstart

Docker is the preferred way to deploy Rosterboard, as it comes with all the bells and whistles inside.

Using Docker​

docker volume create rosterboard-data
docker run -v rosterboard-data:/app/config -p 9418:9418 --restart=unless-stopped --name rosterboard -d jouleworks/rosterboard:v1.2

Using Docker Compose​

curl -O https://raw.githubusercontent.com/Jouleworks/rosterboard/refs/heads/main/docker/production/docker-compose.yaml
curl -O .env https://raw.githubusercontent.com/Jouleworks/rosterboard/refs/heads/main/docker/production/.env.example # optional! Be sure to edit and change the file name to .env
docker compose up -d

Once running, Go to http://localhost:9418/setup/ to begin.

Environment Variables​

Set these variables during initial config setup to override default container values. All variables have default values and are not required.

Variable NameDescriptionDefault
POSTGRES_HOSTHostname for Postgres Databaserosterboard
POSTGRES_PORTPort for Postgres Database5432
POSTGRES_USERUser for the Postgres Database.rosterboard
POSTGRES_PASSWORDPassword for the Postgres Database.rosterboard
POSTGRES_DBDatabase name for the Postgres Database.rosterboard
REDIS_HOSTHost for the Redis Serverrosterboard-redis

Upgrading​

Using Docker​

docker stop rosterboard
docker pull jouleworks/rosterboard:v1.2 # Replace v1.2 with the tag you want to upgrade to here. https://hub.docker.com/r/jouleworks/rosterboard/tags
docker start rosterboard

Using Docker Compose​

docker compose up -d