summaryrefslogtreecommitdiff
path: root/azuracast/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'azuracast/README.md')
-rw-r--r--azuracast/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/azuracast/README.md b/azuracast/README.md
new file mode 100644
index 0000000..dc0036f
--- /dev/null
+++ b/azuracast/README.md
@@ -0,0 +1,34 @@
+# AzuraCast
+
+Self-hosted web radio management suite. Runs stations, handles playlists, DJ accounts, streaming, and more.
+
+## Setup
+
+1. Copy `.env.example` to `.env`:
+ ```
+ cp .env.example .env
+ ```
+
+2. **Review `azuracast.env`** — This file contains database passwords and other internal config. Change `MYSQL_PASSWORD` and `MYSQL_ROOT_PASSWORD` to secure values.
+
+3. Start:
+ ```
+ docker compose up -d
+ ```
+
+ Or use the bundled helper script:
+ ```
+ bash docker.sh install
+ ```
+
+## Access
+
+- Web UI: `http://<host>:<AZURACAST_HTTP_PORT>` (default 8080)
+- HTTPS: `https://<host>:<AZURACAST_HTTPS_PORT>` (default 8443)
+
+## What to Configure
+
+- **`.env`** — Set `AZURACAST_HTTP_PORT`, `AZURACAST_HTTPS_PORT`, and optionally `AZURACAST_PUID`/`AZURACAST_PGID` to match your host user.
+- **`azuracast.env`** — Contains internal passwords and settings. Change at least the MySQL passwords.
+- **Media mounts** — See `docker-compose.override.yml` for an example of mounting external media into station directories.
+- **`docker.sh`** — The official AzuraCast management script for updates, backups, and maintenance tasks.