Files
stream-recorder/docs/konfiguration.md
T
Patrick Asmus a9a9a89cba
Build Release Docker Image / build-amd64 (release) Successful in 6s
Build Release Docker Image / build-arm64 (release) Successful in 10s
Build Release Docker Image / publish-release-manifest (release) Successful in 6s
Release: v3.1.0
2026-09-16 20:22:34 +02:00

101 lines
2.7 KiB
Markdown

# Konfiguration
## 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 `bin/config.yml.dist`.
## Abschnitte
### Aufnahme
| Parameter | Standard | Beschreibung |
|-----------|----------|-------------|
| `recording.download_path` | `/app/data/recordings` | Speicherort für Aufnahmen |
| `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 |
|-----------|----------|-------------|
| `auth.enabled` | `false` | Basic Auth aktivieren |
| `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 |
|-----------|----------|-------------|
| `ntfy.url` | _(leer)_ | NTFY Topic-URL (z.B. `https://ntfy.sh/mein-topic`) |
| `ntfy.token` | _(leer)_ | Bearer-Token für authentifizierte Topics |
| `ntfy.events` | `error` | Kommaseparierte Events: `start`, `stop`, `error`, `upload` |
### Plik
| Parameter | Standard | Beschreibung |
|-----------|----------|-------------|
| `plik.url` | _(leer)_ | Plik-Server URL (z.B. `https://plik.example.com`) |
| `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
recording:
download_path: /app/data/recordings
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: ""
events: start,stop,error,upload
plik:
url: https://plik.example.com
api_key: ""
ttl: 30d
logging:
level: INFO
```