Release: v2.7.0 + Dokumentation ausgelagert

2026-09-07 12:54:53 +02:00
parent 7ddfb0e0d4
commit f3a8e20d7f
16 changed files with 1103 additions and 330 deletions
@@ -0,0 +1,103 @@
+# Befehle
+
+## Übersicht
+
+| Befehl               | Beschreibung                                    |
+|----------------------|-------------------------------------------------|
+| `record <job>`       | Einzelnen Stream aufzeichnen                    |
+| `record-all`         | Alle Jobs gleichzeitig aufzeichnen              |
+| `create`             | Neuen Job interaktiv erstellen                  |
+| `quick`              | Schnellaufnahme (URL direkt eingeben)           |
+| `upload <datei>`     | Vorhandene Datei nach Plik hochladen            |
+| `stop <name>`        | Aufnahme stoppen (Teilaufnahme wird hochgeladen)|
+| `stop-all`           | Alle Aufnahmen stoppen                          |
+| `list`               | Jobs und deren Zeitpläne anzeigen               |
+| `status`             | Laufende Aufnahmen mit Details anzeigen         |
+| `scheduler`          | Zeitplanung prüfen und Jobs starten/stoppen     |
+| `logs`               | Log-Ausgabe live verfolgen                      |
+
+## Optionen
+
+| Option                   | Beschreibung                          |
+|--------------------------|---------------------------------------|
+| `-c, --config <datei>`   | Alternative Konfigurationsdatei       |
+| `-V, --verbose`          | Ausführliche Ausgabe                  |
+| `--foreground`           | Aufnahme im Vordergrund ausführen     |
+| `-h, --help`             | Hilfe anzeigen                        |
+| `-v, --version`          | Version anzeigen                      |
+
+## Details
+
+### record
+
+Startet eine Aufnahme im Hintergrund (Standard) oder Vordergrund (`--foreground`).
+
+```bash
+./stream-recorder.sh record mein-stream
+./stream-recorder.sh --foreground record mein-stream
+./stream-recorder.sh -V record mein-stream
+```
+
+### create
+
+Erstellt interaktiv eine neue Job-Datei. Fragt nach URL, Name, Typ, Segment-Splitting, Zeitplan und Plik-Upload.
+
+```bash
+./stream-recorder.sh create
+```
+
+### quick
+
+Schnellaufnahme ohne Job-Datei. Fragt nach URL, Name, Typ und Dauer.
+
+```bash
+./stream-recorder.sh quick
+```
+
+### stop / stop-all
+
+Stoppt eine laufende Aufnahme. Wenn Plik aktiviert ist, wird die Teilaufnahme hochgeladen. Bei Segment-Splitting werden alle verbleibenden Segmente hochgeladen.
+
+```bash
+./stream-recorder.sh stop mein-stream
+./stream-recorder.sh stop-all
+```
+
+### status
+
+Zeigt detaillierte Informationen zu laufenden Aufnahmen:
+- Stream-Name und Typ
+- PID und Startmodus (manuell/geplant)
+- Startzeit und bisherige Laufzeit
+- Dateigröße bzw. Anzahl der Segmente und Gesamtgröße
+- Scheduler-Status (systemd-Timer)
+
+```bash
+./stream-recorder.sh status
+```
+
+### list
+
+Zeigt alle konfigurierten Jobs mit Status, Zeitplan, Segment-Einstellungen und Plik-Konfiguration.
+
+```bash
+./stream-recorder.sh list
+```
+
+### logs
+
+Verfolgt die Log-Ausgabe in Echtzeit (`tail -f`).
+
+```bash
+./stream-recorder.sh logs
+```
+
+## Logging
+
+Logs werden nach `LOG_DIR` geschrieben (Standard: `/var/log/stream-recorder/`):
+
+| Datei                      | Inhalt                          |
+|----------------------------|---------------------------------|
+| `stream-recorder.log`      | Alle Operationen des Scripts   |
+| `ffmpeg_<job-id>.log`      | ffmpeg-Ausgabe pro Job         |
+| `nohup_<job-id>.log`       | Ausgabe im Hintergrund-Modus  |