Release: v3.1.0

docs/konfiguration.md

@@ -2,9 +2,11 @@
 
 ## config.yml
 
+![Einstellungen](assets/img4_settings.png)
+
 Die Konfiguration liegt in `data/config.yml` und kann über das Web-UI unter **Einstellungen** bearbeitet werden.
 
-Beim ersten Start wird die Datei automatisch mit Standardwerten erstellt. Eine Vorlage mit Kommentaren findet sich in `config/config.yml.dist`.
+Beim ersten Start wird die Datei automatisch mit Standardwerten erstellt. Eine Vorlage mit Kommentaren findet sich in `bin/config.yml.dist`.
 
 ## Abschnitte
 
@@ -13,9 +15,16 @@ Beim ersten Start wird die Datei automatisch mit Standardwerten erstellt. Eine V
 | Parameter | Standard | Beschreibung |
 |-----------|----------|-------------|
 | `recording.download_path` | `/app/data/recordings` | Speicherort für Aufnahmen |
-| `recording.max_retries` | `5` | Max. Reconnect-Versuche bei Verbindungsabbruch |
+| `recording.max_retries` | `5` | Max. Reconnect-Versuche bei Verbindungsabbruch (0 = unbegrenzt) |
 | `recording.retry_delay` | `5` | Wartezeit (Sekunden) zwischen Reconnect-Versuchen |
 
+### Server
+
+| Parameter | Standard | Beschreibung |
+|-----------|----------|-------------|
+| `server.host` | `0.0.0.0` | Bind-Adresse des Webservers |
+| `server.port` | `8484` | Port des Webservers |
+
 ### Authentifizierung
 
 | Parameter | Standard | Beschreibung |
@@ -24,6 +33,15 @@ Beim ersten Start wird die Datei automatisch mit Standardwerten erstellt. Eine V
 | `auth.username` | `admin` | Benutzername |
 | `auth.password` | `stream-recorder` | Passwort |
 
+### Zeitplan-Puffer
+
+Standardwerte für die Vor- und Nachlaufzeit bei neuen Jobs mit Zeitplan.
+
+| Parameter | Standard | Beschreibung |
+|-----------|----------|-------------|
+| `schedule.default_pre_buffer` | `5` | Standard-Vorlaufzeit (Minuten) |
+| `schedule.default_post_buffer` | `5` | Standard-Nachlaufzeit (Minuten) |
+
 ### NTFY
 
 | Parameter | Standard | Beschreibung |
@@ -40,6 +58,12 @@ Beim ersten Start wird die Datei automatisch mit Standardwerten erstellt. Eine V
 | `plik.api_key` | _(leer)_ | API Key für authentifizierte Uploads |
 | `plik.ttl` | `30d` | Aufbewahrungsdauer der Uploads (`30d`, `12h`, etc.) |
 
+### Logging
+
+| Parameter | Standard | Beschreibung |
+|-----------|----------|-------------|
+| `logging.level` | `INFO` | Log-Level: `DEBUG`, `INFO`, `WARN`, `ERROR` |
+
 ## Beispiel
 
 ```yaml
@@ -48,11 +72,19 @@ recording:
   max_retries: 5
   retry_delay: 5
 
+server:
+  host: "0.0.0.0"
+  port: 8484
+
 auth:
   enabled: true
   username: admin
   password: mein-passwort
 
+schedule:
+  default_pre_buffer: 5
+  default_post_buffer: 5
+
 ntfy:
   url: https://ntfy.sh/stream-recorder
   token: ""
@@ -62,4 +94,7 @@ plik:
   url: https://plik.example.com
   api_key: ""
   ttl: 30d
+
+logging:
+  level: INFO
 ```