diff options
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 | | + |