0.13.1-4 release snapshot

docs/getting-started/configuration.md

@@ -0,0 +1,71 @@
+# Ersteinrichtung
+
+Nach der Installation erfolgt die tägliche Konfiguration fast vollständig in der GUI unter `Settings`.
+
+## Ziel
+
+Vor dem ersten echten Job müssen Pfade, Tools und Metadatenzugriff sauber gesetzt sein.
+
+## Reihenfolge (empfohlen)
+
+### 1. `Settings` -> Tab `Konfiguration`
+
+Setze zuerst diese Pflichtwerte:
+
+| Bereich | Wichtige Felder |
+|---|---|
+| Pfade | `Raw Ausgabeordner`, `Film Ausgabeordner`, `Log Ordner` |
+| Tools | `MakeMKV Kommando`, `HandBrake Kommando`, `Mediainfo Kommando` |
+| Metadaten | `OMDb API Key`, optional `OMDb Typ` |
+
+Danach `Änderungen speichern`.
+
+### 2. Medienprofile prüfen
+
+Wenn du Blu-ray und DVD unterschiedlich behandeln willst, pflege die profilbezogenen Felder:
+
+- `*_bluray`
+- `*_dvd`
+- optional `*_other`
+
+Typische Beispiele:
+
+- `HandBrake Preset` (Blu-ray und DVD)
+- `Raw Ausgabeordner` (Blu-ray und DVD)
+- `Dateiname Template` (Blu-ray und DVD)
+
+### 3. Queue und Monitoring festlegen
+
+- `Parallele Jobs` für den gleichzeitigen Durchsatz
+- `Hardware Monitoring aktiviert` + `Hardware Monitoring Intervall (ms)` für Live-Metriken im Ripper
+
+### 4. Optional: Push-Benachrichtigungen
+
+In den Benachrichtigungsfeldern setzen:
+
+- `PushOver aktiviert`
+- `PushOver Token`
+- `PushOver User`
+
+Dann über `PushOver Test` direkt prüfen.
+
+## 2-Minuten-Funktionstest
+
+1. `Ripper` öffnen
+2. Disc einlegen
+3. `Analyse starten`
+4. Metadaten übernehmen
+5. Bis `Bereit zum Encodieren` laufen lassen
+
+Wenn diese Schritte funktionieren, ist die Grundkonfiguration korrekt.
+
+## Wenn Werte nicht gespeichert werden
+
+- Feld mit Fehler markieren lassen (rote Validierung im Formular)
+- Pfadangaben und numerische Werte prüfen
+- bei Tool-Pfaden direkt CLI-Aufruf im Terminal testen
+
+## Weiter
+
+- [Erster Lauf](quickstart.md)
+- [GUI-Seiten im Detail](../gui/index.md)

docs/getting-started/index.md

@@ -0,0 +1,33 @@
+# Benutzerhandbuch Überblick
+
+Dieses Kapitel ist für den **Betrieb von Ripster im Alltag** geschrieben.
+
+## Zielgruppe
+
+- Anwender, die Discs verarbeiten wollen
+- Betreiber, die den täglichen Ablauf stabil fahren möchten
+- Power-User, die Queue/Skripte/Cron im UI steuern möchten
+
+## Kapitelstruktur
+
+| Kapitel | Zweck |
+|---|---|
+| [Voraussetzungen](prerequisites.md) | Produktions- vs. Dev-Voraussetzungen klar trennen |
+| [Installation](installation.md) | Ripster aufsetzen und starten |
+| [Ersteinrichtung](configuration.md) | Pfade, Tools und Metadaten korrekt setzen |
+| [Erster Lauf](quickstart.md) | Ein kompletter Job von Disc bis Datei |
+| [GUI-Seiten](../gui/index.md) | Alle Ansichten und Aktionen im Detail |
+| [Workflows](../workflows/index.md) | Typische Abläufe und Entscheidungen aus User-Sicht |
+
+## Wenn du neu startest
+
+1. [Voraussetzungen](prerequisites.md)
+2. [Installation](installation.md)
+3. [Ersteinrichtung](configuration.md)
+4. [Erster Lauf](quickstart.md)
+
+## Wenn Ripster bereits läuft
+
+1. [GUI-Seiten](../gui/index.md)
+2. [Workflows](../workflows/index.md)
+3. Bei Detailfragen: [Technischer Anhang](../appendix/index.md)

docs/getting-started/installation.md

