From 959d0a99aa3f10d6496bcc14fb95076ffccdb050 Mon Sep 17 00:00:00 2001 From: Beda Schmid Date: Tue, 4 Aug 2026 23:57:03 +0000 Subject: [PATCH] Update Readme --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 20df19b..02c1544 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ -# audiomuse +# AudioMuse-AI + +Self-hosted music analysis and playlist-generation service for discovering sonically related tracks in supported +music servers. + +## Deployment layout + +- **Compose:** `/srv/docker/audiomuse/docker-compose.yml` +- **Static configuration/source:** no additional static configuration or build source +- **Non-secret environment:** service roles, timezone, PostgreSQL topology, Redis URL, and temporary-audio paths +are declared inline in Compose; there is no project-local `.env` +- **Secrets:** `/srv/docker/secrets/audiomuse/.env` +- **NVMe application state:** `/srv/appdata/audiomuse/postgres`, `/srv/appdata/audiomuse/redis`, `/srv/appdata/ +audiomuse/temp-audio-flask`, `/srv/appdata/audiomuse/temp-audio-worker`, `/srv/appdata/audiomuse/plugins-flask`, +and `/srv/appdata/audiomuse/plugins-worker` +- **Bulk HDD data:** none +- **Other mounts:** none + +Secrets are never committed to this repository. The central secret environment +is supplied to the PostgreSQL, Flask application, and worker services. + +## Dependencies and recovery + +- **Networks/dependencies:** the Flask application and worker depend on PostgreSQL and Redis through the private +`audiomuse_internal` network; both also use the external `npm_proxy` network at `192.168.97.25` and +`192.168.97.26` +- **Back up:** `/srv/appdata/audiomuse/postgres`, `/srv/appdata/audiomuse/plugins-flask`, `/srv/appdata/ +audiomuse/plugins-worker`, and the separately protected AudioMuse-AI secret environment +- **Re-creatable:** the containers, Redis queue state, and temporary-audio directories