mralexsaavedra/spotiarr/spotiarr-docker

Activation Contract

Load when working with docker-compose, deployments, volumes, or self-hosted configuration.

Hard Rules

• ./config/ is a Docker volume mount (./config:/spotiarr/config) — the SQLite database lives there. It is gitignored. Never commit it.
• compose.override.yml is gitignored — use it for local port/env overrides, never commit it.
• spotiarr service waits for redis healthcheck before starting (depends_on: condition: service_healthy).
• Traefik is optional — strip it from compose.override.yml for direct port-3000 access.

Services

Volumes

Required Environment Variables

SPOTIFY_CLIENT_ID=
SPOTIFY_CLIENT_SECRET=
SPOTIFY_REDIRECT_URI=http://localhost:3000/api/auth/callback
 
DOWNLOADS_DIR=/absolute/host/path/to/downloads   # must be absolute

Optional Environment Variables

PUID=1000          # file ownership UID (default: 1000)
PGID=1000          # file ownership GID (default: 1000)
REDIS_HOST=redis   # default: "redis" (service name)
REDIS_PORT=6379    # default: 6379

Instance Auth (Optional)

SPOTIARR_TOKEN=                   # >=16 chars; omit to disable the gate
SPOTIARR_SESSION_TTL_HOURS=168    # default: 168 (7 days)
SPOTIARR_UNLOCK_RATELIMIT=5       # default: 5 per IP per minute
SPOTIARR_TRUST_PROXY=1            # hop count (e.g. 1) or Express preset; REQUIRED behind Traefik/any
                                  # reverse proxy — otherwise req.ip is the proxy IP and rate-limiting
                                  # locks out everyone together
SPOTIARR_CORS_ORIGIN=             # comma-separated CORS origin allowlist; omit for same-origin (default).
                                  # Wildcard "*" is rejected. Only needed for a separate-origin client.

Offline Audio Caching (Slice 2 — HTTPS required)

The Service Worker audio cache (spotiarr-audio, CacheFirst strategy) requires a secure context (HTTPS or localhost). On plain HTTP the feature is automatically inert — online playback is unaffected, but tracks are not cached for offline use.

To enable offline caching in production, terminate TLS at the reverse proxy before the container:

• Traefik (bundled in compose.yml): configure the websecure entrypoint + a CertificateResolver (Let's Encrypt or manual cert). Set SPOTIFY_REDIRECT_URI to your https:// domain.
• Any other reverse proxy (Nginx, Caddy, etc.) works the same way — just ensure the browser sees HTTPS.

Plain HTTP self-hosted installs continue to work online; they simply receive no offline benefit.

Update Flow

docker compose pull
docker compose up -d

References

• Compose file: compose.yml
• Env template: .env.example
• Entrypoint: docker-entrypoint.sh
• Data volume: ./config/ (gitignored)