@@ -0,0 +1,109 @@
+# Installation
+
+Die empfohlene Installation läuft über `install.sh` und richtet Ripster vollständig ein.
+
+Du musst dafür **keine Tools manuell vorinstallieren**. Das Skript installiert die benötigten Abhängigkeiten automatisch, sofern sie nicht explizit mit `--no-*` übersprungen werden.
+
+## Unterstützte Systeme und Anforderungen
+
+- unterstützt laut Script: `debian`, `ubuntu`, `linuxmint`, `pop`
+- Ausführung als `root` (oder via `sudo`)
+- Internetzugang während der Installation
+
+## Schritt-für-Schritt
+
+### 1. Installationsskript herunterladen
+
+```bash
+wget -qO install.sh https://raw.githubusercontent.com/Mboehmlaender/ripster/main/install.sh
+```
+
+### 2. Installation ausführen
+
+```bash
+sudo bash install.sh
+```
+
+Während der Installation wählst du den HandBrake-Modus:
+
+- `1` Standard (Paketinstallation)
+- `2` GPU/NVDEC (gebündeltes Binary)
+
+### 3. Dienststatus prüfen
+
+```bash
+sudo systemctl status ripster-backend
+```
+
+### 4. Weboberfläche öffnen
+
+- mit nginx (Standard): `http://<Server-IP>`
+- ohne nginx (`--no-nginx`): API auf `http://<Server-IP>:3001/api`
+
+## Was `install.sh` konkret einrichtet
+
+1. prüft Betriebssystem, Root-Rechte und ermittelt Host/IP
+2. aktualisiert Paketquellen und installiert Basispakete (`curl`, `wget`, `git`, `mediainfo`, `udev` ...)
+3. installiert Node.js 20 (falls nicht passend vorhanden)
+4. installiert optional MakeMKV (Build aus den offiziellen Quellen)
+5. installiert optional HandBrakeCLI (Standard oder GPU/NVDEC)
+6. installiert optional nginx
+7. legt den Systembenutzer `ripster` an (ohne Login-Shell, ohne Home) und ergänzt Gruppen (`cdrom`, `optical`, `disk`, `video`, `render`, falls vorhanden)
+8. klont das Repository nach `/opt/ripster` (oder aktualisiert bei `--reinstall`)
+9. legt Verzeichnisse an:
+   - `/opt/ripster/backend/data`
+   - `/opt/ripster/backend/logs`
+   - `/opt/ripster/backend/data/output/raw`
+   - `/opt/ripster/backend/data/output/movies`
+   - `/opt/ripster/backend/data/logs`
+10. installiert npm-Abhängigkeiten (Root, Backend, Frontend) und baut das Frontend
+11. erzeugt `backend/.env` (bei `--reinstall` bleibt bestehende `.env` erhalten)
+12. setzt Rechte/Besitz und erstellt bei sudo-Installation zusätzlich `~/.MakeMKV` für den aufrufenden Benutzer
+13. erzeugt und startet `ripster-backend.service`
+14. konfiguriert und startet nginx (falls nicht übersprungen)
+
+## Wichtige Optionen
+
+| Option | Default laut Script | Zweck |
+|---|---|---|
+| `--branch <branch>` | `dev` | Branch für die Installation |
+| `--dir <pfad>` | `/opt/ripster` | Installationsverzeichnis |
+| `--user <benutzer>` | `ripster` | Service-Benutzer |
+| `--port <port>` | `3001` | Backend-Port |
+| `--host <hostname>` | automatisch ermittelte Host-IP | Hostname/IP für Webzugriff/CORS |
+| `--no-makemkv` | aus | MakeMKV-Installation überspringen |
+| `--no-handbrake` | aus | HandBrake-Installation überspringen |
+| `--no-nginx` | aus | nginx-Setup überspringen |
+| `--reinstall` | aus | bestehende Installation aktualisieren |
+
+Beispiele:
+
+```bash
+sudo bash install.sh --branch dev
+sudo bash install.sh --port 8080 --host ripster.local
+sudo bash install.sh --reinstall
+```
+
+## Betrieb im Alltag
+
+```bash
+# Logs live ansehen
+sudo journalctl -u ripster-backend -f
+
+# Dienst neu starten
+sudo systemctl restart ripster-backend
+
+# Update aus bestehender Installation
+sudo bash /opt/ripster/install.sh --reinstall
+```
+
+## Häufige Stolperstellen
+
+- Laufwerk nicht zugreifbar: Laufwerksrechte/Gruppen prüfen
+- CLI-Tool fehlt wegen `--no-*`: Tool nachinstallieren oder Befehl in Settings korrigieren
+- UI nicht erreichbar: nginx-Status und Firewall prüfen
+
+## Danach weiter
+
+1. [Ersteinrichtung](configuration.md)
+2. [Erster Lauf](quickstart.md)

