README.md

Deploying

keep music is one container (ghcr.io/findmalek/keep-player, amd64) that needs to reach your Navidrome. It keeps its state in one volume at /data, runs as an unprivileged user and works with a read-only root filesystem.

filesetup
../../compose.yamlnext to an existing Navidrome (join its Docker network)
full-stack.compose.yamlNavidrome and keep music together, from scratch
traefik.compose.yamlbehind Traefik with a domain and TLS
dokploy.mdDokploy, with automatic deploys from CI

Every setting is an environment variable: configuration. Usually only NAVIDROME_URL.

Image tags

tagwhat
latest, 0.4, 0.4.1releases
mainthe latest release, same as latest (what the author runs)
sha-abc1234one exact commit

Health

  • /healthz: the process answers (the image's Docker healthcheck).
  • /api/health: readiness. 200 when every configured Navidrome answers, 503 otherwise, with each server's id, latency and version. It never shows server addresses, so it's safe to expose.

Reverse proxies

Audio is streamed with HTTP Range requests and can run for many minutes: don't buffer it and don't cut long responses.

Caddy

caddy
1music.example.com {
2 reverse_proxy player:8080
3}

nginx

nginx
1location / {
2 proxy_pass http://player:8080;
3 proxy_set_header Host $host;
4 proxy_set_header X-Real-IP $remote_addr;
5 proxy_buffering off; # stream audio as it arrives
6 proxy_read_timeout 1h; # long tracks
7}

Set TRUST_PROXY=true behind any of them, so login rate limits see the real client address.