Files
streamdock/docs/konfiguration.md
2026-04-12 22:50:50 +02:00

4.0 KiB
Raw Permalink Blame History

Konfiguration

StreamDock wird vollständig über Umgebungsvariablen konfiguriert. Diese können in einer .env-Datei definiert werden, die von Docker Compose automatisch geladen wird.


Übersicht aller Umgebungsvariablen

Server

Variable Standard Beschreibung
STREAMDOCK_HOST 0.0.0.0 Bind-Adresse des HTTP-Servers
STREAMDOCK_PORT 8080 Port des HTTP-Servers
STREAMDOCK_BASE_URL http://localhost:8080 Öffentliche URL (für CORS und Share-Links)

Datenbank & Pfade

Variable Standard Beschreibung
STREAMDOCK_DB_PATH ./data/config/streamdock.db Pfad zur SQLite-Datenbank
STREAMDOCK_RECORDINGS_PATH ./data/recordings Speicherort für Aufnahmen
STREAMDOCK_AVATARS_PATH ./data/avatars Speicherort für Profilbilder

Sicherheit & Admin

Variable Standard Beschreibung
STREAMDOCK_JWT_SECRET change-me-... Unbedingt ändern! Geheimer Schlüssel für JWT-Tokens
STREAMDOCK_ADMIN_USER admin Benutzername des initialen Admin-Accounts
STREAMDOCK_ADMIN_PASSWORD admin Unbedingt ändern! Passwort des Admin-Accounts
STREAMDOCK_ADMIN_EMAIL admin@example.com E-Mail des Admin-Accounts

Wichtig: STREAMDOCK_JWT_SECRET und STREAMDOCK_ADMIN_PASSWORD müssen vor dem ersten Start geändert werden. Der JWT-Secret sollte mindestens 32 zufällige Zeichen lang sein.

SMTP (E-Mail-Benachrichtigungen)

Variable Standard Beschreibung
STREAMDOCK_SMTP_HOST SMTP-Server Hostname
STREAMDOCK_SMTP_PORT SMTP-Server Port (z.B. 587 für STARTTLS)
STREAMDOCK_SMTP_USER SMTP-Benutzername
STREAMDOCK_SMTP_PASSWORD SMTP-Passwort
STREAMDOCK_SMTP_FROM Absender-Adresse
STREAMDOCK_SMTP_FROM_NAME Absender-Anzeigename

Last.fm

Variable Standard Beschreibung
STREAMDOCK_LASTFM_API_KEY Last.fm API-Schlüssel
STREAMDOCK_LASTFM_API_SECRET Last.fm API-Secret

Last.fm API-Keys erhält man unter: https://www.last.fm/api/account/create

Plik (Datei-Sharing)

Variable Standard Beschreibung
STREAMDOCK_PLIK_URL URL der Plik-Instanz
STREAMDOCK_PLIK_API_KEY Plik API-Schlüssel

Ntfy (Push-Benachrichtigungen)

Variable Standard Beschreibung
STREAMDOCK_NTFY_DEFAULT_SERVER https://ntfy.sh Standard Ntfy-Server URL

Beispiel .env-Datei

# === Server ===
STREAMDOCK_HOST=0.0.0.0
STREAMDOCK_PORT=8080
STREAMDOCK_BASE_URL=http://localhost:8080

# === Sicherheit ===
STREAMDOCK_JWT_SECRET=mein-super-geheimer-schluessel-mit-mindestens-32-zeichen
STREAMDOCK_ADMIN_USER=admin
STREAMDOCK_ADMIN_PASSWORD=mein-sicheres-passwort
STREAMDOCK_ADMIN_EMAIL=admin@example.com

# === SMTP (optional) ===
# STREAMDOCK_SMTP_HOST=smtp.example.com
# STREAMDOCK_SMTP_PORT=587
# STREAMDOCK_SMTP_USER=user@example.com
# STREAMDOCK_SMTP_PASSWORD=smtp-passwort
# STREAMDOCK_SMTP_FROM=noreply@example.com
# STREAMDOCK_SMTP_FROM_NAME=StreamDock

# === Last.fm (optional) ===
# STREAMDOCK_LASTFM_API_KEY=dein-api-key
# STREAMDOCK_LASTFM_API_SECRET=dein-api-secret

# === Plik (optional) ===
# STREAMDOCK_PLIK_URL=https://plik.example.com
# STREAMDOCK_PLIK_API_KEY=dein-plik-key

# === Ntfy (optional) ===
# STREAMDOCK_NTFY_DEFAULT_SERVER=https://ntfy.sh

Konfiguration zur Laufzeit

Einige Einstellungen können Benutzer über die Web-Oberfläche anpassen:

  • Last.fm: Verbindung über OAuth im Bereich Einstellungen
  • Plik: Server-URL und API-Key in den Benutzer-Einstellungen
  • Benachrichtigungen: Kanäle (E-Mail, Webhook, Ntfy) und Events pro Benutzer
  • Lautstärke: Wird automatisch pro Benutzer gespeichert
  • Profilbild: Upload unter Profil-Einstellungen

Weiter: Architektur