3.2 KiB
Deployment profiles
allstarr.sh is the supported install and update entry point. It wraps the single checked-in docker-compose.yml, validates the resulting Compose model, remembers explicitly enabled optional profiles, and does not delete volumes.
First install
./allstarr.sh init
# edit .env and protected files if required
./allstarr.sh up
The default release mode uses the configured published image. Source mode builds the checked-out tree:
./allstarr.sh mode source
./allstarr.sh up
Switch back with ./allstarr.sh mode release.
Default stack
The default stack contains:
- PostgreSQL 18 with a health check and private password file.
- Allstarr with the state, cache, download, kept, Apple upload, and key-ring mounts it owns.
There is no SQLite, Redis, Valkey, AIO image, conversion container, or Compose overlay in the supported topology.
Optional profiles
Spotify lyrics uses the pinned upstream image already declared in the native spotify-lyrics profile:
./allstarr.sh enable spotify-lyrics
./allstarr.sh up
Apple download requires a legally obtained supported Apple Music Android package. Upload it through the Apple source setup, then run:
./allstarr.sh install-apple x86_64
Use arm64-v8a on an ARM64 Docker host. The script verifies the staged package and upstream wrapper inputs before enabling the native apple profile. Allstarr distributes its own thin integration layer, not the upstream provider implementation or Apple package.
See Spotify lyrics and Apple download.
Update
./allstarr.sh update
Release mode pulls the configured images and recreates the active profiles. Source mode requires a clean tracked tree, fast-forwards the checkout, rebuilds, and recreates the active profiles. up does not pull repository changes.
Use upgrade when a backup should be taken before the update:
./allstarr.sh upgrade
Backup and restore
./allstarr.sh backup
./allstarr.sh restore /path/to/archive.tar.gz --confirm-replace
Restore validates the archive, requires explicit replacement confirmation, and creates a pre-restore backup. PostgreSQL, configuration, the key ring, and enabled profile state have different recovery roles; follow the storage runbook. Downloaded and kept media remain host-mounted data and require their own backup policy.
Operations
./allstarr.sh status
./allstarr.sh logs allstarr
./allstarr.sh disable spotify-lyrics
./allstarr.sh disable apple
./allstarr.sh down
Disabling an optional profile removes its running containers on the next reconciliation but preserves its durable volumes and Allstarr configuration. Re-enable it explicitly when needed.
Adding future optional integrations
A future integration belongs in the single Compose file behind an explicit profile and an allstarr.sh command. Pin the upstream image or verified source, publish no unnecessary host ports, persist only owned state, and keep the Docker socket out of application containers. Do not vendor or redistribute upstream implementation code when Allstarr only needs an integration layer.