erster docker release
This commit is contained in:
@@ -0,0 +1,65 @@
|
||||
# Konfiguration
|
||||
|
||||
## config.yml
|
||||
|
||||
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`.
|
||||
|
||||
## Abschnitte
|
||||
|
||||
### Aufnahme
|
||||
|
||||
| Parameter | Standard | Beschreibung |
|
||||
|-----------|----------|-------------|
|
||||
| `recording.download_path` | `/app/data/recordings` | Speicherort für Aufnahmen |
|
||||
| `recording.max_retries` | `5` | Max. Reconnect-Versuche bei Verbindungsabbruch |
|
||||
| `recording.retry_delay` | `5` | Wartezeit (Sekunden) zwischen Reconnect-Versuchen |
|
||||
|
||||
### Authentifizierung
|
||||
|
||||
| Parameter | Standard | Beschreibung |
|
||||
|-----------|----------|-------------|
|
||||
| `auth.enabled` | `false` | Basic Auth aktivieren |
|
||||
| `auth.username` | `admin` | Benutzername |
|
||||
| `auth.password` | `stream-recorder` | Passwort |
|
||||
|
||||
### 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.) |
|
||||
|
||||
## Beispiel
|
||||
|
||||
```yaml
|
||||
recording:
|
||||
download_path: /app/data/recordings
|
||||
max_retries: 5
|
||||
retry_delay: 5
|
||||
|
||||
auth:
|
||||
enabled: true
|
||||
username: admin
|
||||
password: mein-passwort
|
||||
|
||||
ntfy:
|
||||
url: https://ntfy.sh/stream-recorder
|
||||
token: ""
|
||||
events: start,stop,error,upload
|
||||
|
||||
plik:
|
||||
url: https://plik.example.com
|
||||
api_key: ""
|
||||
ttl: 30d
|
||||
```
|
||||
Reference in New Issue
Block a user