mirror of
https://github.com/SoPat712/allstarr.git
synced 2026-10-08 06:05:02 -04:00
Allstarr documentation
These documents describe the code that is currently shipped. Planned work does not belong here; implementation planning lives in the ignored apis/steering workspace.
Start here
- Architecture overview: runtime boundaries and ownership.
- Configuration: deployment-owned values, durable settings, and secrets.
- Deployment profiles: install, update, optional services, backup, and restore.
- Storage: PostgreSQL ownership, migration, backup, and recovery.
- Extension SDK v1: package, capability, permission, and account contracts.
Operator guides
- Legacy
.envimport - Apple download provider
- Spotify lyrics service
- Client compatibility
- Jellyfin v12 music surface
Documentation rules
- Describe current behavior only.
- Link to the owning code instead of duplicating long lists that can drift.
- Keep deployment choices in operator guides and unfinished work in
apis/steering. - Do not document SQLite, Redis, Valkey, AIO images, Compose overlays, bundled extension registries, or automatic legacy-state conversion as supported runtime features.
- When code and documentation disagree, fix the documentation in the same completed implementation chunk.