docs/getting-started/prerequisites.md

@@ -0,0 +1,48 @@
+# Voraussetzungen
+
+Die Voraussetzungen hängen davon ab, **wie** du Ripster betreibst.
+
+## Produktionsbetrieb mit `install.sh` (Standard)
+
+Für den normalen Betrieb sind nur wenige Punkte vorab nötig.
+
+### Pflicht
+
+- unterstütztes Linux-System (laut Script: Debian, Ubuntu, Linux Mint, Pop!_OS)
+- `root`-Rechte
+- Internetzugang während der Installation
+- optisches Laufwerk für Disc-Betrieb
+
+`install.sh` installiert die benötigten Tools selbst (u. a. Node.js, MakeMKV, HandBrakeCLI, MediaInfo), sofern sie nicht explizit per `--no-*` übersprungen werden.
+
+### Laufwerk kurz prüfen
+
+```bash
+ls /dev/sr*
+lsblk | grep rom
+```
+
+Wenn nötig Rechte setzen (Beispiel):
+
+```bash
+sudo chmod a+rw /dev/sr0
+```
+
+### Optional vorab
+
+- OMDb API-Key (kann auch nach Installation in den `Settings` gesetzt werden)
+- PushOver-Zugangsdaten (optional)
+
+## Entwicklungsmodus (nur für Dev)
+
+Wenn du lokal entwickelst (`./start.sh`, `npm run dev`), gelten zusätzliche Voraussetzungen:
+
+- Node.js >= 20.19.0
+- `makemkvcon`, `HandBrakeCLI`, `mediainfo` im `PATH`
+
+Details: [Entwicklungsumgebung](../deployment/development.md)
+
+## Abschluss-Checkliste
+
+- [ ] Produktionsbetrieb: Linux + root + Internet + Laufwerk vorhanden
+- [ ] Dev-Modus (nur falls benötigt): Node.js und CLI-Tools verfügbar

docs/getting-started/quickstart.md

@@ -0,0 +1,70 @@
+# Erster Lauf
+
+Dieser Ablauf zeigt einen vollständigen Job aus Anwendersicht: von Disc-Erkennung bis fertiger Datei.
+
+## 1. Ripper öffnen und Disc einlegen
+
+Erwartung:
+
+- Status wechselt auf `Medium erkannt`
+- im Bereich `Disk-Information` sind Laufwerksdaten sichtbar
+
+Wenn nichts passiert: `Laufwerk neu lesen`.
+
+## 2. Analyse starten
+
+Aktion im Ripper:
+
+- `Analyse starten`
+
+Erwartung:
+
+- Status `Analyse`
+- danach Metadaten-Dialog
+
+## 3. Metadaten auswählen
+
+Im Dialog `Metadaten auswählen`:
+
+1. OMDb-Suche nutzen oder manuell eintragen
+2. passenden Treffer markieren
+3. `Auswahl übernehmen`
+
+## 4. Auf den nächsten Zustand reagieren
+
+- Normalfall ohne vorhandenes RAW: `Rippen` -> `Mediainfo-Pruefung` -> `Bereit zum Encodieren`
+- bei vorhandenem RAW: direkt `Mediainfo-Pruefung` -> `Bereit zum Encodieren`
+- bei unklarer Blu-ray-Playlist: `Warte auf Auswahl` (Playlist auswählen und übernehmen)
+
+## 5. Review in `Bereit zum Encodieren`
+
+Im aufgeklappten Job (`Pipeline-Status`):
+
+- Encode-Titel wählen
+- Audio-/Subtitle-Spuren prüfen
+- optional User-Preset auswählen
+- optional Pre-/Post-Skripte bzw. Ketten hinzufügen
+
+Dann `Encoding starten`.
+
+## 6. Encoding überwachen
+
+Während `Encodieren`:
+
+- Fortschritt + ETA im Ripper
+- Live-Log im `Pipeline-Status`
+- Queue- und Skript/Cron-Status parallel beobachtbar
+
+## 7. Ergebnis prüfen
+
+Bei `Fertig`:
+
+1. Seite `Historie` öffnen
+2. Job in Details öffnen
+3. Output-Pfad, Status und Log prüfen
+
+## Typische Folgeaktionen
+
+- Falsches OMDb-Match: in `Historie` -> `OMDb neu zuordnen`
+- Neue Encodierung aus RAW: `RAW neu encodieren`
+- Prüfung komplett neu aufbauen: `Review neu starten`