Initial commit mit MkDocs-Dokumentation
This commit is contained in:
222
docs/api/history.md
Normal file
222
docs/api/history.md
Normal file
@@ -0,0 +1,222 @@
|
||||
# History API
|
||||
|
||||
Endpunkte für die Job-Histoire, Dateimanagement und Orphan-Import.
|
||||
|
||||
---
|
||||
|
||||
## GET /api/history
|
||||
|
||||
Gibt eine Liste aller Jobs zurück, optional gefiltert.
|
||||
|
||||
**Query-Parameter:**
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
|----------|-----|-------------|
|
||||
| `status` | string | Filtert nach Status (z.B. `FINISHED`, `ERROR`) |
|
||||
| `search` | string | Sucht in Filmtiteln |
|
||||
|
||||
**Beispiel:**
|
||||
|
||||
```
|
||||
GET /api/history?status=FINISHED&search=Inception
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"jobs": [
|
||||
{
|
||||
"id": 42,
|
||||
"status": "FINISHED",
|
||||
"title": "Inception",
|
||||
"imdb_id": "tt1375666",
|
||||
"omdb_year": "2010",
|
||||
"omdb_type": "movie",
|
||||
"omdb_poster": "https://...",
|
||||
"raw_path": "/mnt/nas/raw/Inception_t00.mkv",
|
||||
"output_path": "/mnt/nas/movies/Inception (2010).mkv",
|
||||
"created_at": "2024-01-15T10:00:00.000Z",
|
||||
"updated_at": "2024-01-15T12:30:00.000Z"
|
||||
}
|
||||
],
|
||||
"total": 1
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## GET /api/history/:id
|
||||
|
||||
Gibt Detail-Informationen für einen einzelnen Job zurück.
|
||||
|
||||
**URL-Parameter:** `id` – Job-ID
|
||||
|
||||
**Query-Parameter:**
|
||||
|
||||
| Parameter | Typ | Standard | Beschreibung |
|
||||
|----------|-----|---------|-------------|
|
||||
| `includeLogs` | boolean | `false` | Log-Inhalte einschließen |
|
||||
| `includeLiveLog` | boolean | `false` | Aktuellen Live-Log einschließen |
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 42,
|
||||
"status": "FINISHED",
|
||||
"title": "Inception",
|
||||
"imdb_id": "tt1375666",
|
||||
"encode_plan": { ... },
|
||||
"makemkv_output": { ... },
|
||||
"mediainfo_output": { ... },
|
||||
"handbrake_log": "/path/to/log",
|
||||
"logs": {
|
||||
"handbrake": "Encoding: task 1 of 1, 100.0%\n..."
|
||||
},
|
||||
"created_at": "2024-01-15T10:00:00.000Z",
|
||||
"updated_at": "2024-01-15T12:30:00.000Z"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## GET /api/history/database
|
||||
|
||||
Gibt alle rohen Datenbankzeilen zurück (Debug-Ansicht).
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"jobs": [ { "id": 1, "status": "FINISHED", ... } ],
|
||||
"total": 15
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## GET /api/history/orphan-raw
|
||||
|
||||
Findet Raw-Ordner, die nicht als Jobs in der Datenbank registriert sind.
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"orphans": [
|
||||
{
|
||||
"path": "/mnt/nas/raw/UnknownMovie_2023-12-01",
|
||||
"size": "45.2 GB",
|
||||
"modifiedAt": "2023-12-01T15:00:00.000Z",
|
||||
"files": ["t00.mkv", "t01.mkv"]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## POST /api/history/orphan-raw/import
|
||||
|
||||
Importiert einen Orphan-Raw-Ordner als Job in die Datenbank.
|
||||
|
||||
**Request:**
|
||||
|
||||
```json
|
||||
{
|
||||
"path": "/mnt/nas/raw/UnknownMovie_2023-12-01"
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"ok": true,
|
||||
"jobId": 99,
|
||||
"message": "Orphan-Ordner als Job importiert"
|
||||
}
|
||||
```
|
||||
|
||||
Nach dem Import kann dem Job über `/api/history/:id/omdb/assign` Metadaten zugewiesen werden.
|
||||
|
||||
---
|
||||
|
||||
## POST /api/history/:id/omdb/assign
|
||||
|
||||
Weist einem bestehenden Job OMDb-Metadaten nachträglich zu.
|
||||
|
||||
**URL-Parameter:** `id` – Job-ID
|
||||
|
||||
**Request:**
|
||||
|
||||
```json
|
||||
{
|
||||
"imdbId": "tt1375666",
|
||||
"title": "Inception",
|
||||
"year": "2010",
|
||||
"type": "movie",
|
||||
"poster": "https://..."
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{ "ok": true }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## POST /api/history/:id/delete-files
|
||||
|
||||
Löscht die Dateien eines Jobs (Raw und/oder Output), behält den Job-Eintrag.
|
||||
|
||||
**URL-Parameter:** `id` – Job-ID
|
||||
|
||||
**Request:**
|
||||
|
||||
```json
|
||||
{
|
||||
"deleteRaw": true,
|
||||
"deleteOutput": false
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"ok": true,
|
||||
"deleted": {
|
||||
"raw": "/mnt/nas/raw/Inception_t00.mkv",
|
||||
"output": null
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## POST /api/history/:id/delete
|
||||
|
||||
Löscht den Job-Eintrag aus der Datenbank, optional auch die Dateien.
|
||||
|
||||
**URL-Parameter:** `id` – Job-ID
|
||||
|
||||
**Request:**
|
||||
|
||||
```json
|
||||
{
|
||||
"deleteFiles": true
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{ "ok": true, "message": "Job gelöscht" }
|
||||
```
|
||||
|
||||
!!! warning "Unwiderruflich"
|
||||
Das Löschen von Jobs und Dateien ist nicht rückgängig zu machen.
|
||||
85
docs/api/index.md
Normal file
85
docs/api/index.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# API-Referenz
|
||||
|
||||
Ripster bietet eine **REST-API** für alle Operationen sowie einen **WebSocket-Endpunkt** für Echtzeit-Updates.
|
||||
|
||||
---
|
||||
|
||||
## Basis-URL
|
||||
|
||||
```
|
||||
http://localhost:3001
|
||||
```
|
||||
|
||||
Konfigurierbar über die Umgebungsvariable `PORT`.
|
||||
|
||||
---
|
||||
|
||||
## API-Gruppen
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-pipe: **Pipeline API**
|
||||
|
||||
---
|
||||
|
||||
Pipeline-Steuerung: Analyse starten, Metadaten setzen, Ripping und Encoding steuern.
|
||||
|
||||
[:octicons-arrow-right-24: Pipeline API](pipeline.md)
|
||||
|
||||
- :material-cog: **Settings API**
|
||||
|
||||
---
|
||||
|
||||
Einstellungen lesen und schreiben.
|
||||
|
||||
[:octicons-arrow-right-24: Settings API](settings.md)
|
||||
|
||||
- :material-history: **History API**
|
||||
|
||||
---
|
||||
|
||||
Job-Geschichte abfragen, Jobs löschen, Orphan-Ordner importieren.
|
||||
|
||||
[:octicons-arrow-right-24: History API](history.md)
|
||||
|
||||
- :material-lightning-bolt: **WebSocket Events**
|
||||
|
||||
---
|
||||
|
||||
Echtzeit-Events für Pipeline-Status, Fortschritt und Disc-Erkennung.
|
||||
|
||||
[:octicons-arrow-right-24: WebSocket](websocket.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Authentifizierung
|
||||
|
||||
Die API hat **keine Authentifizierung**. Sie ist für den Einsatz im lokalen Netzwerk konzipiert.
|
||||
|
||||
!!! warning "Produktionsbetrieb"
|
||||
Falls Ripster öffentlich erreichbar sein soll, schütze die API mit einem Reverse-Proxy (z. B. nginx mit Basic Auth oder OAuth).
|
||||
|
||||
---
|
||||
|
||||
## Fehlerformat
|
||||
|
||||
Alle API-Fehler werden im folgenden Format zurückgegeben:
|
||||
|
||||
```json
|
||||
{
|
||||
"error": "Job nicht gefunden",
|
||||
"details": "Kein Job mit ID 999 vorhanden"
|
||||
}
|
||||
```
|
||||
|
||||
HTTP-Statuscodes:
|
||||
|
||||
| Code | Bedeutung |
|
||||
|-----|-----------|
|
||||
| `200` | Erfolg |
|
||||
| `400` | Ungültige Anfrage |
|
||||
| `404` | Ressource nicht gefunden |
|
||||
| `409` | Konflikt (z.B. Pipeline bereits aktiv) |
|
||||
| `500` | Interner Serverfehler |
|
||||
249
docs/api/pipeline.md
Normal file
249
docs/api/pipeline.md
Normal file
@@ -0,0 +1,249 @@
|
||||
# Pipeline API
|
||||
|
||||
Alle Endpunkte zur Steuerung des Ripping-Workflows.
|
||||
|
||||
---
|
||||
|
||||
## GET /api/pipeline/state
|
||||
|
||||
Gibt den aktuellen Pipeline-Zustand zurück.
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"state": "ENCODING",
|
||||
"jobId": 42,
|
||||
"job": {
|
||||
"id": 42,
|
||||
"title": "Inception",
|
||||
"status": "ENCODING",
|
||||
"imdb_id": "tt1375666",
|
||||
"omdb_year": "2010"
|
||||
},
|
||||
"progress": 73.5,
|
||||
"eta": "00:12:34",
|
||||
"updatedAt": "2024-01-15T14:30:00.000Z"
|
||||
}
|
||||
```
|
||||
|
||||
**States:**
|
||||
|
||||
| Wert | Beschreibung |
|
||||
|------|-------------|
|
||||
| `IDLE` | Wartet auf Disc |
|
||||
| `ANALYZING` | MakeMKV analysiert |
|
||||
| `METADATA_SELECTION` | Wartet auf Benutzer |
|
||||
| `READY_TO_START` | Bereit zum Starten |
|
||||
| `RIPPING` | Rippen läuft |
|
||||
| `MEDIAINFO_CHECK` | Track-Analyse |
|
||||
| `READY_TO_ENCODE` | Wartet auf Bestätigung |
|
||||
| `ENCODING` | Encoding läuft |
|
||||
| `FINISHED` | Abgeschlossen |
|
||||
| `ERROR` | Fehler |
|
||||
|
||||
---
|
||||
|
||||
## POST /api/pipeline/analyze
|
||||
|
||||
Startet eine manuelle Disc-Analyse (ohne Disc-Detection-Trigger).
|
||||
|
||||
**Request:** Kein Body erforderlich
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{ "ok": true, "message": "Analyse gestartet" }
|
||||
```
|
||||
|
||||
**Fehlerfälle:**
|
||||
- `409` – Pipeline bereits aktiv
|
||||
|
||||
---
|
||||
|
||||
## POST /api/pipeline/rescan-disc
|
||||
|
||||
Erzwingt eine erneute Disc-Erkennung.
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{ "ok": true }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## GET /api/pipeline/omdb/search
|
||||
|
||||
Sucht in der OMDb-API nach einem Filmtitel.
|
||||
|
||||
**Query-Parameter:**
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
|----------|-----|-------------|
|
||||
| `q` | string | Suchbegriff (Filmtitel) |
|
||||
| `type` | string | `movie` oder `series` (optional) |
|
||||
|
||||
**Beispiel:**
|
||||
|
||||
```
|
||||
GET /api/pipeline/omdb/search?q=Inception&type=movie
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"imdbId": "tt1375666",
|
||||
"title": "Inception",
|
||||
"year": "2010",
|
||||
"type": "movie",
|
||||
"poster": "https://m.media-amazon.com/images/..."
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## POST /api/pipeline/select-metadata
|
||||
|
||||
Bestätigt Metadaten und Playlist-Auswahl für den aktuellen Job.
|
||||
|
||||
**Request:**
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": 42,
|
||||
"omdb": {
|
||||
"imdbId": "tt1375666",
|
||||
"title": "Inception",
|
||||
"year": "2010",
|
||||
"type": "movie",
|
||||
"poster": "https://..."
|
||||
},
|
||||
"playlist": "00800.mpls"
|
||||
}
|
||||
```
|
||||
|
||||
`playlist` ist optional und nur bei Blu-rays relevant.
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{ "ok": true }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## POST /api/pipeline/start/:jobId
|
||||
|
||||
Startet den Ripping-Prozess für einen vorbereiteten Job.
|
||||
|
||||
**URL-Parameter:** `jobId` – ID des Jobs
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{ "ok": true, "message": "Ripping gestartet" }
|
||||
```
|
||||
|
||||
**Fehlerfälle:**
|
||||
- `404` – Job nicht gefunden
|
||||
- `409` – Job nicht im Status `READY_TO_START`
|
||||
|
||||
---
|
||||
|
||||
## POST /api/pipeline/confirm-encode/:jobId
|
||||
|
||||
Bestätigt die Encode-Konfiguration mit Track-Auswahl.
|
||||
|
||||
**URL-Parameter:** `jobId` – ID des Jobs
|
||||
|
||||
**Request:**
|
||||
|
||||
```json
|
||||
{
|
||||
"audioTracks": [1, 2],
|
||||
"subtitleTracks": [1]
|
||||
}
|
||||
```
|
||||
|
||||
Track-Indizes entsprechen den 1-basierten Track-Nummern aus dem Encode-Plan.
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{ "ok": true, "message": "Encoding gestartet" }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## POST /api/pipeline/cancel
|
||||
|
||||
Bricht den aktuellen Pipeline-Prozess ab.
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{ "ok": true, "message": "Pipeline abgebrochen" }
|
||||
```
|
||||
|
||||
Der laufende Prozess wird mit SIGINT beendet (Fallback: SIGKILL nach Timeout).
|
||||
|
||||
---
|
||||
|
||||
## POST /api/pipeline/retry/:jobId
|
||||
|
||||
Wiederholt einen fehlgeschlagenen Job.
|
||||
|
||||
**URL-Parameter:** `jobId` – ID des Jobs
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{ "ok": true, "message": "Job wird wiederholt" }
|
||||
```
|
||||
|
||||
**Fehlerfälle:**
|
||||
- `404` – Job nicht gefunden
|
||||
- `409` – Job nicht im Status `ERROR`
|
||||
|
||||
---
|
||||
|
||||
## POST /api/pipeline/resume-ready/:jobId
|
||||
|
||||
Setzt einen Job im Status `READY_TO_ENCODE` zurück in die aktive Pipeline.
|
||||
|
||||
**URL-Parameter:** `jobId` – ID des Jobs
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{ "ok": true }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## POST /api/pipeline/reencode/:jobId
|
||||
|
||||
Startet ein erneutes Encoding für einen abgeschlossenen Job (ohne erneutes Ripping).
|
||||
|
||||
**URL-Parameter:** `jobId` – ID des Jobs
|
||||
|
||||
**Request:**
|
||||
|
||||
```json
|
||||
{
|
||||
"audioTracks": [1, 2],
|
||||
"subtitleTracks": [1]
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{ "ok": true, "message": "Re-Encoding gestartet" }
|
||||
```
|
||||
140
docs/api/settings.md
Normal file
140
docs/api/settings.md
Normal file
@@ -0,0 +1,140 @@
|
||||
# Settings API
|
||||
|
||||
Endpunkte zum Lesen und Schreiben der Anwendungseinstellungen.
|
||||
|
||||
---
|
||||
|
||||
## GET /api/settings
|
||||
|
||||
Gibt alle Einstellungen kategorisiert zurück.
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"paths": {
|
||||
"raw_dir": {
|
||||
"value": "/mnt/nas/raw",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"label": "Raw-Verzeichnis",
|
||||
"description": "Speicherort für rohe MKV-Dateien",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"movie_dir": {
|
||||
"value": "/mnt/nas/movies",
|
||||
"schema": { ... }
|
||||
}
|
||||
},
|
||||
"tools": { ... },
|
||||
"encoding": { ... },
|
||||
"drive": { ... },
|
||||
"makemkv": { ... },
|
||||
"omdb": { ... },
|
||||
"notifications": { ... }
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## PUT /api/settings/:key
|
||||
|
||||
Aktualisiert eine einzelne Einstellung.
|
||||
|
||||
**URL-Parameter:** `key` – Einstellungs-Schlüssel
|
||||
|
||||
**Request:**
|
||||
|
||||
```json
|
||||
{
|
||||
"value": "/mnt/storage/raw"
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{ "ok": true, "key": "raw_dir", "value": "/mnt/storage/raw" }
|
||||
```
|
||||
|
||||
**Fehlerfälle:**
|
||||
- `400` – Ungültiger Wert (Validierungsfehler)
|
||||
- `404` – Einstellung nicht gefunden
|
||||
|
||||
!!! note "Encode-Review-Refresh"
|
||||
Wenn eine encoding-relevante Einstellung geändert wird (z.B. `handbrake_preset`), wird der Encode-Plan für den aktuell wartenden Job automatisch neu berechnet.
|
||||
|
||||
---
|
||||
|
||||
## PUT /api/settings
|
||||
|
||||
Aktualisiert mehrere Einstellungen auf einmal.
|
||||
|
||||
**Request:**
|
||||
|
||||
```json
|
||||
{
|
||||
"raw_dir": "/mnt/storage/raw",
|
||||
"movie_dir": "/mnt/storage/movies",
|
||||
"handbrake_preset": "H.265 MKV 720p30"
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"ok": true,
|
||||
"updated": ["raw_dir", "movie_dir", "handbrake_preset"],
|
||||
"errors": []
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## POST /api/settings/pushover/test
|
||||
|
||||
Sendet eine Test-Benachrichtigung über PushOver.
|
||||
|
||||
**Request:** Kein Body erforderlich (verwendet gespeicherte Zugangsdaten)
|
||||
|
||||
**Response (Erfolg):**
|
||||
|
||||
```json
|
||||
{ "ok": true, "message": "Test-Benachrichtigung gesendet" }
|
||||
```
|
||||
|
||||
**Response (Fehler):**
|
||||
|
||||
```json
|
||||
{ "ok": false, "error": "Ungültiger API-Token" }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Einstellungs-Schlüssel Referenz
|
||||
|
||||
Eine vollständige Liste aller Einstellungs-Schlüssel:
|
||||
|
||||
| Schlüssel | Kategorie | Typ | Beschreibung |
|
||||
|---------|----------|-----|-------------|
|
||||
| `raw_dir` | paths | string | Raw-MKV Verzeichnis |
|
||||
| `movie_dir` | paths | string | Ausgabe-Verzeichnis |
|
||||
| `log_dir` | paths | string | Log-Verzeichnis |
|
||||
| `makemkv_command` | tools | string | MakeMKV-Befehl |
|
||||
| `handbrake_command` | tools | string | HandBrake-Befehl |
|
||||
| `mediainfo_command` | tools | string | MediaInfo-Befehl |
|
||||
| `handbrake_preset` | encoding | string | HandBrake-Preset-Name |
|
||||
| `handbrake_extra_args` | encoding | string | Zusatz-Argumente |
|
||||
| `output_extension` | encoding | string | Dateiendung (z.B. `mkv`) |
|
||||
| `filename_template` | encoding | string | Dateiname-Template |
|
||||
| `drive_mode` | drive | select | `auto` oder `explicit` |
|
||||
| `drive_device` | drive | string | Geräte-Pfad |
|
||||
| `disc_poll_interval_ms` | drive | number | Polling-Intervall (ms) |
|
||||
| `makemkv_min_length_minutes` | makemkv | number | Min. Titellänge (Minuten) |
|
||||
| `makemkv_backup_mode` | makemkv | boolean | Backup-Modus aktivieren |
|
||||
| `omdb_api_key` | omdb | string | OMDb API-Key |
|
||||
| `omdb_default_type` | omdb | select | Standard-Suchtyp |
|
||||
| `pushover_user_key` | notifications | string | PushOver User-Key |
|
||||
| `pushover_api_token` | notifications | string | PushOver API-Token |
|
||||
225
docs/api/websocket.md
Normal file
225
docs/api/websocket.md
Normal file
@@ -0,0 +1,225 @@
|
||||
# WebSocket Events
|
||||
|
||||
Ripster verwendet WebSockets für Echtzeit-Updates. Der Endpunkt ist `/ws`.
|
||||
|
||||
---
|
||||
|
||||
## Verbindung
|
||||
|
||||
```js
|
||||
const ws = new WebSocket('ws://localhost:3001/ws');
|
||||
|
||||
ws.onmessage = (event) => {
|
||||
const message = JSON.parse(event.data);
|
||||
console.log(message.type, message.data);
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Nachrichten-Format
|
||||
|
||||
Alle Nachrichten folgen diesem Schema:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "EVENT_TYPE",
|
||||
"data": { ... }
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Event-Typen
|
||||
|
||||
### PIPELINE_STATE_CHANGE
|
||||
|
||||
Wird gesendet, wenn der Pipeline-Zustand wechselt.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "PIPELINE_STATE_CHANGE",
|
||||
"data": {
|
||||
"state": "ENCODING",
|
||||
"jobId": 42,
|
||||
"job": {
|
||||
"id": 42,
|
||||
"title": "Inception",
|
||||
"status": "ENCODING"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### PROGRESS_UPDATE
|
||||
|
||||
Wird während aktiver Prozesse (Ripping/Encoding) regelmäßig gesendet.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "PROGRESS_UPDATE",
|
||||
"data": {
|
||||
"progress": 73.5,
|
||||
"eta": "00:12:34",
|
||||
"speed": "45.2 fps",
|
||||
"phase": "ENCODING"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Felder:**
|
||||
|
||||
| Feld | Typ | Beschreibung |
|
||||
|-----|-----|-------------|
|
||||
| `progress` | number | Fortschritt 0–100 |
|
||||
| `eta` | string | Geschätzte Restzeit (`HH:MM:SS`) |
|
||||
| `speed` | string | Encoding-Geschwindigkeit (nur beim Encoding) |
|
||||
| `phase` | string | Aktuelle Phase (`RIPPING` oder `ENCODING`) |
|
||||
|
||||
---
|
||||
|
||||
### DISC_DETECTED
|
||||
|
||||
Wird gesendet, wenn eine Disc erkannt wird.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "DISC_DETECTED",
|
||||
"data": {
|
||||
"device": "/dev/sr0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### DISC_REMOVED
|
||||
|
||||
Wird gesendet, wenn eine Disc ausgeworfen wird.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "DISC_REMOVED",
|
||||
"data": {
|
||||
"device": "/dev/sr0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### JOB_COMPLETE
|
||||
|
||||
Wird gesendet, wenn ein Job erfolgreich abgeschlossen wurde.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "JOB_COMPLETE",
|
||||
"data": {
|
||||
"jobId": 42,
|
||||
"title": "Inception",
|
||||
"outputPath": "/mnt/nas/movies/Inception (2010).mkv"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### ERROR
|
||||
|
||||
Wird gesendet, wenn ein Fehler aufgetreten ist.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "ERROR",
|
||||
"data": {
|
||||
"jobId": 42,
|
||||
"message": "HandBrake ist abgestürzt",
|
||||
"details": "Exit code: 1\nStderr: ..."
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### METADATA_REQUIRED
|
||||
|
||||
Wird gesendet, wenn Benutzer-Eingabe für Metadaten benötigt wird.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "METADATA_REQUIRED",
|
||||
"data": {
|
||||
"jobId": 42,
|
||||
"makemkvData": { ... },
|
||||
"playlistAnalysis": { ... }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### ENCODE_REVIEW_REQUIRED
|
||||
|
||||
Wird gesendet, wenn der Benutzer den Encode-Plan bestätigen soll.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "ENCODE_REVIEW_REQUIRED",
|
||||
"data": {
|
||||
"jobId": 42,
|
||||
"encodePlan": {
|
||||
"audioTracks": [ ... ],
|
||||
"subtitleTracks": [ ... ]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Reconnect-Verhalten
|
||||
|
||||
Der Frontend-Hook `useWebSocket.js` implementiert automatisches Reconnect:
|
||||
|
||||
```
|
||||
Verbindung verloren
|
||||
↓
|
||||
Warte 1s → Reconnect-Versuch
|
||||
↓ (Fehlschlag)
|
||||
Warte 2s → Reconnect-Versuch
|
||||
↓ (Fehlschlag)
|
||||
Warte 4s → ...
|
||||
↓
|
||||
Max. 30s Wartezeit
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Beispiel: React-Hook
|
||||
|
||||
```js
|
||||
import { useEffect, useState } from 'react';
|
||||
|
||||
function usePipelineState() {
|
||||
const [state, setState] = useState({ state: 'IDLE' });
|
||||
|
||||
useEffect(() => {
|
||||
const ws = new WebSocket(import.meta.env.VITE_WS_URL + '/ws');
|
||||
|
||||
ws.onmessage = (event) => {
|
||||
const msg = JSON.parse(event.data);
|
||||
|
||||
if (msg.type === 'PIPELINE_STATE_CHANGE') {
|
||||
setState(msg.data);
|
||||
}
|
||||
};
|
||||
|
||||
return () => ws.close();
|
||||
}, []);
|
||||
|
||||
return state;
|
||||
}
|
||||
```
|
||||
221
docs/architecture/backend.md
Normal file
221
docs/architecture/backend.md
Normal file
@@ -0,0 +1,221 @@
|
||||
# Backend-Services
|
||||
|
||||
Das Backend ist in Node.js/Express geschrieben und in **Services** aufgeteilt, die jeweils eine klar abgegrenzte Verantwortlichkeit haben.
|
||||
|
||||
---
|
||||
|
||||
## pipelineService.js
|
||||
|
||||
**Der Kern von Ripster** – orchestriert den gesamten Ripping-Workflow.
|
||||
|
||||
### Zuständigkeiten
|
||||
|
||||
- Verwaltung des Pipeline-Zustands als State Machine
|
||||
- Koordination zwischen allen externen Tools
|
||||
- Generierung von Encode-Plänen
|
||||
- Fehlerbehandlung und Recovery
|
||||
|
||||
### Haupt-Methoden
|
||||
|
||||
| Methode | Beschreibung |
|
||||
|---------|-------------|
|
||||
| `analyzeDisc()` | Startet MakeMKV-Analyse der eingelegten Disc |
|
||||
| `selectMetadata(jobId, omdbData, playlist)` | Setzt Metadaten und Playlist für einen Job |
|
||||
| `startJob(jobId)` | Startet den Ripping-Prozess |
|
||||
| `confirmEncode(jobId, trackSelection)` | Bestätigt Encode mit Track-Auswahl |
|
||||
| `cancelPipeline()` | Bricht aktiven Prozess ab |
|
||||
| `retryJob(jobId)` | Wiederholt fehlgeschlagenen Job |
|
||||
| `reencodeJob(jobId)` | Encodiert bestehende Raw-MKV neu |
|
||||
|
||||
### Zustandsübergänge
|
||||
|
||||
```mermaid
|
||||
stateDiagram-v2
|
||||
[*] --> IDLE
|
||||
IDLE --> ANALYZING: analyzeDisc()
|
||||
ANALYZING --> METADATA_SELECTION: MakeMKV fertig
|
||||
METADATA_SELECTION --> READY_TO_START: selectMetadata()
|
||||
READY_TO_START --> RIPPING: startJob()
|
||||
RIPPING --> MEDIAINFO_CHECK: MKV erstellt
|
||||
MEDIAINFO_CHECK --> READY_TO_ENCODE: Tracks analysiert
|
||||
READY_TO_ENCODE --> ENCODING: confirmEncode()
|
||||
ENCODING --> FINISHED: HandBrake fertig
|
||||
ENCODING --> ERROR: Fehler
|
||||
RIPPING --> ERROR: Fehler
|
||||
ERROR --> IDLE: retryJob() / cancel
|
||||
FINISHED --> IDLE: cancel / neue Disc
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## diskDetectionService.js
|
||||
|
||||
Überwacht das Disc-Laufwerk auf Disc-Einleger- und Auswurf-Ereignisse.
|
||||
|
||||
### Modi
|
||||
|
||||
| Modus | Beschreibung |
|
||||
|------|-------------|
|
||||
| `auto` | Erkennt verfügbare Laufwerke automatisch |
|
||||
| `explicit` | Überwacht ein bestimmtes Gerät (z.B. `/dev/sr0`) |
|
||||
|
||||
### Polling
|
||||
|
||||
Der Service pollt das Laufwerk im konfigurierten Intervall (`disc_poll_interval_ms`, Standard: 5000ms) und emittiert Events:
|
||||
|
||||
```js
|
||||
// Ereignisse
|
||||
emit('disc-detected', { device: '/dev/sr0' })
|
||||
emit('disc-removed', { device: '/dev/sr0' })
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## processRunner.js
|
||||
|
||||
Verwaltet externe CLI-Prozesse.
|
||||
|
||||
### Features
|
||||
|
||||
- **Streaming**: stdout/stderr werden zeilenweise gelesen
|
||||
- **Progress-Callbacks**: Ermöglicht Echtzeit-Fortschrittsanzeige
|
||||
- **Graceful Shutdown**: SIGINT → Warte-Timeout → SIGKILL
|
||||
- **Prozess-Registry**: Verfolgt aktive Prozesse für sauberes Beenden
|
||||
|
||||
### Nutzung
|
||||
|
||||
```js
|
||||
const result = await runProcess(
|
||||
'HandBrakeCLI',
|
||||
['--input', rawFile, '--output', outputFile, '--preset', preset],
|
||||
{
|
||||
onStderr: (line) => parseHandBrakeProgress(line),
|
||||
onStdout: (line) => logger.debug(line)
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## websocketService.js
|
||||
|
||||
WebSocket-Server für Echtzeit-Client-Kommunikation.
|
||||
|
||||
### Betrieb
|
||||
|
||||
- Läuft auf Pfad `/ws` des Express-Servers
|
||||
- Hält eine Registry aller verbundenen Clients
|
||||
- Ermöglicht Broadcast an alle Clients oder gezieltes Senden
|
||||
|
||||
### API
|
||||
|
||||
```js
|
||||
broadcast({ type: 'PIPELINE_STATE_CHANGE', data: { state, jobId } });
|
||||
broadcast({ type: 'PROGRESS_UPDATE', data: { progress, eta } });
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## omdbService.js
|
||||
|
||||
Integration mit der [OMDb API](https://www.omdbapi.com/).
|
||||
|
||||
### Methoden
|
||||
|
||||
| Methode | Beschreibung |
|
||||
|---------|-------------|
|
||||
| `searchByTitle(title, type)` | Suche nach Titel (movie/series) |
|
||||
| `fetchById(imdbId)` | Vollständige Metadaten per IMDb-ID |
|
||||
|
||||
### Zurückgegebene Daten
|
||||
|
||||
```json
|
||||
{
|
||||
"imdbId": "tt1375666",
|
||||
"title": "Inception",
|
||||
"year": "2010",
|
||||
"type": "movie",
|
||||
"poster": "https://...",
|
||||
"plot": "...",
|
||||
"director": "Christopher Nolan"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## settingsService.js
|
||||
|
||||
Verwaltet alle Anwendungseinstellungen.
|
||||
|
||||
### Features
|
||||
|
||||
- **Schema-getriebene Validierung**: Jede Einstellung hat Typ, Grenzen und Pflichtfeld-Flag
|
||||
- **Kategorisierung**: Einstellungen sind in Kategorien gruppiert (Paths, Tools, Encoding, ...)
|
||||
- **Persistenz**: Werte in SQLite, Schema ebenfalls in SQLite
|
||||
- **Defaults**: `defaultSettings.js` definiert Standardwerte
|
||||
|
||||
### Einstellungs-Kategorien
|
||||
|
||||
| Kategorie | Einstellungen |
|
||||
|-----------|--------------|
|
||||
| `paths` | `raw_dir`, `movie_dir`, `log_dir` |
|
||||
| `tools` | `makemkv_command`, `handbrake_command`, `mediainfo_command` |
|
||||
| `encoding` | `handbrake_preset`, `handbrake_extra_args`, `output_extension`, `filename_template` |
|
||||
| `drive` | `drive_mode`, `drive_device`, `disc_poll_interval_ms` |
|
||||
| `makemkv` | `makemkv_min_length_minutes`, `makemkv_backup_mode` |
|
||||
| `omdb` | `omdb_api_key`, `omdb_default_type` |
|
||||
| `notifications` | `pushover_user_key`, `pushover_api_token` |
|
||||
|
||||
---
|
||||
|
||||
## historyService.js
|
||||
|
||||
Datenbankoperationen für Job-Historie.
|
||||
|
||||
### Hauptoperationen
|
||||
|
||||
| Operation | Beschreibung |
|
||||
|-----------|-------------|
|
||||
| `listJobs(filters)` | Jobs nach Status/Titel filtern |
|
||||
| `getJob(id)` | Job-Details mit Logs abrufen |
|
||||
| `findOrphanRawFolders()` | Nicht-getrackte Raw-Ordner finden |
|
||||
| `importOrphanRaw(path)` | Orphan-Ordner als Job importieren |
|
||||
| `assignOmdb(id, omdbData)` | OMDb-Metadaten nachträglich zuweisen |
|
||||
| `deleteJob(id, deleteFiles)` | Job und optional Dateien löschen |
|
||||
|
||||
---
|
||||
|
||||
## notificationService.js
|
||||
|
||||
PushOver-Push-Benachrichtigungen.
|
||||
|
||||
```js
|
||||
await notify({
|
||||
title: 'Ripster: Job abgeschlossen',
|
||||
message: 'Inception (2010) wurde erfolgreich encodiert'
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## logger.js
|
||||
|
||||
Strukturiertes Logging mit täglicher Log-Rotation.
|
||||
|
||||
### Log-Level
|
||||
|
||||
| Level | Verwendung |
|
||||
|-------|-----------|
|
||||
| `debug` | Detaillierte Entwicklungs-Informationen |
|
||||
| `info` | Normale Betriebsereignisse |
|
||||
| `warn` | Warnungen, die Aufmerksamkeit benötigen |
|
||||
| `error` | Fehler, die den Betrieb beeinträchtigen |
|
||||
|
||||
### Log-Dateien
|
||||
|
||||
```
|
||||
logs/
|
||||
├── ripster-2024-01-15.log ← Tages-Log
|
||||
└── jobs/
|
||||
└── job-42-handbrake.log ← Prozess-spezifische Logs
|
||||
```
|
||||
161
docs/architecture/database.md
Normal file
161
docs/architecture/database.md
Normal file
@@ -0,0 +1,161 @@
|
||||
# Datenbank
|
||||
|
||||
Ripster verwendet **SQLite3** als Datenbank. Die Datenbankdatei liegt unter `backend/data/ripster.db`.
|
||||
|
||||
---
|
||||
|
||||
## Schema-Übersicht
|
||||
|
||||
```sql
|
||||
-- Vier Haupt-Tabellen
|
||||
settings_schema -- Einstellungs-Definitionen
|
||||
settings_values -- Benutzer-Werte
|
||||
jobs -- Rip-Job-Datensätze
|
||||
pipeline_state -- Aktueller Pipeline-Zustand (Singleton)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Tabelle: jobs
|
||||
|
||||
Die wichtigste Tabelle – speichert alle Ripping-Jobs.
|
||||
|
||||
```sql
|
||||
CREATE TABLE jobs (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
created_at TEXT NOT NULL,
|
||||
updated_at TEXT NOT NULL,
|
||||
status TEXT NOT NULL, -- Aktueller Status
|
||||
title TEXT, -- Filmtitel (von OMDb)
|
||||
imdb_id TEXT, -- IMDb-ID
|
||||
omdb_year TEXT, -- Erscheinungsjahr
|
||||
omdb_type TEXT, -- movie/series
|
||||
omdb_poster TEXT, -- Poster-URL
|
||||
raw_path TEXT, -- Pfad zur Raw-MKV
|
||||
output_path TEXT, -- Pfad zur Ausgabedatei
|
||||
playlist TEXT, -- Gewählte Blu-ray Playlist
|
||||
makemkv_output TEXT, -- MakeMKV-Ausgabe (JSON)
|
||||
mediainfo_output TEXT, -- MediaInfo-Ausgabe (JSON)
|
||||
encode_plan TEXT, -- Encode-Plan (JSON)
|
||||
handbrake_log TEXT, -- HandBrake Log-Pfad
|
||||
error_message TEXT, -- Fehlermeldung bei ERROR
|
||||
error_details TEXT -- Detaillierte Fehler-Infos
|
||||
);
|
||||
```
|
||||
|
||||
### Job-Status-Werte
|
||||
|
||||
| Status | Beschreibung |
|
||||
|--------|-------------|
|
||||
| `ANALYZING` | MakeMKV analysiert die Disc |
|
||||
| `METADATA_SELECTION` | Wartet auf Benutzer-Metadaten-Auswahl |
|
||||
| `READY_TO_START` | Bereit zum Starten |
|
||||
| `RIPPING` | MakeMKV rippt die Disc |
|
||||
| `MEDIAINFO_CHECK` | MediaInfo analysiert die Raw-Datei |
|
||||
| `READY_TO_ENCODE` | Wartet auf Encode-Bestätigung |
|
||||
| `ENCODING` | HandBrake encodiert |
|
||||
| `FINISHED` | Erfolgreich abgeschlossen |
|
||||
| `ERROR` | Fehler aufgetreten |
|
||||
|
||||
---
|
||||
|
||||
## Tabelle: pipeline_state
|
||||
|
||||
Singleton-Tabelle für den aktuellen Pipeline-Zustand (immer genau 1 Zeile).
|
||||
|
||||
```sql
|
||||
CREATE TABLE pipeline_state (
|
||||
id INTEGER PRIMARY KEY CHECK(id = 1),
|
||||
state TEXT NOT NULL DEFAULT 'IDLE',
|
||||
job_id INTEGER, -- Aktiver Job (NULL wenn IDLE)
|
||||
progress REAL, -- Fortschritt 0-100
|
||||
eta TEXT, -- Geschätzte Restzeit
|
||||
updated_at TEXT NOT NULL
|
||||
);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Tabelle: settings_schema
|
||||
|
||||
Definiert alle verfügbaren Einstellungen mit Metadaten.
|
||||
|
||||
```sql
|
||||
CREATE TABLE settings_schema (
|
||||
key TEXT PRIMARY KEY,
|
||||
category TEXT NOT NULL, -- paths, tools, encoding, ...
|
||||
type TEXT NOT NULL, -- string, number, boolean, select
|
||||
label TEXT NOT NULL, -- Anzeigename
|
||||
description TEXT, -- Hilfetext
|
||||
default_val TEXT, -- Standardwert
|
||||
required INTEGER, -- 1 = Pflichtfeld
|
||||
min_val REAL, -- Minimalwert (für number)
|
||||
max_val REAL, -- Maximalwert (für number)
|
||||
options TEXT -- JSON-Array für select-Typ
|
||||
);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Tabelle: settings_values
|
||||
|
||||
Speichert benutzer-konfigurierte Werte.
|
||||
|
||||
```sql
|
||||
CREATE TABLE settings_values (
|
||||
key TEXT PRIMARY KEY REFERENCES settings_schema(key),
|
||||
value TEXT NOT NULL,
|
||||
updated_at TEXT NOT NULL
|
||||
);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Schema-Migrationen
|
||||
|
||||
`database.js` implementiert **automatische Migrationen**:
|
||||
|
||||
1. Beim Start wird das aktuelle Schema geprüft
|
||||
2. Fehlende Tabellen werden erstellt
|
||||
3. Fehlende Spalten werden hinzugefügt
|
||||
4. Neue Default-Einstellungen werden eingefügt
|
||||
|
||||
### Korruptions-Recovery
|
||||
|
||||
Falls die Datenbankdatei korrupt ist:
|
||||
|
||||
```
|
||||
1. Korrupte Datei wird erkannt (Verbindungsfehler / Integritätsprüfung)
|
||||
2. Datei wird in /backend/data/quarantine/ verschoben
|
||||
3. Neue, leere Datenbank wird erstellt
|
||||
4. Schema wird neu initialisiert
|
||||
5. Log-Eintrag mit Warnung
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Datenbankpfad konfigurieren
|
||||
|
||||
Standard: `./data/ripster.db` (relativ zum Backend-Verzeichnis)
|
||||
|
||||
Über Umgebungsvariable anpassen:
|
||||
|
||||
```env
|
||||
DB_PATH=/var/lib/ripster/ripster.db
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Direkte Datenbankinspektion
|
||||
|
||||
```bash
|
||||
# SQLite3-CLI
|
||||
sqlite3 backend/data/ripster.db
|
||||
|
||||
# Alle Jobs anzeigen
|
||||
.mode table
|
||||
SELECT id, status, title, created_at FROM jobs ORDER BY created_at DESC;
|
||||
|
||||
# Einstellungen anzeigen
|
||||
SELECT key, value FROM settings_values;
|
||||
```
|
||||
190
docs/architecture/frontend.md
Normal file
190
docs/architecture/frontend.md
Normal file
@@ -0,0 +1,190 @@
|
||||
# Frontend-Komponenten
|
||||
|
||||
Das Frontend ist mit **React 18** und **PrimeReact** gebaut und kommuniziert über REST-API und WebSocket mit dem Backend.
|
||||
|
||||
---
|
||||
|
||||
## Seiten (Pages)
|
||||
|
||||
### DashboardPage.jsx
|
||||
|
||||
Die Hauptseite von Ripster – zeigt den aktuellen Pipeline-Status und ermöglicht alle Workflow-Aktionen.
|
||||
|
||||
**Funktionen:**
|
||||
- Anzeige des aktuellen Pipeline-Zustands (IDLE, ANALYZING, RIPPING, ENCODING, ...)
|
||||
- Live-Fortschrittsbalken mit ETA
|
||||
- Trigger für Metadaten-Dialog
|
||||
- Playlist-Entscheidungs-UI (bei Blu-ray Obfuskierung)
|
||||
- Encode-Review mit Track-Auswahl
|
||||
- Job-Steuerung (Start, Abbruch, Retry)
|
||||
|
||||
**Zugehörige Komponenten:**
|
||||
- `PipelineStatusCard` – Status-Widget
|
||||
- `MetadataSelectionDialog` – OMDb-Suche und Playlist-Auswahl
|
||||
- `MediaInfoReviewPanel` – Track-Auswahl vor dem Encoding
|
||||
- `DiscDetectedDialog` – Benachrichtigung bei Disc-Erkennung
|
||||
|
||||
### SettingsPage.jsx
|
||||
|
||||
Konfigurationsoberfläche für alle Ripster-Einstellungen.
|
||||
|
||||
**Funktionen:**
|
||||
- Dynamisch generiertes Formular aus dem Settings-Schema
|
||||
- Echtzeit-Validierungsfeedback
|
||||
- PushOver-Verbindungstest
|
||||
- Automatische Aktualisierung des Encode-Reviews bei relevanten Änderungen
|
||||
|
||||
### HistoryPage.jsx
|
||||
|
||||
Job-Historie mit vollständigem Audit-Trail.
|
||||
|
||||
**Funktionen:**
|
||||
- Sortier- und filterbares Job-Verzeichnis
|
||||
- Statusfilter (FINISHED, ERROR, WAITING_FOR_USER_DECISION, ...)
|
||||
- Job-Detail-Dialog mit vollständigen Logs
|
||||
- Re-Encode, Löschen und Metadaten-Zuweisung
|
||||
- Import von Orphan-Raw-Ordnern
|
||||
|
||||
---
|
||||
|
||||
## Komponenten (Components)
|
||||
|
||||
### MetadataSelectionDialog.jsx
|
||||
|
||||
Dialog für die Metadaten-Auswahl nach der Disc-Analyse.
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────┐
|
||||
│ Metadaten auswählen │
|
||||
├─────────────────────────────────────┤
|
||||
│ Suche: [Inception ] 🔍 │
|
||||
├─────────────────────────────────────┤
|
||||
│ Ergebnisse: │
|
||||
│ ▶ Inception (2010) – Movie │
|
||||
│ Inception: ... (2011) – Series │
|
||||
├─────────────────────────────────────┤
|
||||
│ Playlist (nur Blu-ray): │
|
||||
│ ▶ 00800.mpls (2:30:15) ✓ Empfohlen │
|
||||
│ 00801.mpls (0:01:23) │
|
||||
├─────────────────────────────────────┤
|
||||
│ [Bestätigen] │
|
||||
└─────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### MediaInfoReviewPanel.jsx
|
||||
|
||||
Track-Auswahl-Panel vor dem Encoding.
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────┐
|
||||
│ Encode-Review │
|
||||
├─────────────────────────────────────┤
|
||||
│ Audio-Tracks: │
|
||||
│ ☑ Track 1: Deutsch (AC-3, 5.1) │
|
||||
│ ☑ Track 2: English (TrueHD, 7.1) │
|
||||
│ ☐ Track 3: Français (AC-3, 2.0) │
|
||||
├─────────────────────────────────────┤
|
||||
│ Untertitel: │
|
||||
│ ☑ Track 1: Deutsch │
|
||||
│ ☐ Track 2: English │
|
||||
├─────────────────────────────────────┤
|
||||
│ [Encodierung starten] │
|
||||
└─────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### DynamicSettingsForm.jsx
|
||||
|
||||
Wiederverwendbares Formular, das aus dem Settings-Schema generiert wird.
|
||||
|
||||
**Unterstützte Feldtypen:**
|
||||
|
||||
| Typ | UI-Element |
|
||||
|----|-----------|
|
||||
| `string` | Text-Input |
|
||||
| `number` | Zahlen-Input mit Min/Max |
|
||||
| `boolean` | Toggle/Checkbox |
|
||||
| `select` | Dropdown |
|
||||
| `password` | Passwort-Input |
|
||||
|
||||
### PipelineStatusCard.jsx
|
||||
|
||||
Status-Anzeige-Widget für die Dashboard-Seite.
|
||||
|
||||
### JobDetailDialog.jsx
|
||||
|
||||
Vollständiger Job-Detail-Dialog mit Logs-Viewer.
|
||||
|
||||
---
|
||||
|
||||
## Hooks
|
||||
|
||||
### useWebSocket.js
|
||||
|
||||
Zentraler Custom-Hook für die WebSocket-Verbindung.
|
||||
|
||||
```js
|
||||
const { status, lastMessage } = useWebSocket({
|
||||
onMessage: (msg) => {
|
||||
if (msg.type === 'PIPELINE_STATE_CHANGE') {
|
||||
setPipelineState(msg.data);
|
||||
}
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
**Features:**
|
||||
- Automatische Verbindung zu `/ws`
|
||||
- Reconnect mit exponential backoff
|
||||
- Message-Parsing (JSON)
|
||||
- Status-Tracking (connecting, connected, disconnected)
|
||||
|
||||
---
|
||||
|
||||
## API-Client (client.js)
|
||||
|
||||
Zentraler HTTP-Client für alle Backend-Anfragen.
|
||||
|
||||
```js
|
||||
// Beispiel-Aufrufe
|
||||
const state = await api.getPipelineState();
|
||||
const results = await api.searchOmdb('Inception');
|
||||
await api.selectMetadata(jobId, omdbData, playlist);
|
||||
await api.confirmEncode(jobId, { audioTracks: [0, 1], subtitleTracks: [0] });
|
||||
```
|
||||
|
||||
**Features:**
|
||||
- Zentralisierte Fehlerbehandlung
|
||||
- Automatische JSON-Serialisierung
|
||||
- Basis-URL aus Umgebungsvariable (`VITE_API_BASE`)
|
||||
|
||||
---
|
||||
|
||||
## Build & Entwicklung
|
||||
|
||||
### Entwicklungsserver
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm run dev
|
||||
# → http://localhost:5173
|
||||
```
|
||||
|
||||
### Vite-Proxy-Konfiguration
|
||||
|
||||
In der Entwicklungsumgebung proxied Vite API-Anfragen zum Backend:
|
||||
|
||||
```js
|
||||
// vite.config.js
|
||||
proxy: {
|
||||
'/api': 'http://localhost:3001',
|
||||
'/ws': { target: 'ws://localhost:3001', ws: true }
|
||||
}
|
||||
```
|
||||
|
||||
### Production-Build
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm run build
|
||||
# → frontend/dist/
|
||||
```
|
||||
112
docs/architecture/index.md
Normal file
112
docs/architecture/index.md
Normal file
@@ -0,0 +1,112 @@
|
||||
# Architektur
|
||||
|
||||
Ripster ist als klassische **Client-Server-Anwendung** mit Echtzeit-Kommunikation über WebSockets aufgebaut.
|
||||
|
||||
---
|
||||
|
||||
## Systemüberblick
|
||||
|
||||
```mermaid
|
||||
graph TB
|
||||
subgraph Browser["Browser (React)"]
|
||||
Dashboard["Dashboard"]
|
||||
Settings["Einstellungen"]
|
||||
History["History"]
|
||||
end
|
||||
|
||||
subgraph Backend["Node.js Backend"]
|
||||
API["REST API\n(Express)"]
|
||||
WS["WebSocket\nServer"]
|
||||
Pipeline["Pipeline\nService"]
|
||||
DB["SQLite\nDatenbank"]
|
||||
end
|
||||
|
||||
subgraph ExternalTools["Externe Tools"]
|
||||
MakeMKV["makemkvcon"]
|
||||
HandBrake["HandBrakeCLI"]
|
||||
MediaInfo["mediainfo"]
|
||||
end
|
||||
|
||||
subgraph ExternalAPIs["Externe APIs"]
|
||||
OMDb["OMDb API"]
|
||||
PushOver["PushOver"]
|
||||
end
|
||||
|
||||
Browser <-->|HTTP REST| API
|
||||
Browser <-->|WebSocket| WS
|
||||
Pipeline --> MakeMKV
|
||||
Pipeline --> HandBrake
|
||||
Pipeline --> MediaInfo
|
||||
Pipeline <-->|Metadaten| OMDb
|
||||
Pipeline -->|Benachrichtigungen| PushOver
|
||||
API --> DB
|
||||
Pipeline --> DB
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Schichten-Architektur
|
||||
|
||||
### Backend
|
||||
|
||||
```
|
||||
index.js (Express Server)
|
||||
├── Routes (API-Endpunkte)
|
||||
│ ├── pipelineRoutes.js
|
||||
│ ├── settingsRoutes.js
|
||||
│ └── historyRoutes.js
|
||||
├── Services (Business Logic)
|
||||
│ ├── pipelineService.js ← Kern-Orchestrierung
|
||||
│ ├── diskDetectionService.js
|
||||
│ ├── processRunner.js
|
||||
│ ├── websocketService.js
|
||||
│ ├── omdbService.js
|
||||
│ ├── settingsService.js
|
||||
│ ├── notificationService.js
|
||||
│ ├── historyService.js
|
||||
│ └── logger.js
|
||||
├── Database
|
||||
│ ├── database.js
|
||||
│ └── defaultSettings.js
|
||||
└── Utils
|
||||
├── encodePlan.js
|
||||
├── playlistAnalysis.js
|
||||
├── progressParsers.js
|
||||
└── files.js
|
||||
```
|
||||
|
||||
### Frontend
|
||||
|
||||
```
|
||||
App.jsx (React Router)
|
||||
├── Pages
|
||||
│ ├── DashboardPage.jsx ← Haupt-Interface
|
||||
│ ├── SettingsPage.jsx
|
||||
│ └── HistoryPage.jsx
|
||||
├── Components
|
||||
│ ├── PipelineStatusCard.jsx
|
||||
│ ├── MetadataSelectionDialog.jsx
|
||||
│ ├── MediaInfoReviewPanel.jsx
|
||||
│ ├── DynamicSettingsForm.jsx
|
||||
│ └── JobDetailDialog.jsx
|
||||
├── Hooks
|
||||
│ └── useWebSocket.js
|
||||
└── API
|
||||
└── client.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Weiterführende Dokumentation
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- [:octicons-arrow-right-24: Übersicht](overview.md)
|
||||
|
||||
- [:octicons-arrow-right-24: Backend-Services](backend.md)
|
||||
|
||||
- [:octicons-arrow-right-24: Frontend-Komponenten](frontend.md)
|
||||
|
||||
- [:octicons-arrow-right-24: Datenbank](database.md)
|
||||
|
||||
</div>
|
||||
144
docs/architecture/overview.md
Normal file
144
docs/architecture/overview.md
Normal file
@@ -0,0 +1,144 @@
|
||||
# Architektur-Übersicht
|
||||
|
||||
---
|
||||
|
||||
## Kern-Designprinzipien
|
||||
|
||||
### Event-Driven Pipeline
|
||||
|
||||
Der gesamte Ripping-Workflow ist als **State Machine** implementiert. Der `pipelineService` verwaltet den aktuellen Zustand und emittiert Ereignisse bei jedem Zustandswechsel. Der WebSocket-Service überträgt diese Ereignisse sofort an alle verbundenen Clients.
|
||||
|
||||
```
|
||||
Zustandswechsel → Event → WebSocket → Frontend-Update
|
||||
```
|
||||
|
||||
### Service-Layer-Muster
|
||||
|
||||
```
|
||||
HTTP-Route → Service → Datenbank
|
||||
```
|
||||
|
||||
Routes delegieren die gesamte Business-Logik an Services. Services sind voneinander unabhängig und können einzeln getestet werden.
|
||||
|
||||
### Schema-getriebene Einstellungen
|
||||
|
||||
Die Settings-Konfiguration definiert **sowohl** die Validierungsregeln als auch die UI-Struktur in einer einzigen Quelle (`settings_schema`-Tabelle). Die `DynamicSettingsForm`-Komponente rendert das Formular dynamisch aus dem Schema.
|
||||
|
||||
---
|
||||
|
||||
## Echtzeit-Kommunikation
|
||||
|
||||
### WebSocket-Protokoll
|
||||
|
||||
Der WebSocket-Server läuft unter dem Pfad `/ws`. Nachrichten werden als JSON übertragen:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "PIPELINE_STATE_CHANGE",
|
||||
"data": {
|
||||
"state": "ENCODING",
|
||||
"jobId": 42,
|
||||
"progress": 73.5,
|
||||
"eta": "00:12:34"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Nachrichtentypen:**
|
||||
|
||||
| Typ | Beschreibung |
|
||||
|----|-------------|
|
||||
| `PIPELINE_STATE_CHANGE` | Pipeline-Zustand hat gewechselt |
|
||||
| `PROGRESS_UPDATE` | Fortschritt (% und ETA) |
|
||||
| `DISC_DETECTED` | Disc wurde erkannt |
|
||||
| `DISC_REMOVED` | Disc wurde entfernt |
|
||||
| `ERROR` | Fehler aufgetreten |
|
||||
| `JOB_COMPLETE` | Job abgeschlossen |
|
||||
|
||||
### Reconnect-Logik
|
||||
|
||||
Der Frontend-Hook `useWebSocket.js` implementiert automatisches Reconnect mit exponential backoff bei Verbindungsabbrüchen.
|
||||
|
||||
---
|
||||
|
||||
## Prozess-Management
|
||||
|
||||
### processRunner.js
|
||||
|
||||
Externe Tools (MakeMKV, HandBrake, MediaInfo) werden als **Child Processes** gestartet:
|
||||
|
||||
```js
|
||||
spawn(command, args, { stdio: ['ignore', 'pipe', 'pipe'] })
|
||||
```
|
||||
|
||||
- **stdout/stderr** werden zeilenweise gelesen und in Echtzeit verarbeitet
|
||||
- **Progress-Parsing** erfolgt über reguläre Ausdrücke in `progressParsers.js`
|
||||
- **Graceful Shutdown**: SIGINT → Timeout → SIGKILL
|
||||
- **Prozess-Tracking**: Aktive Prozesse werden registriert für sauberes Beenden
|
||||
|
||||
---
|
||||
|
||||
## Datenpersistenz
|
||||
|
||||
### SQLite-Datenbank
|
||||
|
||||
Ripster verwendet eine **einzige SQLite-Datei** für alle persistenten Daten:
|
||||
|
||||
```
|
||||
backend/data/ripster.db
|
||||
```
|
||||
|
||||
**Tabellen:**
|
||||
|
||||
| Tabelle | Inhalt |
|
||||
|---------|--------|
|
||||
| `jobs` | Alle Rip-Jobs mit Status, Logs, Metadaten |
|
||||
| `pipeline_state` | Aktueller Pipeline-Zustand (Singleton) |
|
||||
| `settings_schema` | Schema aller verfügbaren Einstellungen |
|
||||
| `settings_values` | Benutzer-konfigurierte Werte |
|
||||
|
||||
### Migrations-Strategie
|
||||
|
||||
Beim Start prüft `database.js` automatisch, ob das Schema aktuell ist, und führt fehlende Migrationen aus. Korrupte Datenbankdateien werden in ein Quarantäne-Verzeichnis verschoben und eine neue Datenbank erstellt.
|
||||
|
||||
---
|
||||
|
||||
## Fehlerbehandlung
|
||||
|
||||
### Strukturierte Fehler
|
||||
|
||||
Alle Fehler werden mit Kontext-Metadaten protokolliert:
|
||||
|
||||
```js
|
||||
logger.error('Encoding fehlgeschlagen', {
|
||||
jobId: job.id,
|
||||
command: cmd,
|
||||
exitCode: code,
|
||||
stderr: lastLines
|
||||
});
|
||||
```
|
||||
|
||||
### Job-Fehler-Recovery
|
||||
|
||||
- Fehlgeschlagene Jobs bleiben in der Datenbank (Status `ERROR`)
|
||||
- Vollständige Fehler-Logs werden im Job-Datensatz gespeichert
|
||||
- **Retry-Funktion** ermöglicht Neustart von einem Fehler-Zustand
|
||||
- **Re-Encode** erlaubt erneutes Encodieren ohne neu zu rippen
|
||||
|
||||
---
|
||||
|
||||
## Sicherheit
|
||||
|
||||
### Eingabe-Validierung
|
||||
|
||||
- Alle Benutzer-Eingaben werden in `validators.js` validiert
|
||||
- CLI-Argumente werden sicher über `commandLine.js` konstruiert (kein Shell-Injection-Risiko)
|
||||
- Pfade werden sanitisiert bevor sie an externe Prozesse übergeben werden
|
||||
|
||||
### CORS-Konfiguration
|
||||
|
||||
```env
|
||||
CORS_ORIGIN=http://localhost:5173
|
||||
```
|
||||
|
||||
In Produktion sollte dieser Wert auf die tatsächliche Frontend-URL gesetzt werden.
|
||||
96
docs/configuration/environment.md
Normal file
96
docs/configuration/environment.md
Normal file
@@ -0,0 +1,96 @@
|
||||
# Umgebungsvariablen
|
||||
|
||||
Umgebungsvariablen überschreiben die Standardwerte und eignen sich für Server-Deployments.
|
||||
|
||||
---
|
||||
|
||||
## Backend-Umgebungsvariablen
|
||||
|
||||
Konfigurationsdatei: `backend/.env`
|
||||
|
||||
| Variable | Standard | Beschreibung |
|
||||
|---------|---------|-------------|
|
||||
| `PORT` | `3001` | Port des Express-Servers |
|
||||
| `DB_PATH` | `./data/ripster.db` | Pfad zur SQLite-Datenbankdatei |
|
||||
| `CORS_ORIGIN` | `http://localhost:5173` | Erlaubter CORS-Origin |
|
||||
| `LOG_DIR` | `./logs` | Verzeichnis für Log-Dateien |
|
||||
| `LOG_LEVEL` | `info` | Log-Level (`debug`, `info`, `warn`, `error`) |
|
||||
|
||||
### Beispiel: backend/.env
|
||||
|
||||
```env
|
||||
PORT=3001
|
||||
DB_PATH=/var/lib/ripster/ripster.db
|
||||
CORS_ORIGIN=http://192.168.1.100:5173
|
||||
LOG_DIR=/var/log/ripster
|
||||
LOG_LEVEL=info
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Frontend-Umgebungsvariablen
|
||||
|
||||
Konfigurationsdatei: `frontend/.env`
|
||||
|
||||
| Variable | Standard | Beschreibung |
|
||||
|---------|---------|-------------|
|
||||
| `VITE_API_BASE` | `http://localhost:3001` | Backend-API-URL |
|
||||
| `VITE_WS_URL` | `ws://localhost:3001` | WebSocket-URL |
|
||||
| `VITE_PUBLIC_ORIGIN` | — | Öffentliche Origin-URL (für CORS) |
|
||||
| `VITE_HMR_HOST` | — | Vite HMR-Host (für Remote-Entwicklung) |
|
||||
| `VITE_HMR_PORT` | — | Vite HMR-Port |
|
||||
|
||||
### Beispiel: frontend/.env (Entwicklung)
|
||||
|
||||
```env
|
||||
VITE_API_BASE=http://localhost:3001
|
||||
VITE_WS_URL=ws://localhost:3001
|
||||
```
|
||||
|
||||
### Beispiel: frontend/.env (Netzwerk-Zugriff)
|
||||
|
||||
```env
|
||||
VITE_API_BASE=http://192.168.1.100:3001
|
||||
VITE_WS_URL=ws://192.168.1.100:3001
|
||||
VITE_PUBLIC_ORIGIN=http://192.168.1.100:5173
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## .env.example Dateien
|
||||
|
||||
Das Repository enthält Vorlagen für beide Konfigurationsdateien:
|
||||
|
||||
```bash
|
||||
# Backend
|
||||
cp backend/.env.example backend/.env
|
||||
|
||||
# Frontend
|
||||
cp frontend/.env.example frontend/.env
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Priorität der Konfiguration
|
||||
|
||||
Einstellungen werden in folgender Reihenfolge geladen (höhere Priorität überschreibt niedrigere):
|
||||
|
||||
```
|
||||
1. Systemumgebungsvariablen (export VAR=value)
|
||||
2. .env-Datei
|
||||
3. Hardcodierte Standardwerte in config.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## LOG_LEVEL
|
||||
|
||||
| Level | Ausgabe |
|
||||
|-------|---------|
|
||||
| `debug` | Alle Meldungen inkl. Debugging |
|
||||
| `info` | Normale Betriebsinformationen |
|
||||
| `warn` | Warnungen + Fehler |
|
||||
| `error` | Nur Fehler |
|
||||
|
||||
!!! tip "Produktionsempfehlung"
|
||||
Für Produktionsumgebungen `LOG_LEVEL=info` oder `LOG_LEVEL=warn` verwenden. `debug` erzeugt sehr viele Log-Einträge.
|
||||
21
docs/configuration/index.md
Normal file
21
docs/configuration/index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Konfiguration
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-tune: **Einstellungsreferenz**
|
||||
|
||||
---
|
||||
|
||||
Alle verfügbaren Einstellungen mit Typen, Standardwerten und Beschreibungen.
|
||||
|
||||
[:octicons-arrow-right-24: Einstellungsreferenz](settings-reference.md)
|
||||
|
||||
- :material-variable: **Umgebungsvariablen**
|
||||
|
||||
---
|
||||
|
||||
Umgebungsvariablen für Backend und Frontend.
|
||||
|
||||
[:octicons-arrow-right-24: Umgebungsvariablen](environment.md)
|
||||
|
||||
</div>
|
||||
138
docs/configuration/settings-reference.md
Normal file
138
docs/configuration/settings-reference.md
Normal file
@@ -0,0 +1,138 @@
|
||||
# Einstellungsreferenz
|
||||
|
||||
Vollständige Übersicht aller Ripster-Einstellungen. Alle Einstellungen werden über die Web-Oberfläche unter **Einstellungen** verwaltet.
|
||||
|
||||
---
|
||||
|
||||
## Kategorie: Pfade (paths)
|
||||
|
||||
| Schlüssel | Typ | Standard | Pflicht | Beschreibung |
|
||||
|---------|-----|---------|---------|-------------|
|
||||
| `raw_dir` | string | — | ✅ | Verzeichnis für rohe MKV-Dateien nach dem Ripping |
|
||||
| `movie_dir` | string | — | ✅ | Ausgabeverzeichnis für encodierte Filme |
|
||||
| `log_dir` | string | `./logs` | — | Verzeichnis für Log-Dateien |
|
||||
|
||||
!!! example "Beispielkonfiguration"
|
||||
```
|
||||
raw_dir = /mnt/nas/raw
|
||||
movie_dir = /mnt/nas/movies
|
||||
log_dir = /var/log/ripster
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Kategorie: Tools (tools)
|
||||
|
||||
| Schlüssel | Typ | Standard | Beschreibung |
|
||||
|---------|-----|---------|-------------|
|
||||
| `makemkv_command` | string | `makemkvcon` | Befehl oder absoluter Pfad zu MakeMKV |
|
||||
| `handbrake_command` | string | `HandBrakeCLI` | Befehl oder absoluter Pfad zu HandBrake |
|
||||
| `mediainfo_command` | string | `mediainfo` | Befehl oder absoluter Pfad zu MediaInfo |
|
||||
|
||||
!!! tip "Absolute Pfade verwenden"
|
||||
Falls die Tools nicht im `PATH` des Systems sind:
|
||||
```
|
||||
makemkv_command = /usr/local/bin/makemkvcon
|
||||
handbrake_command = /usr/local/bin/HandBrakeCLI
|
||||
mediainfo_command = /usr/bin/mediainfo
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Kategorie: Encoding (encoding)
|
||||
|
||||
| Schlüssel | Typ | Standard | Beschreibung |
|
||||
|---------|-----|---------|-------------|
|
||||
| `handbrake_preset` | string | `H.265 MKV 1080p30` | Name des HandBrake-Presets |
|
||||
| `handbrake_extra_args` | string | _(leer)_ | Zusätzliche HandBrake CLI-Argumente |
|
||||
| `output_extension` | string | `mkv` | Dateiendung der Ausgabedatei |
|
||||
| `filename_template` | string | `{title} ({year})` | Template für den Dateinamen |
|
||||
|
||||
### Verfügbare HandBrake-Presets
|
||||
|
||||
Eine vollständige Liste der verfügbaren Presets:
|
||||
|
||||
```bash
|
||||
HandBrakeCLI --preset-list
|
||||
```
|
||||
|
||||
Häufig verwendete Presets:
|
||||
|
||||
| Preset | Beschreibung |
|
||||
|--------|-------------|
|
||||
| `H.265 MKV 1080p30` | H.265/HEVC, Full-HD, 30fps |
|
||||
| `H.265 MKV 720p30` | H.265/HEVC, HD, 30fps |
|
||||
| `H.264 MKV 1080p30` | H.264/AVC, Full-HD, 30fps |
|
||||
| `HQ 1080p30 Surround` | Hohe Qualität, Full-HD mit Surround |
|
||||
|
||||
### Dateiname-Template-Platzhalter
|
||||
|
||||
| Platzhalter | Beispiel |
|
||||
|------------|---------|
|
||||
| `{title}` | `Inception` |
|
||||
| `{year}` | `2010` |
|
||||
| `{imdb_id}` | `tt1375666` |
|
||||
| `{type}` | `movie` |
|
||||
|
||||
---
|
||||
|
||||
## Kategorie: Laufwerk (drive)
|
||||
|
||||
| Schlüssel | Typ | Standard | Optionen | Beschreibung |
|
||||
|---------|-----|---------|---------|-------------|
|
||||
| `drive_mode` | select | `auto` | `auto`, `explicit` | Laufwerk-Erkennungsmodus |
|
||||
| `drive_device` | string | `/dev/sr0` | — | Geräte-Pfad (nur bei `explicit`) |
|
||||
| `disc_poll_interval_ms` | number | `5000` | 1000–60000 | Polling-Intervall in Millisekunden |
|
||||
|
||||
**`drive_mode` Optionen:**
|
||||
|
||||
| Modus | Beschreibung |
|
||||
|------|-------------|
|
||||
| `auto` | Ripster erkennt das Laufwerk automatisch |
|
||||
| `explicit` | Verwendet das in `drive_device` konfigurierte Gerät |
|
||||
|
||||
---
|
||||
|
||||
## Kategorie: MakeMKV (makemkv)
|
||||
|
||||
| Schlüssel | Typ | Standard | Min | Max | Beschreibung |
|
||||
|---------|-----|---------|-----|-----|-------------|
|
||||
| `makemkv_min_length_minutes` | number | `15` | `0` | `999` | Mindest-Titellänge in Minuten |
|
||||
| `makemkv_backup_mode` | boolean | `false` | — | — | Backup-Modus statt MKV-Modus |
|
||||
|
||||
**`makemkv_min_length_minutes`:** Titel kürzer als dieser Wert werden von MakeMKV ignoriert. Verhindert das Rippen von Menü-Schleifen und kurzen Extra-Clips.
|
||||
|
||||
**`makemkv_backup_mode`:** Im Backup-Modus erstellt MakeMKV eine vollständige Disc-Kopie mit Menüs. Im Standard-Modus werden direkt MKV-Dateien erstellt.
|
||||
|
||||
---
|
||||
|
||||
## Kategorie: OMDb (omdb)
|
||||
|
||||
| Schlüssel | Typ | Standard | Pflicht | Beschreibung |
|
||||
|---------|-----|---------|---------|-------------|
|
||||
| `omdb_api_key` | string | — | ✅ | API-Key von [omdbapi.com](https://www.omdbapi.com/) |
|
||||
| `omdb_default_type` | select | `movie` | — | Standard-Suchtyp: `movie` oder `series` |
|
||||
|
||||
---
|
||||
|
||||
## Kategorie: Benachrichtigungen (notifications)
|
||||
|
||||
| Schlüssel | Typ | Standard | Beschreibung |
|
||||
|---------|-----|---------|-------------|
|
||||
| `pushover_user_key` | string | — | PushOver User-Key |
|
||||
| `pushover_api_token` | string | — | PushOver API-Token |
|
||||
|
||||
Beide Felder müssen konfiguriert sein, um PushOver-Benachrichtigungen zu aktivieren. Die Verbindung kann mit dem **Test-Button** in den Einstellungen geprüft werden.
|
||||
|
||||
---
|
||||
|
||||
## Standard-Einstellungen zurücksetzen
|
||||
|
||||
Über die Datenbank können Einstellungen auf Standardwerte zurückgesetzt werden:
|
||||
|
||||
```bash
|
||||
sqlite3 backend/data/ripster.db \
|
||||
"DELETE FROM settings_values WHERE key = 'handbrake_preset';"
|
||||
```
|
||||
|
||||
Beim nächsten Laden der Einstellungen wird der Standardwert verwendet.
|
||||
137
docs/deployment/development.md
Normal file
137
docs/deployment/development.md
Normal file
@@ -0,0 +1,137 @@
|
||||
# Entwicklungsumgebung
|
||||
|
||||
---
|
||||
|
||||
## Voraussetzungen
|
||||
|
||||
- Node.js >= 20.19.0
|
||||
- Alle [externen Tools](../getting-started/prerequisites.md) installiert
|
||||
|
||||
---
|
||||
|
||||
## Schnellstart
|
||||
|
||||
```bash
|
||||
./start.sh
|
||||
```
|
||||
|
||||
Das Skript startet automatisch:
|
||||
- **Backend** auf Port 3001 (mit Nodemon für Hot-Reload)
|
||||
- **Frontend** auf Port 5173 (mit Vite HMR)
|
||||
|
||||
---
|
||||
|
||||
## Manuelle Entwicklungsumgebung
|
||||
|
||||
### Terminal 1 – Backend
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Backend läuft auf `http://localhost:3001` mit **Nodemon** – Neustart bei Dateiänderungen.
|
||||
|
||||
### Terminal 2 – Frontend
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Frontend läuft auf `http://localhost:5173` mit **Vite HMR** – sofortige Browser-Updates.
|
||||
|
||||
---
|
||||
|
||||
## Vite-Proxy
|
||||
|
||||
Im Entwicklungsmodus proxied Vite alle API- und WebSocket-Anfragen zum Backend:
|
||||
|
||||
```js
|
||||
// frontend/vite.config.js
|
||||
server: {
|
||||
proxy: {
|
||||
'/api': {
|
||||
target: 'http://localhost:3001',
|
||||
changeOrigin: true
|
||||
},
|
||||
'/ws': {
|
||||
target: 'ws://localhost:3001',
|
||||
ws: true
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Das bedeutet: Im Browser macht das Frontend Anfragen an `localhost:5173/api/...` – Vite leitet diese an `localhost:3001/api/...` weiter.
|
||||
|
||||
---
|
||||
|
||||
## Remote-Entwicklung
|
||||
|
||||
Falls Ripster auf einem entfernten Server entwickelt wird (z.B. Homeserver), muss die Vite-Konfiguration angepasst werden:
|
||||
|
||||
```env
|
||||
# frontend/.env.local
|
||||
VITE_API_BASE=http://192.168.1.100:3001
|
||||
VITE_WS_URL=ws://192.168.1.100:3001
|
||||
VITE_HMR_HOST=192.168.1.100
|
||||
VITE_HMR_PORT=5173
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Log-Level für Entwicklung
|
||||
|
||||
```env
|
||||
# backend/.env
|
||||
LOG_LEVEL=debug
|
||||
```
|
||||
|
||||
Im Debug-Modus werden alle Ausgaben der externen Tools (MakeMKV, HandBrake) vollständig geloggt.
|
||||
|
||||
---
|
||||
|
||||
## Stoppen
|
||||
|
||||
```bash
|
||||
./kill.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Linting & Type-Checking
|
||||
|
||||
```bash
|
||||
# Frontend (ESLint)
|
||||
cd frontend && npm run lint
|
||||
|
||||
# Backend hat keine separaten Lint-Scripts,
|
||||
# nutze direkt eslint falls konfiguriert
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Deployment-Script
|
||||
|
||||
Das `deploy-ripster.sh`-Script überträgt Code auf einen Remote-Server per SSH:
|
||||
|
||||
```bash
|
||||
./deploy-ripster.sh
|
||||
```
|
||||
|
||||
**Was das Script tut:**
|
||||
1. `rsync` synchronisiert den Code (Backend-Quellcode ohne `data/`)
|
||||
2. Die Datenbank (`backend/data/`) wird **nicht** überschrieben
|
||||
3. Verbindung via SSH (konfigurierbar im Script)
|
||||
|
||||
**Anpassung des Scripts:**
|
||||
|
||||
```bash
|
||||
# deploy-ripster.sh
|
||||
REMOTE_HOST="192.168.1.100"
|
||||
REMOTE_USER="michael"
|
||||
REMOTE_PATH="/home/michael/ripster"
|
||||
```
|
||||
21
docs/deployment/index.md
Normal file
21
docs/deployment/index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Deployment
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-laptop: **Entwicklungsumgebung**
|
||||
|
||||
---
|
||||
|
||||
Lokale Entwicklungsumgebung einrichten.
|
||||
|
||||
[:octicons-arrow-right-24: Entwicklung](development.md)
|
||||
|
||||
- :material-server: **Produktion**
|
||||
|
||||
---
|
||||
|
||||
Ripster auf einem Server dauerhaft betreiben.
|
||||
|
||||
[:octicons-arrow-right-24: Produktion](production.md)
|
||||
|
||||
</div>
|
||||
193
docs/deployment/production.md
Normal file
193
docs/deployment/production.md
Normal file
@@ -0,0 +1,193 @@
|
||||
# Produktions-Deployment
|
||||
|
||||
---
|
||||
|
||||
## Empfohlene Architektur
|
||||
|
||||
```
|
||||
Internet / Heimnetz
|
||||
↓
|
||||
nginx (Reverse Proxy)
|
||||
↓
|
||||
┌────┴────┐
|
||||
│ │
|
||||
Backend Frontend
|
||||
:3001 (statische Dateien)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## systemd-Service
|
||||
|
||||
Für ein dauerhaftes Betreiben als systemd-Service:
|
||||
|
||||
```bash
|
||||
sudo nano /etc/systemd/system/ripster.service
|
||||
```
|
||||
|
||||
```ini
|
||||
[Unit]
|
||||
Description=Ripster - Disc Ripping Service
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=michael
|
||||
WorkingDirectory=/home/michael/ripster
|
||||
ExecStart=/bin/bash /home/michael/ripster/start.sh
|
||||
ExecStop=/bin/bash /home/michael/ripster/kill.sh
|
||||
Restart=on-failure
|
||||
RestartSec=10s
|
||||
|
||||
# Umgebungsvariablen
|
||||
Environment=NODE_ENV=production
|
||||
Environment=PORT=3001
|
||||
Environment=LOG_LEVEL=info
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
```bash
|
||||
# Service aktivieren und starten
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable ripster
|
||||
sudo systemctl start ripster
|
||||
|
||||
# Status prüfen
|
||||
sudo systemctl status ripster
|
||||
|
||||
# Logs anzeigen
|
||||
journalctl -u ripster -f
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Frontend-Build
|
||||
|
||||
Für Produktion das Frontend bauen:
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm run build
|
||||
```
|
||||
|
||||
Die statischen Dateien landen in `frontend/dist/`.
|
||||
|
||||
---
|
||||
|
||||
## nginx-Konfiguration
|
||||
|
||||
```nginx
|
||||
# /etc/nginx/sites-available/ripster
|
||||
server {
|
||||
listen 80;
|
||||
server_name ripster.local;
|
||||
|
||||
# Statisches Frontend
|
||||
root /home/michael/ripster/frontend/dist;
|
||||
index index.html;
|
||||
|
||||
# SPA Fallback (React Router)
|
||||
location / {
|
||||
try_files $uri $uri/ /index.html;
|
||||
}
|
||||
|
||||
# API-Proxy zum Backend
|
||||
location /api/ {
|
||||
proxy_pass http://localhost:3001;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
}
|
||||
|
||||
# WebSocket-Proxy
|
||||
location /ws {
|
||||
proxy_pass http://localhost:3001;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection "upgrade";
|
||||
proxy_set_header Host $host;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```bash
|
||||
sudo ln -s /etc/nginx/sites-available/ripster /etc/nginx/sites-enabled/
|
||||
sudo nginx -t && sudo systemctl reload nginx
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Nur-Backend-Produktion (ohne nginx)
|
||||
|
||||
Falls kein Reverse Proxy gewünscht ist, kann das Backend die Frontend-Dateien direkt ausliefern:
|
||||
|
||||
```bash
|
||||
# Frontend bauen
|
||||
cd frontend && npm run build
|
||||
|
||||
# Backend startet und serviert frontend/dist/
|
||||
cd backend && NODE_ENV=production npm start
|
||||
```
|
||||
|
||||
Das Backend ist so konfiguriert, dass es im Produktionsmodus die `frontend/dist/`-Dateien als statische Assets ausliefert.
|
||||
|
||||
---
|
||||
|
||||
## Datenbank-Backup
|
||||
|
||||
```bash
|
||||
# Datenbank sichern
|
||||
cp backend/data/ripster.db backend/data/ripster.db.backup.$(date +%Y%m%d)
|
||||
|
||||
# Oder mit SQLite-eigenem Backup-Befehl
|
||||
sqlite3 backend/data/ripster.db ".backup '/mnt/backup/ripster.db'"
|
||||
```
|
||||
|
||||
!!! tip "Automatisches Backup"
|
||||
Cron-Job für tägliches Backup:
|
||||
```cron
|
||||
0 3 * * * sqlite3 /home/michael/ripster/backend/data/ripster.db ".backup '/mnt/backup/ripster-$(date +\%Y\%m\%d).db'"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Log-Rotation
|
||||
|
||||
Ripster rotiert Logs automatisch täglich. Falls zusätzlich systemd-Journal-Rotation gewünscht ist:
|
||||
|
||||
```bash
|
||||
# /etc/logrotate.d/ripster
|
||||
/home/michael/ripster/backend/logs/*.log {
|
||||
daily
|
||||
rotate 14
|
||||
compress
|
||||
missingok
|
||||
notifempty
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Sicherheitshinweise
|
||||
|
||||
!!! warning "Heimnetz-Einsatz"
|
||||
Ripster ist für den Einsatz im **lokalen Heimnetz** konzipiert und enthält **keine Authentifizierung**. Stelle sicher, dass der Dienst nicht öffentlich erreichbar ist.
|
||||
|
||||
Falls öffentlicher Zugang benötigt wird:
|
||||
|
||||
1. **Basic Auth** via nginx:
|
||||
```bash
|
||||
sudo htpasswd -c /etc/nginx/.htpasswd michael
|
||||
```
|
||||
```nginx
|
||||
location / {
|
||||
auth_basic "Ripster";
|
||||
auth_basic_user_file /etc/nginx/.htpasswd;
|
||||
# ...
|
||||
}
|
||||
```
|
||||
|
||||
2. **VPN-Zugang** (empfohlen): Zugriff nur über WireGuard/OpenVPN
|
||||
|
||||
3. **SSL/TLS**: Let's Encrypt mit certbot für HTTPS
|
||||
118
docs/getting-started/configuration.md
Normal file
118
docs/getting-started/configuration.md
Normal file
@@ -0,0 +1,118 @@
|
||||
# Konfiguration
|
||||
|
||||
Alle Einstellungen werden über die Web-Oberfläche unter **Einstellungen** verwaltet und in der SQLite-Datenbank gespeichert.
|
||||
|
||||
---
|
||||
|
||||
## Pflichteinstellungen
|
||||
|
||||
Diese Einstellungen müssen vor dem ersten Rip konfiguriert werden:
|
||||
|
||||
### Pfade
|
||||
|
||||
| Einstellung | Beschreibung | Beispiel |
|
||||
|------------|-------------|---------|
|
||||
| `raw_dir` | Verzeichnis für rohe MKV-Dateien | `/mnt/nas/raw` |
|
||||
| `movie_dir` | Ausgabeverzeichnis für kodierte Filme | `/mnt/nas/movies` |
|
||||
| `log_dir` | Verzeichnis für Log-Dateien | `/var/log/ripster` |
|
||||
|
||||
!!! warning "Berechtigungen"
|
||||
Der Ripster-Prozess benötigt **Schreibrechte** auf alle konfigurierten Verzeichnisse.
|
||||
|
||||
```bash
|
||||
# Verzeichnisse erstellen und Berechtigungen setzen
|
||||
sudo mkdir -p /mnt/nas/{raw,movies}
|
||||
sudo chown $USER:$USER /mnt/nas/{raw,movies}
|
||||
```
|
||||
|
||||
### OMDb API
|
||||
|
||||
| Einstellung | Beschreibung |
|
||||
|------------|-------------|
|
||||
| `omdb_api_key` | API-Key von omdbapi.com |
|
||||
| `omdb_default_type` | Standard-Suchtyp: `movie` oder `series` |
|
||||
|
||||
---
|
||||
|
||||
## Tool-Konfiguration
|
||||
|
||||
| Einstellung | Standard | Beschreibung |
|
||||
|------------|---------|-------------|
|
||||
| `makemkv_command` | `makemkvcon` | Pfad oder Befehl für MakeMKV |
|
||||
| `handbrake_command` | `HandBrakeCLI` | Pfad oder Befehl für HandBrake |
|
||||
| `mediainfo_command` | `mediainfo` | Pfad oder Befehl für MediaInfo |
|
||||
|
||||
!!! tip "Absolute Pfade"
|
||||
Falls die Tools nicht im `PATH` sind, verwende absolute Pfade:
|
||||
```
|
||||
/usr/local/bin/HandBrakeCLI
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Encoding-Konfiguration
|
||||
|
||||
| Einstellung | Standard | Beschreibung |
|
||||
|------------|---------|-------------|
|
||||
| `handbrake_preset` | `H.265 MKV 1080p30` | HandBrake-Preset-Name |
|
||||
| `handbrake_extra_args` | _(leer)_ | Zusätzliche HandBrake-Argumente |
|
||||
| `output_extension` | `mkv` | Dateiendung der Ausgabedatei |
|
||||
| `filename_template` | `{title} ({year})` | Template für Dateinamen |
|
||||
|
||||
### Dateiname-Template
|
||||
|
||||
Das Template unterstützt folgende Platzhalter:
|
||||
|
||||
| Platzhalter | Beschreibung | Beispiel |
|
||||
|------------|-------------|---------|
|
||||
| `{title}` | Filmtitel | `Inception` |
|
||||
| `{year}` | Erscheinungsjahr | `2010` |
|
||||
| `{imdb_id}` | IMDb-ID | `tt1375666` |
|
||||
| `{type}` | `movie` oder `series` | `movie` |
|
||||
|
||||
**Beispiel-Template:**
|
||||
```
|
||||
{title} ({year})
|
||||
→ Inception (2010).mkv
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Laufwerk-Konfiguration
|
||||
|
||||
| Einstellung | Standard | Beschreibung |
|
||||
|------------|---------|-------------|
|
||||
| `drive_mode` | `auto` | `auto` (automatisch erkennen) oder `explicit` (festes Gerät) |
|
||||
| `drive_device` | `/dev/sr0` | Geräte-Pfad (nur bei `explicit`) |
|
||||
| `disc_poll_interval_ms` | `5000` | Polling-Intervall in Millisekunden |
|
||||
|
||||
---
|
||||
|
||||
## MakeMKV-Konfiguration
|
||||
|
||||
| Einstellung | Standard | Beschreibung |
|
||||
|------------|---------|-------------|
|
||||
| `makemkv_min_length_minutes` | `15` | Mindestlänge für Titel in Minuten |
|
||||
| `makemkv_backup_mode` | `false` | Backup-Modus statt MKV-Modus |
|
||||
|
||||
!!! info "Backup-Modus"
|
||||
Im Backup-Modus erstellt MakeMKV eine vollständige Kopie der Disc (inkl. Menüs). Der Standardmodus erstellt direkt MKV-Dateien.
|
||||
|
||||
---
|
||||
|
||||
## Benachrichtigungen (PushOver)
|
||||
|
||||
| Einstellung | Beschreibung |
|
||||
|------------|-------------|
|
||||
| `pushover_user_key` | Dein PushOver User-Key |
|
||||
| `pushover_api_token` | API-Token deiner PushOver-App |
|
||||
|
||||
Nach der Eingabe kann die Verbindung mit dem **Test-Button** geprüft werden.
|
||||
|
||||
---
|
||||
|
||||
## Vollständige Einstellungsreferenz
|
||||
|
||||
Eine vollständige Liste aller Einstellungen mit Typen, Validierung und Standardwerten findest du unter:
|
||||
|
||||
[:octicons-arrow-right-24: Einstellungsreferenz](../configuration/settings-reference.md)
|
||||
41
docs/getting-started/index.md
Normal file
41
docs/getting-started/index.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Erste Schritte
|
||||
|
||||
Dieser Abschnitt führt dich durch die Installation und Einrichtung von Ripster.
|
||||
|
||||
## Überblick
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-list-check: **Voraussetzungen**
|
||||
|
||||
---
|
||||
|
||||
Systemanforderungen und externe Tools, die vor der Installation benötigt werden.
|
||||
|
||||
[:octicons-arrow-right-24: Voraussetzungen prüfen](prerequisites.md)
|
||||
|
||||
- :material-download: **Installation**
|
||||
|
||||
---
|
||||
|
||||
Schritt-für-Schritt-Anleitung zur Installation von Ripster.
|
||||
|
||||
[:octicons-arrow-right-24: Installation starten](installation.md)
|
||||
|
||||
- :material-tune: **Konfiguration**
|
||||
|
||||
---
|
||||
|
||||
Einrichten von Pfaden, API-Keys und Encoding-Presets.
|
||||
|
||||
[:octicons-arrow-right-24: Konfigurieren](configuration.md)
|
||||
|
||||
- :material-rocket-launch: **Schnellstart**
|
||||
|
||||
---
|
||||
|
||||
Rippe deinen ersten Film in wenigen Minuten.
|
||||
|
||||
[:octicons-arrow-right-24: Loslegen](quickstart.md)
|
||||
|
||||
</div>
|
||||
140
docs/getting-started/installation.md
Normal file
140
docs/getting-started/installation.md
Normal file
@@ -0,0 +1,140 @@
|
||||
# Installation
|
||||
|
||||
---
|
||||
|
||||
## Repository klonen
|
||||
|
||||
```bash
|
||||
git clone https://github.com/YOUR_GITHUB_USERNAME/ripster.git
|
||||
cd ripster
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Automatischer Start
|
||||
|
||||
Ripster enthält ein `start.sh`-Skript, das alle Abhängigkeiten installiert und Backend + Frontend gleichzeitig startet:
|
||||
|
||||
```bash
|
||||
./start.sh
|
||||
```
|
||||
|
||||
Das Skript führt automatisch folgende Schritte durch:
|
||||
|
||||
1. **Node.js-Versionscheck** – prüft ob >= 20.19.0 verfügbar ist (mit nvm/npx-Fallback)
|
||||
2. **Abhängigkeiten installieren** – `npm install` für Root, Backend und Frontend
|
||||
3. **Dienste starten** – Backend und Frontend werden parallel gestartet
|
||||
|
||||
!!! success "Erfolgreich gestartet"
|
||||
- Backend läuft auf `http://localhost:3001`
|
||||
- Frontend läuft auf `http://localhost:5173`
|
||||
|
||||
---
|
||||
|
||||
## Manuelle Installation
|
||||
|
||||
Falls du mehr Kontrolle benötigst:
|
||||
|
||||
```bash
|
||||
# Root-Abhängigkeiten
|
||||
npm install
|
||||
|
||||
# Backend-Abhängigkeiten
|
||||
cd backend && npm install && cd ..
|
||||
|
||||
# Frontend-Abhängigkeiten
|
||||
cd frontend && npm install && cd ..
|
||||
|
||||
# Backend starten (Terminal 1)
|
||||
cd backend && npm run dev
|
||||
|
||||
# Frontend starten (Terminal 2)
|
||||
cd frontend && npm run dev
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Umgebungsvariablen konfigurieren
|
||||
|
||||
### Backend
|
||||
|
||||
```bash
|
||||
cp backend/.env.example backend/.env
|
||||
```
|
||||
|
||||
Bearbeite `backend/.env`:
|
||||
|
||||
```env
|
||||
PORT=3001
|
||||
DB_PATH=./data/ripster.db
|
||||
CORS_ORIGIN=http://localhost:5173
|
||||
LOG_DIR=./logs
|
||||
LOG_LEVEL=info
|
||||
```
|
||||
|
||||
### Frontend
|
||||
|
||||
```bash
|
||||
cp frontend/.env.example frontend/.env
|
||||
```
|
||||
|
||||
Bearbeite `frontend/.env`:
|
||||
|
||||
```env
|
||||
VITE_API_BASE=http://localhost:3001
|
||||
VITE_WS_URL=ws://localhost:3001
|
||||
```
|
||||
|
||||
!!! tip "Alle Umgebungsvariablen"
|
||||
Eine vollständige Übersicht aller Umgebungsvariablen findest du unter [Umgebungsvariablen](../configuration/environment.md).
|
||||
|
||||
---
|
||||
|
||||
## Datenbank initialisieren
|
||||
|
||||
Die SQLite-Datenbank wird **automatisch** beim ersten Start erstellt und mit dem Schema aus `db/schema.sql` initialisiert. Es sind keine manuellen Datenbankschritte erforderlich.
|
||||
|
||||
```
|
||||
backend/data/
|
||||
└── ripster.db ← Wird automatisch angelegt
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Stoppen
|
||||
|
||||
```bash
|
||||
./kill.sh
|
||||
```
|
||||
|
||||
Das Skript beendet Backend- und Frontend-Prozesse graceful.
|
||||
|
||||
---
|
||||
|
||||
## Verzeichnisstruktur nach Installation
|
||||
|
||||
```
|
||||
ripster/
|
||||
├── backend/
|
||||
│ ├── data/ ← SQLite-Datenbank (nach erstem Start)
|
||||
│ ├── logs/ ← Log-Dateien
|
||||
│ ├── node_modules/ ← Backend-Abhängigkeiten
|
||||
│ └── .env ← Backend-Konfiguration
|
||||
├── frontend/
|
||||
│ ├── node_modules/ ← Frontend-Abhängigkeiten
|
||||
│ ├── dist/ ← Production-Build (nach npm run build)
|
||||
│ └── .env ← Frontend-Konfiguration
|
||||
└── node_modules/ ← Root-Abhängigkeiten (concurrently etc.)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Nächste Schritte
|
||||
|
||||
Nach erfolgreicher Installation:
|
||||
|
||||
1. Öffne [http://localhost:5173](http://localhost:5173)
|
||||
2. Navigiere zu **Einstellungen**
|
||||
3. Konfiguriere Pfade, API-Keys und Encoding-Presets
|
||||
|
||||
[:octicons-arrow-right-24: Zur Konfiguration](configuration.md)
|
||||
158
docs/getting-started/prerequisites.md
Normal file
158
docs/getting-started/prerequisites.md
Normal file
@@ -0,0 +1,158 @@
|
||||
# Voraussetzungen
|
||||
|
||||
Bevor du Ripster installierst, stelle sicher, dass folgende Software auf deinem System verfügbar ist.
|
||||
|
||||
---
|
||||
|
||||
## System-Anforderungen
|
||||
|
||||
| Anforderung | Mindestversion | Empfohlen |
|
||||
|------------|----------------|-----------|
|
||||
| **Betriebssystem** | Linux / macOS | Ubuntu 22.04+ |
|
||||
| **Node.js** | 20.19.0 | 20.x LTS |
|
||||
| **RAM** | 4 GB | 8 GB+ |
|
||||
| **Festplatte** | 50 GB frei | 500 GB+ (für Roh-MKVs) |
|
||||
|
||||
---
|
||||
|
||||
## Node.js
|
||||
|
||||
Ripster benötigt **Node.js >= 20.19.0**.
|
||||
|
||||
=== "nvm (empfohlen)"
|
||||
|
||||
```bash
|
||||
# nvm installieren
|
||||
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
|
||||
|
||||
# Node.js 20 installieren
|
||||
nvm install 20
|
||||
nvm use 20
|
||||
|
||||
# Version prüfen
|
||||
node --version # v20.x.x
|
||||
```
|
||||
|
||||
=== "Ubuntu/Debian"
|
||||
|
||||
```bash
|
||||
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
|
||||
sudo apt-get install -y nodejs
|
||||
|
||||
node --version # v20.x.x
|
||||
```
|
||||
|
||||
=== "macOS (Homebrew)"
|
||||
|
||||
```bash
|
||||
brew install node@20
|
||||
node --version # v20.x.x
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Externe Tools
|
||||
|
||||
### MakeMKV
|
||||
|
||||
!!! warning "Lizenz erforderlich"
|
||||
MakeMKV ist für den persönlichen Gebrauch kostenlos (Beta-Lizenz), benötigt aber eine gültige Lizenz.
|
||||
|
||||
```bash
|
||||
# Ubuntu/Debian - PPA verwenden
|
||||
sudo add-apt-repository ppa:heyarje/makemkv-beta
|
||||
sudo apt-get update
|
||||
sudo apt-get install makemkv-bin makemkv-oss
|
||||
|
||||
# Installierte Version prüfen
|
||||
makemkvcon --version
|
||||
```
|
||||
|
||||
[:octicons-link-external-24: MakeMKV Download](https://www.makemkv.com/download/){ .md-button }
|
||||
|
||||
### HandBrake CLI
|
||||
|
||||
```bash
|
||||
# Ubuntu/Debian
|
||||
sudo add-apt-repository ppa:stebbins/handbrake-releases
|
||||
sudo apt-get update
|
||||
sudo apt-get install handbrake-cli
|
||||
|
||||
# Version prüfen
|
||||
HandBrakeCLI --version
|
||||
|
||||
# macOS
|
||||
brew install handbrake
|
||||
```
|
||||
|
||||
[:octicons-link-external-24: HandBrake Download](https://handbrake.fr/downloads2.php){ .md-button }
|
||||
|
||||
### MediaInfo
|
||||
|
||||
```bash
|
||||
# Ubuntu/Debian
|
||||
sudo apt-get install mediainfo
|
||||
|
||||
# macOS
|
||||
brew install mediainfo
|
||||
|
||||
# Version prüfen
|
||||
mediainfo --Version
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Disc-Laufwerk
|
||||
|
||||
Ripster benötigt ein physisches **DVD- oder Blu-ray-Laufwerk**.
|
||||
|
||||
!!! info "Blu-ray unter Linux"
|
||||
Für Blu-ray-Ripping unter Linux wird zusätzlich `libaacs` benötigt. MakeMKV bringt jedoch eine eigene Entschlüsselung mit, daher ist dies in den meisten Fällen nicht erforderlich.
|
||||
|
||||
```bash
|
||||
# Laufwerk prüfen
|
||||
ls /dev/sr*
|
||||
# oder
|
||||
lsblk | grep rom
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## OMDb API-Key
|
||||
|
||||
Ripster verwendet die [OMDb API](https://www.omdbapi.com/) für Filmmetadaten.
|
||||
|
||||
1. Registriere dich kostenlos auf [omdbapi.com](https://www.omdbapi.com/apikey.aspx)
|
||||
2. Bestätige deine E-Mail-Adresse
|
||||
3. Notiere deinen API-Key – du gibst ihn später in den Einstellungen ein
|
||||
|
||||
---
|
||||
|
||||
## Optionale Voraussetzungen
|
||||
|
||||
### PushOver (Benachrichtigungen)
|
||||
|
||||
Für mobile Push-Benachrichtigungen bei Fertigstellung oder Fehlern:
|
||||
|
||||
- App kaufen auf [pushover.net](https://pushover.net) (~5 USD einmalig)
|
||||
- **User Key** und **API Token** notieren
|
||||
|
||||
### SSH-Zugang (Deployment)
|
||||
|
||||
Für Remote-Deployment via `deploy-ripster.sh`:
|
||||
|
||||
```bash
|
||||
# sshpass installieren
|
||||
sudo apt-get install sshpass
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Checkliste
|
||||
|
||||
- [ ] Node.js >= 20.19.0 installiert (`node --version`)
|
||||
- [ ] `makemkvcon` installiert (`makemkvcon --version`)
|
||||
- [ ] `HandBrakeCLI` installiert (`HandBrakeCLI --version`)
|
||||
- [ ] `mediainfo` installiert (`mediainfo --Version`)
|
||||
- [ ] DVD/Blu-ray Laufwerk vorhanden (`ls /dev/sr*`)
|
||||
- [ ] OMDb API-Key beschafft
|
||||
144
docs/getting-started/quickstart.md
Normal file
144
docs/getting-started/quickstart.md
Normal file
@@ -0,0 +1,144 @@
|
||||
# Schnellstart
|
||||
|
||||
Nach der [Installation](installation.md) und [Konfiguration](configuration.md) kannst du sofort mit dem ersten Rip beginnen.
|
||||
|
||||
---
|
||||
|
||||
## 1. Ripster starten
|
||||
|
||||
```bash
|
||||
cd ripster
|
||||
./start.sh
|
||||
```
|
||||
|
||||
Öffne [http://localhost:5173](http://localhost:5173) im Browser.
|
||||
|
||||
---
|
||||
|
||||
## 2. Dashboard
|
||||
|
||||
Das Dashboard zeigt den aktuellen Pipeline-Status:
|
||||
|
||||
```
|
||||
Status: IDLE – Bereit
|
||||
Warte auf Disc...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Disc einlegen
|
||||
|
||||
Lege eine DVD oder Blu-ray in das Laufwerk ein. Ripster erkennt die Disc automatisch (Polling-Intervall konfigurierbar, Standard: 5 Sekunden) und wechselt in den Status **ANALYZING**.
|
||||
|
||||
!!! tip "Manuelle Analyse"
|
||||
Falls die Disc nicht automatisch erkannt wird, kann über die API eine manuelle Analyse ausgelöst werden:
|
||||
```bash
|
||||
curl -X POST http://localhost:3001/api/pipeline/analyze
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Analyse abwarten
|
||||
|
||||
MakeMKV analysiert die Disc-Struktur. Dieser Vorgang dauert je nach Disc **30 Sekunden bis 5 Minuten**.
|
||||
|
||||
Der Fortschritt wird live im Dashboard angezeigt.
|
||||
|
||||
---
|
||||
|
||||
## 5. Metadaten auswählen
|
||||
|
||||
Nach der Analyse öffnet sich der **Metadaten-Dialog**:
|
||||
|
||||
1. **Titel suchen**: Gib den Filmtitel in die Suchleiste ein
|
||||
2. **Ergebnis auswählen**: Wähle den passenden Film aus der OMDb-Liste
|
||||
3. **Playlist wählen** *(nur Blu-ray)*: Bei Blu-rays mit mehreren Playlists zeigt Ripster eine Analyse der wahrscheinlich korrekten Playlist an
|
||||
4. **Bestätigen**: Klicke auf "Bestätigen"
|
||||
|
||||
!!! info "Playlist-Obfuskierung"
|
||||
Einige Blu-rays enthalten absichtlich viele Fake-Playlists. Ripster analysiert diese automatisch und schlägt die wahrscheinlich korrekte Playlist vor.
|
||||
|
||||
---
|
||||
|
||||
## 6. Ripping starten
|
||||
|
||||
Nach der Metadaten-Auswahl wechselt der Status zu **READY_TO_START**.
|
||||
|
||||
Klicke auf **"Starten"** – MakeMKV beginnt mit dem Ripping.
|
||||
|
||||
**Typische Dauer:**
|
||||
- DVD: 20–40 Minuten
|
||||
- Blu-ray: 45–120 Minuten
|
||||
|
||||
---
|
||||
|
||||
## 7. Encode-Review
|
||||
|
||||
Nach dem Ripping analysiert MediaInfo die Track-Struktur. Im **Encode-Review** kannst du:
|
||||
|
||||
- **Audio-Tracks** auswählen (z. B. Deutsch + Englisch)
|
||||
- **Untertitel-Tracks** auswählen
|
||||
- Überflüssige Tracks deaktivieren
|
||||
|
||||
Klicke auf **"Encodierung bestätigen"**.
|
||||
|
||||
---
|
||||
|
||||
## 8. Encoding
|
||||
|
||||
HandBrake encodiert die Datei mit dem konfigurierten Preset.
|
||||
|
||||
**Fortschrittsanzeige:**
|
||||
- Aktueller Prozentsatz
|
||||
- Geschätzte Restzeit (ETA)
|
||||
- Encoding-Geschwindigkeit (FPS)
|
||||
|
||||
---
|
||||
|
||||
## 9. Fertig!
|
||||
|
||||
Status wechselt zu **FINISHED**. Die encodierte Datei liegt im konfigurierten `movie_dir`.
|
||||
|
||||
```
|
||||
/mnt/nas/movies/
|
||||
└── Inception (2010).mkv ← Fertige Datei
|
||||
```
|
||||
|
||||
!!! success "PushOver-Benachrichtigung"
|
||||
Falls PushOver konfiguriert ist, erhältst du eine Push-Benachrichtigung auf dein Mobilgerät.
|
||||
|
||||
---
|
||||
|
||||
## Workflow-Zusammenfassung
|
||||
|
||||
```
|
||||
Disc einlegen
|
||||
↓
|
||||
ANALYZING (MakeMKV analysiert)
|
||||
↓
|
||||
METADATA_SELECTION (Titel & Playlist wählen)
|
||||
↓
|
||||
READY_TO_START → [Starten]
|
||||
↓
|
||||
RIPPING (MakeMKV rippt)
|
||||
↓
|
||||
MEDIAINFO_CHECK (Track-Analyse)
|
||||
↓
|
||||
READY_TO_ENCODE → [Bestätigen]
|
||||
↓
|
||||
ENCODING (HandBrake encodiert)
|
||||
↓
|
||||
FINISHED ✓
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Was tun bei Fehlern?
|
||||
|
||||
Falls ein Job in den Status **ERROR** wechselt:
|
||||
|
||||
1. Klicke auf **"Details"** im Dashboard
|
||||
2. Prüfe die Log-Ausgabe
|
||||
3. Klicke auf **"Retry"** um den Job erneut zu versuchen
|
||||
|
||||
Logs findest du auch in der [History-Seite](http://localhost:5173/history).
|
||||
130
docs/index.md
Normal file
130
docs/index.md
Normal file
@@ -0,0 +1,130 @@
|
||||
# Ripster
|
||||
|
||||
**Halbautomatische Disc-Ripping-Plattform für DVDs und Blu-rays**
|
||||
|
||||
---
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-disc: **Automatisiertes Ripping**
|
||||
|
||||
---
|
||||
|
||||
Disc einlegen – Ripster erkennt sie automatisch und startet den Analyse-Workflow mit MakeMKV.
|
||||
|
||||
[:octicons-arrow-right-24: Workflow verstehen](pipeline/workflow.md)
|
||||
|
||||
- :material-movie-open: **Metadata-Integration**
|
||||
|
||||
---
|
||||
|
||||
Automatische Suche in der OMDb-Datenbank für Filmtitel, Poster und IMDb-IDs.
|
||||
|
||||
[:octicons-arrow-right-24: Konfiguration](getting-started/configuration.md)
|
||||
|
||||
- :material-cog: **Flexibles Encoding**
|
||||
|
||||
---
|
||||
|
||||
HandBrake-Encoding mit individueller Track-Auswahl für Audio- und Untertitelspuren.
|
||||
|
||||
[:octicons-arrow-right-24: Encode-Planung](pipeline/encoding.md)
|
||||
|
||||
- :material-history: **Job-Historie**
|
||||
|
||||
---
|
||||
|
||||
Vollständiges Audit-Trail aller Ripping-Jobs mit Logs und Re-Encode-Funktion.
|
||||
|
||||
[:octicons-arrow-right-24: History API](api/history.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Was ist Ripster?
|
||||
|
||||
Ripster ist eine webbasierte Anwendung zur **halbautomatischen Digitalisierung** von DVDs und Blu-rays. Die Anwendung kombiniert bewährte Open-Source-Tools zu einem durchgängigen, komfortablen Workflow:
|
||||
|
||||
```
|
||||
Disc einlegen → Erkennung → Analyse → Metadaten wählen → Rippen → Encodieren → Fertig
|
||||
```
|
||||
|
||||
### Kernfunktionen
|
||||
|
||||
| Feature | Beschreibung |
|
||||
|---------|-------------|
|
||||
| **Echtzeit-Updates** | WebSocket-basierte Live-Statusanzeige ohne Reload |
|
||||
| **Intelligente Playlist-Analyse** | Erkennt Blu-ray Playlist-Verschleierung (Fake-Playlists) |
|
||||
| **Track-Auswahl** | Individuelle Auswahl von Audio- und Untertitelspuren |
|
||||
| **Orphan-Recovery** | Import von bereits gerippten Dateien als Jobs |
|
||||
| **PushOver-Benachrichtigungen** | Mobile Alerts bei Fertigstellung oder Fehlern |
|
||||
| **DB-Korruptions-Recovery** | Automatische Quarantäne bei korrupten SQLite-Dateien |
|
||||
| **Re-Encoding** | Erneutes Encodieren ohne neu rippen |
|
||||
|
||||
---
|
||||
|
||||
## Technologie-Stack
|
||||
|
||||
=== "Backend"
|
||||
|
||||
- **Node.js** >= 20.19.0 mit Express.js
|
||||
- **SQLite3** mit automatischen Schema-Migrationen
|
||||
- **WebSocket** (`ws`) für Echtzeit-Kommunikation
|
||||
- Externe CLI-Tools: `makemkvcon`, `HandBrakeCLI`, `mediainfo`
|
||||
|
||||
=== "Frontend"
|
||||
|
||||
- **React** 18.3.1 mit React Router
|
||||
- **Vite** 5.4.12 als Build-Tool
|
||||
- **PrimeReact** 10.9.2 als UI-Bibliothek
|
||||
- WebSocket-Client für Live-Updates
|
||||
|
||||
=== "Externe Tools"
|
||||
|
||||
| Tool | Zweck |
|
||||
|------|-------|
|
||||
| `makemkvcon` | Disc-Analyse & MKV/Backup-Ripping |
|
||||
| `HandBrakeCLI` | Video-Encoding |
|
||||
| `mediainfo` | Track-Informationen aus gerippten Dateien |
|
||||
| OMDb API | Filmmetadaten (Titel, Poster, IMDb-ID) |
|
||||
|
||||
---
|
||||
|
||||
## Schnellstart
|
||||
|
||||
```bash
|
||||
# 1. Repository klonen
|
||||
git clone https://github.com/YOUR_GITHUB_USERNAME/ripster.git
|
||||
cd ripster
|
||||
|
||||
# 2. Starten (Node.js >= 20 erforderlich)
|
||||
./start.sh
|
||||
|
||||
# 3. Browser öffnen
|
||||
open http://localhost:5173
|
||||
```
|
||||
|
||||
!!! tip "Erste Schritte"
|
||||
Die vollständige Installationsanleitung mit allen Voraussetzungen findest du unter [Erste Schritte](getting-started/index.md).
|
||||
|
||||
---
|
||||
|
||||
## Pipeline-Überblick
|
||||
|
||||
```mermaid
|
||||
stateDiagram-v2
|
||||
[*] --> IDLE
|
||||
IDLE --> ANALYZING: Disc erkannt
|
||||
ANALYZING --> METADATA_SELECTION: Analyse abgeschlossen
|
||||
METADATA_SELECTION --> READY_TO_START: Metadaten bestätigt
|
||||
READY_TO_START --> RIPPING: Start gedrückt
|
||||
RIPPING --> MEDIAINFO_CHECK: MKV erstellt
|
||||
MEDIAINFO_CHECK --> READY_TO_ENCODE: Tracks analysiert
|
||||
READY_TO_ENCODE --> ENCODING: Encode bestätigt
|
||||
ENCODING --> FINISHED: Encoding fertig
|
||||
ENCODING --> ERROR: Fehler
|
||||
RIPPING --> ERROR: Fehler
|
||||
ERROR --> [*]
|
||||
FINISHED --> [*]
|
||||
```
|
||||
159
docs/pipeline/encoding.md
Normal file
159
docs/pipeline/encoding.md
Normal file
@@ -0,0 +1,159 @@
|
||||
# Encode-Planung
|
||||
|
||||
`encodePlan.js` analysiert die MediaInfo-Ausgabe und erstellt einen strukturierten Encode-Plan mit Track-Auswahl.
|
||||
|
||||
---
|
||||
|
||||
## Ablauf
|
||||
|
||||
```
|
||||
MediaInfo-JSON
|
||||
↓
|
||||
Track-Parsing (Video, Audio, Untertitel)
|
||||
↓
|
||||
Sprach-Normalisierung (ISO 639-1 → 639-3)
|
||||
↓
|
||||
Codec-Klassifizierung (copy-kompatibel / transcode)
|
||||
↓
|
||||
Encode-Plan generieren
|
||||
↓
|
||||
Benutzer-Review im Frontend
|
||||
↓
|
||||
HandBrake-CLI-Argumente aufbauen
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Encode-Plan-Format
|
||||
|
||||
Der generierte Plan wird als JSON im Job-Datensatz gespeichert:
|
||||
|
||||
```json
|
||||
{
|
||||
"inputFile": "/mnt/raw/Inception_t00.mkv",
|
||||
"outputFile": "/mnt/movies/Inception (2010).mkv",
|
||||
"preset": "H.265 MKV 1080p30",
|
||||
"audioTracks": [
|
||||
{
|
||||
"index": 1,
|
||||
"codec": "dts",
|
||||
"language": "deu",
|
||||
"channels": 6,
|
||||
"label": "Deutsch (DTS, 5.1)",
|
||||
"copyCompatible": false,
|
||||
"selected": true
|
||||
},
|
||||
{
|
||||
"index": 2,
|
||||
"codec": "truehd",
|
||||
"language": "eng",
|
||||
"channels": 8,
|
||||
"label": "English (TrueHD, 7.1)",
|
||||
"copyCompatible": true,
|
||||
"selected": true
|
||||
}
|
||||
],
|
||||
"subtitleTracks": [
|
||||
{
|
||||
"index": 1,
|
||||
"language": "deu",
|
||||
"label": "Deutsch",
|
||||
"selected": true
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Sprach-Normalisierung
|
||||
|
||||
MediaInfo liefert Sprachcodes in verschiedenen Formaten. `encodePlan.js` normalisiert diese auf **ISO 639-3**:
|
||||
|
||||
| MediaInfo-Output | Normalisiert |
|
||||
|----------------|-------------|
|
||||
| `de` | `deu` |
|
||||
| `German` | `deu` |
|
||||
| `en` | `eng` |
|
||||
| `English` | `eng` |
|
||||
| `fr` | `fra` |
|
||||
| `ja` | `jpn` |
|
||||
|
||||
---
|
||||
|
||||
## Codec-Klassifizierung
|
||||
|
||||
HandBrake kann einige Codecs direkt kopieren (ohne Transcoding):
|
||||
|
||||
| Codec | Copy-kompatibel | HandBrake-Encoder |
|
||||
|-------|----------------|------------------|
|
||||
| `ac3` | ✅ Ja | `copy:ac3` |
|
||||
| `aac` | ✅ Ja | `copy:aac` |
|
||||
| `mp3` | ✅ Ja | `copy:mp3` |
|
||||
| `truehd` | ✅ Ja | `copy:truehd` |
|
||||
| `eac3` | ✅ Ja | `copy:eac3` |
|
||||
| `dts` | ❌ Nein | `ffaac` (transcode) |
|
||||
| `dtshd` | ❌ Nein | `ffaac` (transcode) |
|
||||
|
||||
!!! info "DTS-Transcoding"
|
||||
HandBrake unterstützt kein DTS-Passthrough in den Standard-Builds. DTS-Tracks werden zu AAC transcodiert, es sei denn, du verwendest einen speziellen HandBrake-Build mit DTS-Unterstützung.
|
||||
|
||||
---
|
||||
|
||||
## HandBrake-CLI-Argumente
|
||||
|
||||
Aus dem Encode-Plan generiert `commandLine.js` die HandBrake-Argumente:
|
||||
|
||||
```bash
|
||||
HandBrakeCLI \
|
||||
--input "/mnt/raw/Inception_t00.mkv" \
|
||||
--output "/mnt/movies/Inception (2010).mkv" \
|
||||
--preset "H.265 MKV 1080p30" \
|
||||
--audio 1,2 \
|
||||
--aencoder copy:truehd,ffaac \
|
||||
--subtitle 1 \
|
||||
--subtitle-default 1
|
||||
```
|
||||
|
||||
### Zusätzliche Argumente
|
||||
|
||||
Über die Einstellung `handbrake_extra_args` können beliebige HandBrake-Argumente ergänzt werden:
|
||||
|
||||
```
|
||||
--crop 0:0:0:0 --loose-anamorphic
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Dateiname-Template
|
||||
|
||||
Die Ausgabedatei wird über das konfigurierte Template benannt:
|
||||
|
||||
```
|
||||
Template: {title} ({year})
|
||||
Ergebnis: Inception (2010).mkv
|
||||
```
|
||||
|
||||
Verfügbare Platzhalter:
|
||||
|
||||
| Platzhalter | Wert |
|
||||
|------------|------|
|
||||
| `{title}` | Filmtitel von OMDb |
|
||||
| `{year}` | Erscheinungsjahr |
|
||||
| `{imdb_id}` | IMDb-ID (z.B. `tt1375666`) |
|
||||
| `{type}` | `movie` oder `series` |
|
||||
|
||||
Sonderzeichen im Dateinamen werden automatisch sanitisiert (`:`, `/`, `?` etc. werden entfernt oder ersetzt).
|
||||
|
||||
---
|
||||
|
||||
## Re-Encoding
|
||||
|
||||
Abgeschlossene Jobs können mit geänderten Einstellungen neu encodiert werden:
|
||||
|
||||
1. Job in der History auswählen
|
||||
2. "Re-Encode" klicken
|
||||
3. Neue Track-Auswahl treffen (oder bestehende übernehmen)
|
||||
4. Encoding startet mit aktuellen Einstellungen
|
||||
|
||||
Dies ist nützlich, wenn sich das HandBrake-Preset oder die Track-Auswahl geändert hat, ohne die zeitintensive Ripping-Phase zu wiederholen.
|
||||
31
docs/pipeline/index.md
Normal file
31
docs/pipeline/index.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Pipeline
|
||||
|
||||
Der Pipeline-Abschnitt beschreibt den Kern-Workflow von Ripster.
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-state-machine: **Workflow & Zustände**
|
||||
|
||||
---
|
||||
|
||||
Der vollständige Ripping-Workflow mit allen Zustandsübergängen.
|
||||
|
||||
[:octicons-arrow-right-24: Workflow](workflow.md)
|
||||
|
||||
- :material-film: **Encode-Planung**
|
||||
|
||||
---
|
||||
|
||||
Wie Ripster Audio- und Untertitel-Tracks analysiert und Encode-Pläne erstellt.
|
||||
|
||||
[:octicons-arrow-right-24: Encoding](encoding.md)
|
||||
|
||||
- :material-playlist-check: **Playlist-Analyse**
|
||||
|
||||
---
|
||||
|
||||
Erkennung von Blu-ray Playlist-Obfuskierung und Auswahl der korrekten Playlist.
|
||||
|
||||
[:octicons-arrow-right-24: Playlist-Analyse](playlist-analysis.md)
|
||||
|
||||
</div>
|
||||
119
docs/pipeline/playlist-analysis.md
Normal file
119
docs/pipeline/playlist-analysis.md
Normal file
@@ -0,0 +1,119 @@
|
||||
# Playlist-Analyse
|
||||
|
||||
Einige Blu-rays verwenden **Playlist-Obfuskierung** als Kopierschutz-Mechanismus. Ripster erkennt dieses Muster und hilft bei der Auswahl der korrekten Playlist.
|
||||
|
||||
---
|
||||
|
||||
## Das Problem: Playlist-Obfuskierung
|
||||
|
||||
Moderne Blu-rays können Hunderte von Playlists enthalten, von denen nur eine den eigentlichen Film enthält. Die anderen sind:
|
||||
|
||||
- **Kurze Dummy-Playlists** (wenige Sekunden bis Minuten)
|
||||
- **Umgeordnete Segmente** (falsche Reihenfolge der Film-Segmente)
|
||||
- **Duplizierte Inhalte** (mehrere Playlists mit gleichem Inhalt, verschiedenen Timestamps)
|
||||
|
||||
Dies macht es schwierig, die korrekte Playlist manuell zu identifizieren.
|
||||
|
||||
---
|
||||
|
||||
## Ripsters Analyse-Algorithmus
|
||||
|
||||
`playlistAnalysis.js` analysiert alle von MakeMKV erkannten Playlists nach mehreren Kriterien:
|
||||
|
||||
### 1. Laufzeit-Matching
|
||||
|
||||
Die erwartete Laufzeit (aus OMDb-Metadaten) wird mit der Playlist-Laufzeit verglichen:
|
||||
|
||||
```
|
||||
Filmtitel: Inception (2010)
|
||||
OMDb-Laufzeit: 148 Minuten
|
||||
|
||||
Playlist 00800.mpls: 148:22 → ✅ Match
|
||||
Playlist 00801.mpls: 1:23 → ❌ Zu kurz
|
||||
Playlist 00900.mpls: 148:25 → ✅ Match (Duplikat?)
|
||||
```
|
||||
|
||||
### 2. Titel-Ähnlichkeit
|
||||
|
||||
Playlists mit Namen, die dem Filmtitel ähneln, werden bevorzugt.
|
||||
|
||||
### 3. Segment-Validierung
|
||||
|
||||
Die Playlist-Segmente werden auf logische Reihenfolge geprüft.
|
||||
|
||||
### 4. Häufigkeits-Analyse
|
||||
|
||||
Bei mehreren Kandidaten: Welche Segment-Kombination kommt am häufigsten vor?
|
||||
|
||||
---
|
||||
|
||||
## Benutzer-Interface
|
||||
|
||||
Wenn Playlist-Obfuskierung erkannt wird, zeigt Ripster im `MetadataSelectionDialog` eine Playlist-Auswahl:
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────┐
|
||||
│ Playlist auswählen │
|
||||
├─────────────────────────────────────────────────────┤
|
||||
│ ★ 00800.mpls 2:28:05 ✓ Empfohlen (Laufzeit passt) │
|
||||
│ 00801.mpls 0:01:23 Kurz (wahrscheinlich Menü) │
|
||||
│ 00900.mpls 2:28:12 Mögliche Alternative │
|
||||
│ 00901.mpls 0:00:45 Kurz │
|
||||
│ ... ... ... │
|
||||
├─────────────────────────────────────────────────────┤
|
||||
│ Hinweis: 847 Playlists gefunden – Analyse empfiehlt │
|
||||
│ Playlist 00800.mpls als Hauptfilm. │
|
||||
└─────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Analyse-Ergebnis-Format
|
||||
|
||||
```json
|
||||
{
|
||||
"candidates": [
|
||||
{
|
||||
"playlist": "00800.mpls",
|
||||
"duration": "2:28:05",
|
||||
"durationSeconds": 8885,
|
||||
"score": 0.95,
|
||||
"recommended": true,
|
||||
"reasons": ["Laufzeit stimmt mit OMDb überein", "Häufigste Segment-Kombination"]
|
||||
},
|
||||
{
|
||||
"playlist": "00900.mpls",
|
||||
"duration": "2:28:12",
|
||||
"durationSeconds": 8892,
|
||||
"score": 0.72,
|
||||
"recommended": false,
|
||||
"reasons": ["Ähnliche Laufzeit", "Seltene Segment-Kombination"]
|
||||
}
|
||||
],
|
||||
"totalPlaylists": 847,
|
||||
"recommendation": "00800.mpls"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Manuelle Auswahl
|
||||
|
||||
Falls die automatische Empfehlung nicht korrekt ist:
|
||||
|
||||
1. Wähle eine andere Playlist aus der Liste
|
||||
2. Beachte die Laufzeit-Angabe
|
||||
3. Vergleiche mit der erwarteten Filmlänge (aus OMDb oder Disc-Hülle)
|
||||
|
||||
!!! tip "Tipp"
|
||||
Bei Blu-rays von bekannten Filmen kannst du die korrekte Playlist oft über Foren wie [MakeMKV-Forum](https://www.makemkv.com/forum/) verifizieren.
|
||||
|
||||
---
|
||||
|
||||
## Konfiguration
|
||||
|
||||
Die Playlist-Analyse ist automatisch aktiv. Einstellbar ist:
|
||||
|
||||
| Parameter | Beschreibung |
|
||||
|----------|-------------|
|
||||
| `makemkv_min_length_minutes` | Mindestlänge, um als Hauptfilm-Kandidat zu gelten (Standard: 15 Min) |
|
||||
222
docs/pipeline/workflow.md
Normal file
222
docs/pipeline/workflow.md
Normal file
@@ -0,0 +1,222 @@
|
||||
# Workflow & Zustände
|
||||
|
||||
Der Ripping-Workflow von Ripster ist als **State Machine** implementiert. Jeder Zustand hat klar definierte Übergangsbedingungen und Aktionen.
|
||||
|
||||
---
|
||||
|
||||
## Zustandsdiagramm
|
||||
|
||||
```mermaid
|
||||
stateDiagram-v2
|
||||
direction LR
|
||||
[*] --> IDLE
|
||||
|
||||
IDLE --> ANALYZING: Disc erkannt\n(automatisch)
|
||||
ANALYZING --> METADATA_SELECTION: MakeMKV-Analyse\nabgeschlossen
|
||||
METADATA_SELECTION --> READY_TO_START: Benutzer wählt\nMetadaten + Playlist
|
||||
|
||||
READY_TO_START --> RIPPING: Benutzer startet\nden Job
|
||||
|
||||
RIPPING --> MEDIAINFO_CHECK: MKV/Backup\nerstellt
|
||||
MEDIAINFO_CHECK --> READY_TO_ENCODE: Track-Analyse\nabgeschlossen
|
||||
|
||||
READY_TO_ENCODE --> ENCODING: Benutzer bestätigt\nEncode + Tracks
|
||||
|
||||
ENCODING --> FINISHED: HandBrake\nfertig
|
||||
FINISHED --> IDLE: Disc auswerfen /\nneue Disc
|
||||
|
||||
RIPPING --> ERROR: Fehler
|
||||
ENCODING --> ERROR: Fehler
|
||||
ANALYZING --> ERROR: Fehler
|
||||
ERROR --> IDLE: cancelPipeline()\noder retryJob()
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Zustandsbeschreibungen
|
||||
|
||||
### IDLE
|
||||
|
||||
**Ausgangszustand.** Ripster wartet auf eine Disc.
|
||||
|
||||
- `diskDetectionService` pollt das Laufwerk (Intervall konfigurierbar)
|
||||
- Bei Disc-Erkennung: Automatischer Übergang zu `ANALYZING`
|
||||
- WebSocket-Event: `DISC_DETECTED`
|
||||
|
||||
---
|
||||
|
||||
### ANALYZING
|
||||
|
||||
**MakeMKV analysiert die Disc-Struktur.**
|
||||
|
||||
```bash
|
||||
makemkvcon -r info disc:0
|
||||
```
|
||||
|
||||
- Liest Titel-Informationen, Playlist-Liste, Track-Details
|
||||
- Fortschritt wird über WebSocket übertragen
|
||||
- Bei Blu-ray: Playlist-Liste für spätere Analyse gesammelt
|
||||
- Dauer: 30 Sekunden bis 5 Minuten
|
||||
|
||||
**Ausgabe:** JSON-Struktur mit allen Titeln und Playlists
|
||||
|
||||
---
|
||||
|
||||
### METADATA_SELECTION
|
||||
|
||||
**Wartet auf Benutzer-Eingabe.**
|
||||
|
||||
- `MetadataSelectionDialog` wird im Frontend angezeigt
|
||||
- Benutzer sucht in OMDb nach dem Filmtitel
|
||||
- Benutzer wählt einen Eintrag aus den Suchergebnissen
|
||||
- Bei Blu-ray: Playlist-Auswahl (mit Empfehlung durch `playlistAnalysis.js`)
|
||||
|
||||
**Übergang:** `selectMetadata(jobId, omdbData, playlist)` aufrufen
|
||||
|
||||
---
|
||||
|
||||
### READY_TO_START
|
||||
|
||||
**Metadaten bestätigt, bereit zum Starten.**
|
||||
|
||||
- Job-Datensatz in Datenbank mit Metadaten aktualisiert
|
||||
- Start-Button im Dashboard aktiv
|
||||
- Benutzer kann Metadaten noch mal ändern
|
||||
|
||||
**Übergang:** `startJob(jobId)` aufrufen
|
||||
|
||||
---
|
||||
|
||||
### RIPPING
|
||||
|
||||
**MakeMKV rippt die Disc.**
|
||||
|
||||
=== "MKV-Modus (Standard)"
|
||||
|
||||
```bash
|
||||
makemkvcon mkv disc:0 all /path/to/raw/ \
|
||||
--minlength=900
|
||||
```
|
||||
|
||||
Erstellt MKV-Datei(en) direkt aus den gewählten Titeln.
|
||||
|
||||
=== "Backup-Modus"
|
||||
|
||||
```bash
|
||||
makemkvcon backup disc:0 /path/to/raw/backup/ \
|
||||
--decrypt
|
||||
```
|
||||
|
||||
Erstellt vollständiges Disc-Backup inkl. Menüs.
|
||||
|
||||
**Live-Updates:** Fortschritt wird zeilenweise aus MakeMKV-Ausgabe geparst:
|
||||
|
||||
```
|
||||
PRGC:5012,0,2048 → Fortschritt: X%
|
||||
PRGT:5011,0,"..." → Aktueller Task
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### MEDIAINFO_CHECK
|
||||
|
||||
**MediaInfo analysiert die gerippte Datei.**
|
||||
|
||||
```bash
|
||||
mediainfo --Output=JSON /path/to/raw/file.mkv
|
||||
```
|
||||
|
||||
- Liest alle Audio-, Untertitel- und Video-Tracks
|
||||
- Extrahiert Codec-Informationen (DTS, TrueHD, AC-3, ...)
|
||||
- Bestimmt Sprachcodes (ISO 639)
|
||||
- Erstellt Encode-Plan via `encodePlan.js`
|
||||
|
||||
---
|
||||
|
||||
### READY_TO_ENCODE
|
||||
|
||||
**Encode-Plan erstellt, wartet auf Bestätigung.**
|
||||
|
||||
- `MediaInfoReviewPanel` wird im Frontend angezeigt
|
||||
- Benutzer kann Audio- und Untertitel-Tracks de/aktivieren
|
||||
- Vorgeschlagene Tracks basierend auf Sprach-Einstellungen
|
||||
|
||||
**Übergang:** `confirmEncode(jobId, trackSelection)` aufrufen
|
||||
|
||||
---
|
||||
|
||||
### ENCODING
|
||||
|
||||
**HandBrake encodiert die Datei.**
|
||||
|
||||
```bash
|
||||
HandBrakeCLI \
|
||||
--input /path/to/raw.mkv \
|
||||
--output /path/to/movies/Inception\ \(2010\).mkv \
|
||||
--preset "H.265 MKV 1080p30" \
|
||||
--audio 1,2 \
|
||||
--subtitle 1
|
||||
```
|
||||
|
||||
**Live-Updates:** Fortschritt wird aus HandBrake-stderr geparst:
|
||||
|
||||
```
|
||||
Encoding: task 1 of 1, 73.50 %
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### FINISHED
|
||||
|
||||
**Job erfolgreich abgeschlossen.**
|
||||
|
||||
- Ausgabedatei liegt im konfigurierten `movie_dir`
|
||||
- Job-Status in Datenbank auf `FINISHED` gesetzt
|
||||
- PushOver-Benachrichtigung (falls konfiguriert)
|
||||
- WebSocket-Event: `JOB_COMPLETE`
|
||||
|
||||
---
|
||||
|
||||
### ERROR
|
||||
|
||||
**Fehler aufgetreten.**
|
||||
|
||||
- Fehlerdetails im Job-Datensatz gespeichert
|
||||
- Fehler-Logs verfügbar in der History
|
||||
- **Retry**: Job kann vom Fehlerzustand neu gestartet werden
|
||||
- **Abbrechen**: Pipeline zurück zu IDLE
|
||||
|
||||
---
|
||||
|
||||
## Abbrechen & Retry
|
||||
|
||||
### Pipeline abbrechen
|
||||
|
||||
```http
|
||||
POST /api/pipeline/cancel
|
||||
```
|
||||
|
||||
- Sendet SIGINT an aktiven Prozess
|
||||
- Wartet auf graceful exit (Timeout: 10 Sekunden)
|
||||
- Falls kein graceful exit: SIGKILL
|
||||
- Pipeline-Zustand zurück zu IDLE
|
||||
|
||||
### Job wiederholen
|
||||
|
||||
```http
|
||||
POST /api/pipeline/retry/:jobId
|
||||
```
|
||||
|
||||
- Setzt Job-Status zurück auf `READY_TO_START`
|
||||
- Behält Metadaten und Playlist-Auswahl
|
||||
- Pipeline neu starten mit vorhandenen Daten
|
||||
|
||||
### Re-Encode
|
||||
|
||||
```http
|
||||
POST /api/pipeline/reencode/:jobId
|
||||
```
|
||||
|
||||
- Encodiert bestehende Raw-MKV neu
|
||||
- Nützlich für geänderte Encoding-Einstellungen
|
||||
- Kein neues Ripping erforderlich
|
||||
64
docs/stylesheets/extra.css
Normal file
64
docs/stylesheets/extra.css
Normal file
@@ -0,0 +1,64 @@
|
||||
/* Ripster custom styles */
|
||||
|
||||
:root {
|
||||
--md-primary-fg-color: #6a1b9a;
|
||||
--md-accent-fg-color: #ab47bc;
|
||||
}
|
||||
|
||||
/* Cards grid layout */
|
||||
.grid.cards {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
|
||||
gap: 1rem;
|
||||
margin: 1.5rem 0;
|
||||
}
|
||||
|
||||
.grid.cards > * {
|
||||
border-radius: 0.5rem;
|
||||
border: 1px solid var(--md-default-fg-color--lightest);
|
||||
padding: 1.25rem;
|
||||
transition: box-shadow 0.2s ease;
|
||||
}
|
||||
|
||||
.grid.cards > *:hover {
|
||||
box-shadow: 0 4px 16px rgba(0, 0, 0, 0.12);
|
||||
}
|
||||
|
||||
/* Status badge colors */
|
||||
.status-idle { color: #78909c; }
|
||||
.status-analyzing { color: #fb8c00; }
|
||||
.status-ripping { color: #1976d2; }
|
||||
.status-encoding { color: #7b1fa2; }
|
||||
.status-finished { color: #388e3c; }
|
||||
.status-error { color: #d32f2f; }
|
||||
|
||||
/* Code blocks */
|
||||
.md-typeset pre > code {
|
||||
font-size: 0.85em;
|
||||
}
|
||||
|
||||
/* Mermaid diagrams */
|
||||
.md-typeset .mermaid {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
margin: 1.5rem 0;
|
||||
}
|
||||
|
||||
/* Table improvements */
|
||||
.md-typeset table:not([class]) {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.md-typeset table:not([class]) th {
|
||||
background-color: var(--md-primary-fg-color);
|
||||
color: white;
|
||||
}
|
||||
|
||||
/* Admonition tweaks */
|
||||
.md-typeset .admonition.tip {
|
||||
border-color: #00897b;
|
||||
}
|
||||
|
||||
.md-typeset .admonition.tip > .admonition-title {
|
||||
background-color: rgba(0, 137, 123, 0.1);
|
||||
}
|
||||
137
docs/tools/handbrake.md
Normal file
137
docs/tools/handbrake.md
Normal file
@@ -0,0 +1,137 @@
|
||||
# HandBrake
|
||||
|
||||
HandBrake encodiert die rohen MKV-Dateien in das gewünschte Format. Ripster nutzt `HandBrakeCLI`.
|
||||
|
||||
---
|
||||
|
||||
## Verwendeter Befehl
|
||||
|
||||
```bash
|
||||
HandBrakeCLI \
|
||||
--input "/mnt/raw/Film_t00.mkv" \
|
||||
--output "/mnt/movies/Film (2010).mkv" \
|
||||
--preset "H.265 MKV 1080p30" \
|
||||
--audio 1,2 \
|
||||
--aencoder copy:ac3,ffaac \
|
||||
--subtitle 1 \
|
||||
--subtitle-default 1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Presets
|
||||
|
||||
HandBrake verwendet **Presets** für vorkonfigurierte Encoding-Einstellungen.
|
||||
|
||||
### Empfohlene Presets
|
||||
|
||||
| Preset | Codec | Auflösung | Für |
|
||||
|--------|-------|----------|-----|
|
||||
| `H.265 MKV 1080p30` | HEVC/H.265 | 1080p | Beste Qualität/Größe |
|
||||
| `H.265 MKV 720p30` | HEVC/H.265 | 720p | Kleinere Dateien |
|
||||
| `H.264 MKV 1080p30` | AVC/H.264 | 1080p | Breiteste Kompatibilität |
|
||||
| `HQ 1080p30 Surround` | HEVC/H.265 | 1080p | Hohe Qualität mit Surround |
|
||||
|
||||
### Alle Presets anzeigen
|
||||
|
||||
```bash
|
||||
HandBrakeCLI --preset-list
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Audio-Encoding
|
||||
|
||||
### Copy-kompatible Codecs
|
||||
|
||||
HandBrake kann folgende Codecs direkt kopieren (kein Qualitätsverlust):
|
||||
|
||||
| Codec | `--aencoder` Wert |
|
||||
|-------|-----------------|
|
||||
| AC-3 | `copy:ac3` |
|
||||
| AAC | `copy:aac` |
|
||||
| MP3 | `copy:mp3` |
|
||||
| TrueHD | `copy:truehd` |
|
||||
| E-AC-3 | `copy:eac3` |
|
||||
|
||||
### Transcoding
|
||||
|
||||
Codecs die nicht kopiert werden können, werden zu AAC transcodiert:
|
||||
|
||||
| Original | Transcodiert zu |
|
||||
|---------|----------------|
|
||||
| DTS | AAC (`ffaac`) |
|
||||
| DTS-HD | AAC (`ffaac`) |
|
||||
|
||||
---
|
||||
|
||||
## Extra-Argumente
|
||||
|
||||
Über die Einstellung `handbrake_extra_args` können beliebige HandBrake-Argumente hinzugefügt werden:
|
||||
|
||||
```
|
||||
# Cropping deaktivieren
|
||||
--crop 0:0:0:0
|
||||
|
||||
# Loose Anamorphic
|
||||
--loose-anamorphic
|
||||
|
||||
# Bestimmte Qualität setzen
|
||||
--quality 20
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Fortschritts-Parsing
|
||||
|
||||
Ripster parst die HandBrake-Ausgabe auf stderr für die Fortschrittsanzeige:
|
||||
|
||||
```
|
||||
Encoding: task 1 of 1, 73.50 % (45.23 fps, avg 44.12 fps, ETA 00h12m34s)
|
||||
```
|
||||
|
||||
`progressParsers.js` extrahiert:
|
||||
- Prozentzahl
|
||||
- Aktuelle FPS
|
||||
- ETA
|
||||
|
||||
---
|
||||
|
||||
## Konfiguration in Ripster
|
||||
|
||||
| Einstellung | Beschreibung |
|
||||
|------------|-------------|
|
||||
| `handbrake_command` | Pfad/Befehl für `HandBrakeCLI` |
|
||||
| `handbrake_preset` | Preset-Name |
|
||||
| `handbrake_extra_args` | Zusätzliche CLI-Argumente |
|
||||
| `output_extension` | Dateiendung der Ausgabe |
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### HandBrake findet Preset nicht
|
||||
|
||||
```bash
|
||||
# Preset-Liste anzeigen
|
||||
HandBrakeCLI --preset-list 2>&1 | grep -i "h.265"
|
||||
```
|
||||
|
||||
Preset-Namen sind case-sensitive!
|
||||
|
||||
### Encoding sehr langsam
|
||||
|
||||
```bash
|
||||
# CPU-Encoding-Preset anpassen (schneller = schlechtere Qualität)
|
||||
handbrake_extra_args = --encoder-preset fast
|
||||
```
|
||||
|
||||
Verfügbare Presets: `ultrafast`, `superfast`, `veryfast`, `faster`, `fast`, `medium`, `slow`, `slower`, `veryslow`
|
||||
|
||||
### GPU-Encoding nutzen (NVIDIA)
|
||||
|
||||
```
|
||||
handbrake_preset = H.265 NVENC 1080p
|
||||
```
|
||||
|
||||
Erfordert HandBrake-Build mit NVENC-Unterstützung und NVIDIA-GPU.
|
||||
31
docs/tools/index.md
Normal file
31
docs/tools/index.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Externe Tools
|
||||
|
||||
Ripster ist ein **Orchestrator** – die eigentliche Arbeit erledigen diese bewährten Open-Source-Tools:
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-disc: **MakeMKV**
|
||||
|
||||
---
|
||||
|
||||
Disc-Analyse und Ripping. Erstellt MKV-Dateien oder vollständige Backups.
|
||||
|
||||
[:octicons-arrow-right-24: MakeMKV](makemkv.md)
|
||||
|
||||
- :material-film: **HandBrake**
|
||||
|
||||
---
|
||||
|
||||
Video-Encoding mit umfangreichen Preset-Optionen.
|
||||
|
||||
[:octicons-arrow-right-24: HandBrake](handbrake.md)
|
||||
|
||||
- :material-information: **MediaInfo**
|
||||
|
||||
---
|
||||
|
||||
Analyse von Track-Informationen in Mediendateien.
|
||||
|
||||
[:octicons-arrow-right-24: MediaInfo](mediainfo.md)
|
||||
|
||||
</div>
|
||||
118
docs/tools/makemkv.md
Normal file
118
docs/tools/makemkv.md
Normal file
@@ -0,0 +1,118 @@
|
||||
# MakeMKV
|
||||
|
||||
MakeMKV analysiert und rippt DVDs und Blu-rays. Ripster nutzt `makemkvcon` (die CLI-Version).
|
||||
|
||||
---
|
||||
|
||||
## Verwendete Befehle
|
||||
|
||||
### Disc-Analyse
|
||||
|
||||
```bash
|
||||
makemkvcon -r --cache=1 info disc:0
|
||||
```
|
||||
|
||||
Gibt alle Titel und Playlists der eingelegten Disc aus. Ripster parst diese Ausgabe um die verfügbaren Tracks und Playlists zu bestimmen.
|
||||
|
||||
**Parameter:**
|
||||
- `-r` – Maschinen-lesbares Ausgabeformat
|
||||
- `--cache=1` – Minimaler Disc-Cache
|
||||
- `info disc:0` – Informationsabfrage für erstes Laufwerk
|
||||
|
||||
### MKV-Modus (Standard)
|
||||
|
||||
```bash
|
||||
makemkvcon mkv disc:0 all /path/to/raw/ \
|
||||
--minlength=900 \
|
||||
-r
|
||||
```
|
||||
|
||||
Erstellt MKV-Dateien aus allen Titeln, die länger als 15 Minuten sind.
|
||||
|
||||
**Parameter:**
|
||||
- `mkv` – MKV-Ausgabemodus
|
||||
- `disc:0` – Erstes Disc-Laufwerk
|
||||
- `all` – Alle passenden Titel (nicht nur einen bestimmten)
|
||||
- `--minlength=900` – Mindestlänge in Sekunden (entspricht 15 Minuten)
|
||||
|
||||
### Backup-Modus
|
||||
|
||||
```bash
|
||||
makemkvcon backup disc:0 /path/to/raw/backup/ \
|
||||
--decrypt \
|
||||
-r
|
||||
```
|
||||
|
||||
Erstellt ein vollständiges Disc-Backup mit Menüs.
|
||||
|
||||
**Parameter:**
|
||||
- `backup` – Backup-Modus
|
||||
- `--decrypt` – Verschlüsselung entfernen
|
||||
|
||||
---
|
||||
|
||||
## Ausgabeformat
|
||||
|
||||
MakeMKV gibt Fortschritt und Status in einem strukturierten Format aus:
|
||||
|
||||
```
|
||||
PRGV:current,total,max → Fortschrittsbalken-Werte
|
||||
PRGT:code,id,"Beschreibung" → Aktueller Task
|
||||
PRGC:code,id,"Beschreibung" → Aktueller Sub-Task
|
||||
MSG:code,flags,count,"Text" → Nachricht
|
||||
```
|
||||
|
||||
Ripster's `progressParsers.js` parst diese Ausgabe für die Live-Fortschrittsanzeige.
|
||||
|
||||
---
|
||||
|
||||
## MakeMKV-Lizenz
|
||||
|
||||
MakeMKV ist **Beta-Software** und kostenlos für den persönlichen Gebrauch während der Beta-Phase. Eine Beta-Lizenz ist regelmäßig im [MakeMKV-Forum](https://www.makemkv.com/forum/viewtopic.php?t=1053) verfügbar.
|
||||
|
||||
Ohne gültige Lizenz können Blu-rays nicht entschlüsselt werden.
|
||||
|
||||
### Lizenz eintragen
|
||||
|
||||
Die Lizenz wird in den MakeMKV-Einstellungen eingetragen (GUI) oder direkt in:
|
||||
|
||||
```
|
||||
~/.MakeMKV/settings.conf
|
||||
```
|
||||
|
||||
```
|
||||
app_Key = "XXXX-XXXX-XXXX-XXXX-XXXX"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Konfiguration in Ripster
|
||||
|
||||
| Einstellung | Beschreibung |
|
||||
|------------|-------------|
|
||||
| `makemkv_command` | Pfad/Befehl für `makemkvcon` |
|
||||
| `makemkv_min_length_minutes` | Mindest-Titellänge (Standard: 15 Min) |
|
||||
| `makemkv_backup_mode` | Backup-Modus statt MKV |
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### MakeMKV erkennt Disc nicht
|
||||
|
||||
```bash
|
||||
# Laufwerk-Berechtigungen prüfen
|
||||
ls -la /dev/sr0
|
||||
sudo chmod a+rw /dev/sr0
|
||||
|
||||
# Oder Benutzer zur Gruppe cdrom hinzufügen
|
||||
sudo usermod -a -G cdrom $USER
|
||||
```
|
||||
|
||||
### Langer Analyseprozess
|
||||
|
||||
Blu-ray-Analyse kann bei Discs mit vielen Playlists 5+ Minuten dauern. Dies ist normal.
|
||||
|
||||
### Fehlermeldung: "LibMMBD"
|
||||
|
||||
LibMMBD ist MakeMKVs interne Verschlüsselungsbibliothek. Bei Fehlern die MakeMKV-Version aktualisieren.
|
||||
108
docs/tools/mediainfo.md
Normal file
108
docs/tools/mediainfo.md
Normal file
@@ -0,0 +1,108 @@
|
||||
# MediaInfo
|
||||
|
||||
MediaInfo analysiert die Track-Struktur von Mediendateien. Ripster nutzt es nach dem Ripping um Audio- und Untertitelspuren zu identifizieren.
|
||||
|
||||
---
|
||||
|
||||
## Verwendeter Befehl
|
||||
|
||||
```bash
|
||||
mediainfo --Output=JSON /path/to/raw/film.mkv
|
||||
```
|
||||
|
||||
Gibt vollständige Track-Informationen als JSON zurück.
|
||||
|
||||
---
|
||||
|
||||
## Ausgabe-Struktur
|
||||
|
||||
```json
|
||||
{
|
||||
"media": {
|
||||
"track": [
|
||||
{
|
||||
"@type": "General",
|
||||
"Duration": "8885.042",
|
||||
"Format": "Matroska"
|
||||
},
|
||||
{
|
||||
"@type": "Video",
|
||||
"Format": "HEVC",
|
||||
"Width": "1920",
|
||||
"Height": "1080",
|
||||
"FrameRate": "23.976"
|
||||
},
|
||||
{
|
||||
"@type": "Audio",
|
||||
"StreamOrder": "1",
|
||||
"Format": "TrueHD",
|
||||
"Channels": "8",
|
||||
"Language": "en"
|
||||
},
|
||||
{
|
||||
"@type": "Audio",
|
||||
"StreamOrder": "2",
|
||||
"Format": "AC-3",
|
||||
"Channels": "6",
|
||||
"Language": "de"
|
||||
},
|
||||
{
|
||||
"@type": "Text",
|
||||
"StreamOrder": "1",
|
||||
"Format": "UTF-8",
|
||||
"Language": "de"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Verarbeitung in Ripster
|
||||
|
||||
`encodePlan.js` verarbeitet die MediaInfo-Ausgabe:
|
||||
|
||||
1. **Track-Extraktion**: Alle Audio- und Untertitel-Tracks werden extrahiert
|
||||
2. **Sprach-Normalisierung**: Sprachcodes werden auf ISO 639-3 normalisiert
|
||||
3. **Codec-Klassifizierung**: Bestimmt ob Codec kopiert oder transcodiert werden kann
|
||||
4. **Track-Labels**: Benutzerfreundliche Bezeichnungen (z.B. "Deutsch (AC-3, 5.1)")
|
||||
|
||||
### Track-Label-Format
|
||||
|
||||
```
|
||||
{Sprache} ({Format}, {Kanäle})
|
||||
```
|
||||
|
||||
Beispiele:
|
||||
- `Deutsch (AC-3, 5.1)`
|
||||
- `English (TrueHD, 7.1)`
|
||||
- `Français (AC-3, 2.0)`
|
||||
|
||||
---
|
||||
|
||||
## Konfiguration in Ripster
|
||||
|
||||
| Einstellung | Beschreibung |
|
||||
|------------|-------------|
|
||||
| `mediainfo_command` | Pfad/Befehl für `mediainfo` |
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### MediaInfo gibt kein JSON aus
|
||||
|
||||
```bash
|
||||
# Version prüfen
|
||||
mediainfo --Version
|
||||
|
||||
# JSON-Ausgabe testen
|
||||
mediainfo --Output=JSON /path/to/test.mkv
|
||||
```
|
||||
|
||||
MediaInfo >= 17.10 wird empfohlen.
|
||||
|
||||
### Sprache als "und" angezeigt
|
||||
|
||||
`und` steht für "undetermined" – die Sprache ist in der MKV-Datei nicht getaggt. Dies ist bei manchen Rips normal. Der Track wird trotzdem angezeigt und kann manuell ausgewählt werden.
|
||||
Reference in New Issue
Block a user