summaryrefslogtreecommitdiff
path: root/ampache/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'ampache/README.md')
-rw-r--r--ampache/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/ampache/README.md b/ampache/README.md
new file mode 100644
index 0000000..503eefc
--- /dev/null
+++ b/ampache/README.md
@@ -0,0 +1,24 @@
+# Ampache
+
+Self-hosted music streaming server.
+
+## Setup
+
+1. Copy `.env.example` to `.env` and fill in your credentials:
+ ```
+ cp .env.example .env
+ ```
+
+2. Start:
+ ```
+ docker compose up -d
+ ```
+
+## Access
+
+- Web UI: `http://<host>:7676`
+
+## What to Configure
+
+- **`.env`** — Set `MYSQL_USER` and `MYSQL_PASS` before first start. Other variables can be set after the initial setup.
+- **Media volume** — The line `- /srv/mus:/media` mounts your music library. Change `/srv/mus` to wherever your music is stored.