diff --git a/README.md b/README.md new file mode 100644 index 0000000..5e66ab1 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Sonobarr + +Self-hosted music discovery and recommendation service that integrates with Lidarr. + +## Deployment layout + +- **Compose:** `/srv/docker/sonobarr/docker-compose.yml` +- **Static configuration/source:** no additional static configuration or build source +- **Non-secret environment:** the Lidarr address, quality profile ID, similar-artist batch size, and Gunicorn +control-socket setting are declared inline in Compose; there is no project-local `.env` +- **Secrets:** `/srv/docker/secrets/sonobarr/.env` +- **NVMe application state:** `/srv/appdata/sonobarr/config` +- **Bulk HDD data:** none +- **Other mounts:** `/etc/localtime` is mounted read-only + +Secrets are never committed to this repository. The central secret environment +is supplied to the Sonobarr service. + +## Dependencies and recovery + +- **Networks/dependencies:** Sonobarr uses the external `npm_proxy` network at `192.168.97.23` and connects to +Lidarr at `http://192.168.97.13:8686` +- **Back up:** `/srv/appdata/sonobarr/config` and the separately protected Sonobarr secret environment +- **Re-creatable:** the Sonobarr container itself; no persistent cache or bulk-data path is declared