170 lines
7.1 KiB
Markdown
170 lines
7.1 KiB
Markdown
<p align="center">
|
|
<a href="https://techniverse.net">
|
|
<img src="https://assets.techniverse.net/f1/git/graphics/repo-techniverse-logo.png" alt="Techniverse Community" height="70" />
|
|
</a>
|
|
</p>
|
|
|
|
<h1 align="center">stream-recorder</h1>
|
|
|
|
<h4 align="center">
|
|
Generischer Stream-Recorder für RTMP, HLS, HTTP-Audio und weitere Formate — mit Web-UI und Docker
|
|
</h4>
|
|
|
|
<h6 align="center">
|
|
<a href="https://www.cleveradmin.de">🏰 Website</a>
|
|
·
|
|
<a href="https://techniverse.net">📰 Community</a>
|
|
·
|
|
<a href="https://social.techniverse.net/@donnerwolke">🐘 Mastodon</a>
|
|
·
|
|
<a href="https://matrix.to/#/#support:techniverse.net">💬 Support</a>
|
|
</h6>
|
|
<br>
|
|
|
|
|
|
|
|
## Funktionen
|
|
|
|
- **Web-Interface** — Jobs planen, Aufnahmen steuern und verlängern im Browser
|
|
- **Docker-basiert** — Ein Container, läuft auf ARM und x86/x64
|
|
- **Mehrere Stream-Typen** — RTMP, RTMPS, HLS (m3u8), MP3, AAC, OGG, FLAC und HTTP-Streams
|
|
- **Aufnahmen verlängern** — Laufende Aufnahmen spontan verlängern oder auf unbegrenzt setzen
|
|
- **Zeitplanung** — Automatische Aufnahmezeiten direkt im Web-UI konfigurieren
|
|
- **Segment-Splitting** — Lange Aufnahmen automatisch in Teile zerlegen
|
|
- **Auto-Reconnect** — Automatische Wiederverbindung bei Verbindungsabbrüchen
|
|
- **Schnellaufnahme** — URL eingeben, sofort aufnehmen
|
|
- **NTFY-Benachrichtigungen** — Push-Nachrichten bei Start, Stop, Fehler und Upload (pro Job schaltbar)
|
|
- **Plik-Upload** — Aufnahmen automatisch hochladen, optional danach löschen (pro Job schaltbar)
|
|
- **Metadata-Monitor** — Automatische Show-Erkennung via Stream-Metadaten (Plugin)
|
|
- **REST-API** — Alle Funktionen auch per API steuerbar
|
|
|
|
## Schnellstart
|
|
|
|
```bash
|
|
# Repository klonen
|
|
git clone https://git.techniverse.net/scriptos/stream-recorder.git
|
|
cd stream-recorder
|
|
|
|
# Container starten
|
|
docker compose up -d
|
|
```
|
|
|
|
Das Web-UI ist unter `http://localhost:8484` erreichbar. Die Konfiguration wird beim ersten Start automatisch in `data/config.yml` erstellt.
|
|
|
|
Beim ersten Start ist die Anmeldung aktiv: Benutzer `admin`, das zufällig erzeugte Passwort steht einmalig im Container-Log:
|
|
|
|
```bash
|
|
docker logs stream-recorder
|
|
```
|
|
|
|
Das Passwort kann danach unter **Einstellungen** geändert werden.
|
|
|
|
## Container Image
|
|
|
|
Release-Images werden automatisch in der Gitea Container Registry veröffentlicht:
|
|
|
|
```bash
|
|
docker pull git.techniverse.net/scriptos/stream-recorder:latest
|
|
docker pull git.techniverse.net/scriptos/stream-recorder:v3.0.0
|
|
```
|
|
|
|
Dev-Images entstehen bei Pushes auf `main` oder `dev`:
|
|
|
|
```bash
|
|
docker pull git.techniverse.net/scriptos/stream-recorder:dev-latest
|
|
```
|
|
|
|
## Docker Compose
|
|
|
|
```yaml
|
|
services:
|
|
stream-recorder:
|
|
image: git.techniverse.net/scriptos/stream-recorder:latest
|
|
container_name: stream-recorder
|
|
restart: unless-stopped
|
|
ports:
|
|
- "127.0.0.1:8484:8484"
|
|
volumes:
|
|
- ./data:/app/data
|
|
environment:
|
|
TZ: Europe/Berlin
|
|
security_opt:
|
|
- no-new-privileges:true
|
|
cap_drop:
|
|
- ALL
|
|
cap_add:
|
|
- CHOWN
|
|
- DAC_OVERRIDE
|
|
- FOWNER
|
|
- SETUID
|
|
- SETGID
|
|
```
|
|
|
|
Der Port ist standardmäßig nur auf `127.0.0.1` gebunden. Für Zugriff von außen einen Reverse-Proxy (mit TLS) davorschalten oder gezielt an eine IP binden, z.B. eine Tailscale-IP (`"100.64.0.10:8484:8484"`).
|
|
|
|
### Umgebungsvariablen
|
|
|
|
| Variable | Standard | Beschreibung |
|
|
|----------|----------|-------------|
|
|
| `TZ` | — | Zeitzone (z.B. `Europe/Berlin`) |
|
|
| `PUID` / `PGID` | `1000` | UID/GID, unter der die Anwendung im Container läuft |
|
|
| `RECORDING_ROOTS` | `/app/data/recordings:/recordings` | Erlaubte Basisverzeichnisse für `download_path` (durch `:` getrennt) |
|
|
| `LOG_RETENTION_DAYS` | `90` | Log-Einträge älter als X Tage werden gelöscht |
|
|
| `ENABLE_API_DOCS` | — | `1` aktiviert die Swagger-UI unter `/docs` |
|
|
|
|
## Daten
|
|
|
|
Alle persistenten Daten liegen in einem einzigen Volume (`./data`):
|
|
|
|
| Pfad | Beschreibung |
|
|
|------|-------------|
|
|
| `data/config.yml` | Konfiguration (wird beim ersten Start automatisch erstellt, Rechte `600`) |
|
|
| `data/stream-recorder.db` | SQLite-Datenbank |
|
|
| `data/recordings/` | Aufnahmen (pro Job ein Unterordner) |
|
|
|
|
## Sicherheit
|
|
|
|
- **Anmeldung** — Basic Auth ist bei Neuinstallationen aktiv. Passwörter werden als PBKDF2-Hash gespeichert. Nach 10 fehlgeschlagenen Logins innerhalb von 5 Minuten wird die IP für den Rest des Zeitfensters gesperrt (HTTP 429).
|
|
- **Secrets** — Passwort, NTFY-Token und Plik-API-Key werden von der API nie zurückgegeben.
|
|
- **Kein Root** — Der Container startet als root, passt die Besitzrechte von `data/` an und startet die Anwendung dann als `PUID`/`PGID` (Standard `1000`). Der Anwendungscode ist für diesen User schreibgeschützt.
|
|
- **Eingaben** — Stream-URLs nur per `http(s)`, `rtmp(s)` und `rtsp(s)`; ffmpeg läuft mit Protokoll-Whitelist. Extra ffmpeg-Argumente unterliegen einer Allowlist (siehe [Jobs](docs/jobs.md#extra-ffmpeg-argumente)). `download_path` muss innerhalb von `RECORDING_ROOTS` liegen.
|
|
- **Web** — Kein CORS; schreibende Cross-Site-Requests werden abgewiesen (403). Security-Header und CSP sind gesetzt. Die Swagger-UI (`/docs`) ist standardmäßig deaktiviert.
|
|
- **Netzwerk** — Den Port nicht ungeschützt ins Internet stellen; Reverse-Proxy mit TLS oder VPN verwenden.
|
|
|
|
## Upgrade bestehender Installationen
|
|
|
|
- **Besitzrechte** — Beim Start werden `data/` und die Verzeichnisse aus `RECORDING_ROOTS` automatisch auf `PUID:PGID` umgestellt (nur Dateien mit abweichendem Besitzer). Soll ein anderer Host-User Besitzer sein, `PUID`/`PGID` setzen.
|
|
- **Anmeldung** — Die bisherige Auth-Einstellung bleibt erhalten. Ein Klartext-Passwort in `config.yml` wird beim Start automatisch in einen Hash umgewandelt.
|
|
- **Secrets rotieren** — Ältere Versionen haben NTFY-Token und Plik-API-Key über `/api/config` ausgeliefert. War die Instanz für andere erreichbar, diese Secrets erneuern.
|
|
- **Port-Bindung** — Die mitgelieferte `docker-compose.yml` bindet nur noch an `127.0.0.1`. Bei Bedarf anpassen (siehe oben).
|
|
- **download_path** — Liegt ein eigener Aufnahmepfad außerhalb von `/app/data/recordings` und `/recordings`, muss er in `RECORDING_ROOTS` aufgenommen werden.
|
|
- **Extra ffmpeg-Argumente** — Bestehende Jobs mit nicht erlaubten Argumenten müssen angepasst werden.
|
|
- **Laufende Aufnahmen** — Aufnahmen, die beim Neustart liefen, werden als Fehler „Abgebrochen durch Neustart" markiert.
|
|
|
|
## Multi-Arch Build
|
|
|
|
```bash
|
|
docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t stream-recorder:latest .
|
|
```
|
|
|
|
## Dokumentation
|
|
|
|
| Thema | Beschreibung |
|
|
|-------|-------------|
|
|
| [Jobs](docs/jobs.md) | Jobs erstellen, Zeitplanung, Schnellaufnahme |
|
|
| [Aufnahmen](docs/aufnahmen.md) | Verlängern, Stoppen, Reconnect, Segment-Splitting |
|
|
| [Plugins](docs/plugins.md) | NTFY, Plik-Upload, Metadata-Monitor |
|
|
| [Konfiguration](docs/konfiguration.md) | config.yml, alle Parameter |
|
|
| [API](docs/api.md) | REST-API Endpunkte |
|
|
|
|
<br><br>
|
|
<p align="center">
|
|
<img src="https://assets.techniverse.net/f1/git/graphics/gray0-catonline.svg" alt="">
|
|
</p>
|
|
|
|
<p align="center">
|
|
<sub>
|
|
© Patrick Asmus · Techniverse Network · <a href="./LICENSE">Lizenz</a>
|
|
</sub>
|
|
</p>
|