compass-js

Docker deployment

GitHub Actions builds and pushes the image to GitHub Container Registry:

docker pull ghcr.io/lbtsm/compass-ts:latest

For a private GitHub Container Registry package, log in first with a GitHub token that has read:packages:

docker login ghcr.io

Run it with the production config mounted read-only and a writable cursor directory:

mkdir -p ./cursors
docker run -d \
  --name compass-ts \
  --restart unless-stopped \
  -v "$PWD/config.json:/config/config.json:ro" \
  -v "$PWD/cursors:/data" \
  ghcr.io/lbtsm/compass-ts:latest

Upgrade:

docker pull ghcr.io/lbtsm/compass-ts:latest
docker rm -f compass-ts
docker run -d \
  --name compass-ts \
  --restart unless-stopped \
  -v "$PWD/config.json:/config/config.json:ro" \
  -v "$PWD/cursors:/data" \
  ghcr.io/lbtsm/compass-ts:latest