Files
stream-recorder/docs/konfiguration.md
T

67 lines
2.9 KiB
Markdown

# Konfiguration
Die Konfigurationsdatei liegt unter `config/stream-recorder.conf`. Sie wird aus der Vorlage `config/stream-recorder.conf.dist` erstellt:
```bash
cp config/stream-recorder.conf.dist config/stream-recorder.conf
nano config/stream-recorder.conf
```
Die `.conf`-Datei wird von Git ignoriert und bleibt bei Updates erhalten.
## Parameter
### Basis-Einstellungen
| Parameter | Standard | Beschreibung |
|-----------------|------------------------------|-------------------------------------------|
| `DOWNLOAD_PATH` | `/home/downloads/recordings` | Basis-Verzeichnis für Aufnahmen |
| `LOG_DIR` | `/var/log/stream-recorder` | Log-Verzeichnis |
| `LOG_LEVEL` | `INFO` | Log-Level: `DEBUG`, `INFO`, `WARN`, `ERROR` |
| `PID_DIR` | `/tmp/stream-recorder` | PID-Dateien für laufende Aufnahmen |
| `STATE_DIR` | `/var/lib/stream-recorder` | Status für bereits gestartete Zeitpläne |
### Reconnect
| Parameter | Standard | Beschreibung |
|---------------|----------|-------------------------------------------|
| `MAX_RETRIES` | `0` | Wiederholungsversuche (0 = unbegrenzt) |
| `RETRY_DELAY` | `5` | Wartezeit zwischen Versuchen (Sekunden) |
Bei Verbindungsabbrüchen versucht das Script automatisch, die Verbindung wiederherzustellen. Bei jedem Reconnect wird eine neue Datei mit aktuellem Zeitstempel erzeugt.
- `MAX_RETRIES=0` — Unbegrenzte Versuche (empfohlen für Langzeitaufnahmen)
- `MAX_RETRIES=5` — Maximal 5 Versuche, danach Abbruch mit Benachrichtigung
### NTFY-Benachrichtigungen
Push-Nachrichten via [ntfy](https://ntfy.sh) (selbst gehostet oder öffentlich).
| Parameter | Standard | Beschreibung |
|---------------|----------|-------------------------------------------|
| `NTFY_URL` | (leer) | NTFY Server-URL inkl. Topic |
| `NTFY_TOKEN` | (leer) | NTFY Access-Token (optional) |
| `NTFY_EVENTS` | `error` | Benachrichtigungs-Events (kommasepariert) |
Siehe [Benachrichtigungen](benachrichtigungen.md) für Details zu den Events.
### Plik-Upload
Fertige Aufnahmen auf einen [Plik](https://github.com/root-gg/plik)-Server hochladen.
| Parameter | Standard | Beschreibung |
|----------------|----------|-------------------------------------------|
| `PLIK_URL` | (leer) | Plik Server-URL |
| `PLIK_API_KEY` | (leer) | Plik API-Key (optional) |
| `PLIK_TTL` | `30d` | Gültigkeitsdauer: `30d`, `24h`, Sekunden |
Siehe [Plik-Upload](plik-upload.md) für die Einrichtung pro Job.
## Alternative Konfigurationsdatei
Eine andere Konfigurationsdatei kann per `-c` übergeben werden:
```bash
./stream-recorder.sh -c /pfad/zur/config.conf record mein-stream
```