diff --git a/README.md b/README.md index e0c9d7e..374cddc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ -# jellyfin +# Jellyfin + +Self-hosted media server for organizing and streaming movies, television, music, and other media. + +## Deployment layout + +- **Compose:** `/srv/docker/jellyfin/docker-compose.yml` +- **Static configuration/source:** no additional static configuration or build source +- **Non-secret environment:** none; there is no project-local `.env` +- **Secrets:** none; credentials and authentication state created through Jellyfin are application-managed state +- **NVMe application state:** `/srv/appdata/jellyfin/config` and `/srv/appdata/jellyfin/cache` +- **Bulk HDD data:** `/data/Data1/jellyfin` +- **Other mounts:** `/dev/dri` is passed through for hardware acceleration, with supplemental host group IDs +`44` and `993` + +Secrets are never committed to this repository. No separate deployment secret +file is declared; sensitive application-managed state is stored under +`/srv/appdata/jellyfin/config`. + +## Dependencies and recovery + +- **Networks/dependencies:** Jellyfin uses the external `npm_proxy` network at `192.168.97.10` and the host `/ +dev/dri` device for hardware acceleration; no dependent services are declared +- **Back up:** `/srv/appdata/jellyfin/config` and the separately managed media under `/data/Data1/jellyfin` +- **Re-creatable:** the Jellyfin container and `/srv/appdata/jellyfin/cache`