diff options
| author | Tim <contact@bytim.eu> | 2025-11-04 19:01:19 +0100 |
|---|---|---|
| committer | Tim <contact@bytim.eu> | 2025-11-04 19:01:19 +0100 |
| commit | 61a71bf8b931acc704fb38bf7bad1a3c03954ed2 (patch) | |
| tree | 216ea8a0772842172d612670e0757a506f5572b9 /README.md | |
| parent | 128335b5d4bd5dc7ae32aba09f9f6252c5766668 (diff) | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
@@ -1 +1,20 @@ # dionysus + +Dionysus lets your (party) guests add songs to your spotify queue. + +I would recommend exposing the End-user Web UI via a reverse proxy on a public facing VPS. + +It is **not** recommended to expose the Admin Web UI! + +## Environment variables + +Those can be provided by either the shell's environment variables or an ``.env``-File. + +| Name | Description | Default value | +|-----------------------|---------------------------------------------------------------------------------------------|---------------| +| SPOTIFY_CLIENT_ID | The Client ID of your Spotify-App | _Required_ | +| SPOTIFY_CLIENT_SECRET | The Client Secret of your Spotify-App | _Required_ | +| TITLE | Used in titles on the Web UI | "Dionysus" | +| ENDUSER_PORT | The port of the web UI where users can add tracks | | +| ADMIN_PORT | The port of the admin UI where you can control the blacklist and toggle the End-user web UI | | + |