Diese Dokumentation ist als vollst\u00e4ndiges Benutzerhandbuch aufgebaut: t\u00e4gliche Bedienung zuerst, technische Referenz danach.
"},{"location":"#einstieg-in-3-schritten","title":"Einstieg in 3 Schritten","text":"REST- und WebSocket-Schnittstellen f\u00fcr Integration, Automatisierung und Debugging.
"},{"location":"api/#basis-url","title":"Basis-URL","text":"http://localhost:3001\nAPI-Prefix: /api
Health
Service-Liveness.
GET /api/health
Pipeline API
Analyse, Start/Retry/Cancel, Queue, Re-Encode.
Pipeline API
Settings API
Einstellungen, Skripte/Ketten, User-Presets.
Settings API
History API
Job-Historie, Orphan-Import, L\u00f6schoperationen.
History API
Cron API
Zeitgesteuerte Skript-/Kettenausf\u00fchrung.
Cron API
Converter API
Datei-Explorer, Upload, Job-Verwaltung f\u00fcr den Converter.
Converter API
Downloads API
Download-Queue f\u00fcr Ausgabedateien aus der Job-Historie.
Downloads API
Runtime Activities API
Laufende und abgeschlossene Aktivit\u00e4ten (Skripte, Ketten, Cron, Tasks).
Runtime Activities
:material-websocket: WebSocket Events
Pipeline-, Queue-, Disk-, Settings-, Cron-, Converter- und Download-Events.
WebSocket
Ripster hat keine eingebaute Authentifizierung und ist f\u00fcr lokalen, gesch\u00fctzten Betrieb gedacht.
"},{"location":"api/converter/","title":"Converter API","text":"Endpunkte f\u00fcr den Datei-Converter: Datei-Explorer, Upload, Job-Verwaltung.
Basis-Pfad: /api/converter
GET /api/converter/tree","text":"Vollst\u00e4ndiger Verzeichnisbaum des converter_raw_dir (FS-basiert, keine DB).
Response:
{\n \"tree\": [\n {\n \"name\": \"filme\",\n \"relPath\": \"filme\",\n \"isDir\": true,\n \"children\": [\n {\n \"name\": \"film.mkv\",\n \"relPath\": \"filme/film.mkv\",\n \"isDir\": false,\n \"size\": 10485760\n }\n ]\n }\n ]\n}\nGET /api/converter/browse?parent=relPath","text":"DB-basierter Datei-Explorer. Gibt Eintr\u00e4ge f\u00fcr einen Unterordner zur\u00fcck.
Query-Parameter:
Parameter Typ Beschreibungparent string Relativer Pfad zum Unterordner (leer = Root) Response:
{\n \"entries\": [\n {\n \"id\": 1,\n \"rel_path\": \"filme/film.mkv\",\n \"is_dir\": false,\n \"size\": 10485760,\n \"job_id\": null\n }\n ],\n \"rawDir\": \"/data/output/converter-raw\"\n}\nPOST /api/converter/scan","text":"Manuellen Scan des converter_raw_dir ausl\u00f6sen. Aktualisiert converter_scan_entries in der DB.
Response:
{ \"result\": { \"added\": 3, \"removed\": 1 } }\nPOST /api/converter/jobs/from-selection","text":"Jobs aus im Datei-Explorer ausgew\u00e4hlten Dateien erstellen.
Body:
{\n \"relPaths\": [\"filme/film.mkv\", \"musik/track.flac\"],\n \"audioMode\": \"individual\"\n}\nrelPaths string[] Relative Pfade der ausgew\u00e4hlten Dateien audioMode string individual (ein Job pro Datei) oder shared (ein gemeinsamer Job) Response:
{ \"jobs\": [{ \"id\": 42, \"status\": \"READY_TO_START\" }] }\nPOST /api/converter/create-jobs","text":"Jobs aus DB-Scan-Eintr\u00e4gen erstellen.
Body:
{\n \"entries\": [\n { \"relPath\": \"filme/film.mkv\", \"converterMediaType\": \"video\" }\n ]\n}\nPOST /api/converter/upload","text":"Dateien hochladen (Multipart, max. 50 Dateien).
Form-Felder:
Feld Typ Beschreibungfiles File[] Hochzuladende Dateien folderName string (Optional) Ziel-Unterordner Response:
{\n \"folders\": [{ \"folderRelPath\": \"upload-2026-03-30\", \"fileCount\": 2 }]\n}\nGET /api/converter/jobs","text":"Alle Converter-Jobs zur\u00fcckgeben.
Response:
{ \"jobs\": [{ \"id\": 42, \"status\": \"READY_TO_START\", \"title\": \"film.mkv\" }] }\nGET /api/converter/jobs/:jobId","text":"Einzelnen Converter-Job abrufen.
"},{"location":"api/converter/#post-apiconverterjobsjobidconfig","title":"POST /api/converter/jobs/:jobId/config","text":"Konfigurationsentwurf f\u00fcr einen Job speichern (persistiert in encode_plan_json).
Body: Partielles Konfig-Objekt (Ausgabeformat, Presets, Metadaten, Track-Auswahl).
"},{"location":"api/converter/#post-apiconverterjobsjobidassign-files","title":"POST /api/converter/jobs/:jobId/assign-files","text":"Dateien einem bestehenden (noch nicht gestarteten) Job hinzuf\u00fcgen.
Body:
{ \"relPaths\": [\"musik/track2.flac\"] }\nPOST /api/converter/jobs/:jobId/remove-file","text":"Datei aus einem Job entfernen (per relativer Pfad).
Body:
{ \"relPath\": \"musik/track2.flac\" }\nPOST /api/converter/jobs/:jobId/remove-input","text":"Datei aus einem Job entfernen (per absolutem Eingabepfad).
Body:
{ \"inputPath\": \"/data/output/converter-raw/musik/track2.flac\" }\nPOST /api/converter/jobs/:jobId/start","text":"Job mit finaler Konfiguration starten.
Body:
{\n \"converterMediaType\": \"video\",\n \"outputFormat\": \"mkv\",\n \"userPreset\": \"H.264 MKV 1080p30\",\n \"trackSelection\": {},\n \"handBrakeTitleId\": 1,\n \"audioFormatOptions\": {}\n}\nPOST /api/converter/jobs/:jobId/cancel","text":"Laufenden Job abbrechen.
"},{"location":"api/converter/#delete-apiconverterjobsjobid","title":"DELETE /api/converter/jobs/:jobId","text":"Job aus der DB l\u00f6schen.
"},{"location":"api/converter/#datei-operationen","title":"Datei-Operationen","text":"Alle Datei-Operationen arbeiten direkt auf dem Dateisystem (ohne DB-Aktualisierung). Ein anschlie\u00dfender Scan-Aufruf synchronisiert die DB.
"},{"location":"api/converter/#delete-apiconverterfiles","title":"DELETE /api/converter/files","text":"Datei oder Ordner l\u00f6schen.
Body:
{ \"relPath\": \"filme/film.mkv\" }\nPOST /api/converter/files/rename","text":"Datei oder Ordner umbenennen.
Body:
{ \"relPath\": \"filme/film.mkv\", \"newName\": \"film-neu.mkv\" }\nPOST /api/converter/files/move","text":"Datei oder Ordner verschieben.
Body:
{ \"relPath\": \"filme/film.mkv\", \"targetParentRelPath\": \"archiv\" }\ntargetParentRelPath = \"\" verschiebt in das Root-Verzeichnis.
POST /api/converter/files/folder","text":"Neuen Ordner anlegen.
Body:
{ \"parentRelPath\": \"filme\", \"name\": \"neu\" }\nRipster enth\u00e4lt ein eingebautes Cron-System f\u00fcr Skripte und Skript-Ketten (sourceType: script|chain).
Listet alle Cron-Jobs.
{\n \"jobs\": [\n {\n \"id\": 1,\n \"name\": \"Nachtlauf Backup\",\n \"cronExpression\": \"0 2 * * *\",\n \"sourceType\": \"script\",\n \"sourceId\": 3,\n \"sourceName\": \"Backup-Skript\",\n \"enabled\": true,\n \"pushoverEnabled\": true,\n \"lastRunAt\": \"2026-03-10T02:00:00.000Z\",\n \"lastRunStatus\": \"success\",\n \"nextRunAt\": \"2026-03-11T02:00:00.000Z\",\n \"createdAt\": \"2026-03-01T10:00:00.000Z\",\n \"updatedAt\": \"2026-03-10T02:00:05.000Z\"\n }\n ]\n}\nErstellt Cron-Job.
{\n \"name\": \"Nachtlauf Backup\",\n \"cronExpression\": \"0 2 * * *\",\n \"sourceType\": \"script\",\n \"sourceId\": 3,\n \"enabled\": true,\n \"pushoverEnabled\": true\n}\nResponse: 201 mit { \"job\": { ... } }
Response:
{ \"job\": { \"id\": 1, \"name\": \"...\" } }\nAktualisiert Cron-Job. Felder wie bei POST.
Response:
{ \"job\": { ... } }\nResponse:
{ \"removed\": { \"id\": 1, \"name\": \"Nachtlauf Backup\" } }\nLiefert Ausf\u00fchrungs-Logs.
Query-Parameter:
Parameter Typ Default Beschreibunglimit number 20 Anzahl Eintr\u00e4ge, max. 100 Response:
{\n \"logs\": [\n {\n \"id\": 42,\n \"cronJobId\": 1,\n \"startedAt\": \"2026-03-10T02:00:01.000Z\",\n \"finishedAt\": \"2026-03-10T02:00:05.000Z\",\n \"status\": \"success\",\n \"output\": \"Backup abgeschlossen.\",\n \"errorMessage\": null\n }\n ]\n}\nstatus: running | success | error
Triggert Job manuell (asynchron).
Response:
{ \"triggered\": true, \"cronJobId\": 1 }\nWenn Job bereits l\u00e4uft: 409.
Validiert 5-Felder-Cron-Ausdruck und berechnet n\u00e4chsten Lauf.
Request:
{ \"cronExpression\": \"*/15 * * * *\" }\nG\u00fcltige Response:
{\n \"valid\": true,\n \"nextRunAt\": \"2026-03-10T14:15:00.000Z\"\n}\nUng\u00fcltige Response:
{\n \"valid\": false,\n \"error\": \"Cron-Ausdruck muss genau 5 Felder haben (Minute Stunde Tag Monat Wochentag).\",\n \"nextRunAt\": null\n}\nRipster unterst\u00fctzt 5 Felder:
Minute Stunde Tag Monat Wochentag\nBeispiele:
0 2 * * * t\u00e4glich 02:00*/15 * * * * alle 15 Minuten0 6 * * 1-5 Mo-Fr 06:00CRON_JOBS_UPDATED bei Create/Update/DeleteCRON_JOB_UPDATED bei Laufzeitstatus (running -> success|error)Endpunkte f\u00fcr die Download-Queue. Ausgabedateien aus der Job-Historie k\u00f6nnen als ZIP heruntergeladen werden.
Basis-Pfad: /api/downloads
GET /api/downloads","text":"Liste aller Download-Eintr\u00e4ge plus Zusammenfassung.
Response:
{\n \"items\": [\n {\n \"id\": \"dl-42-raw\",\n \"jobId\": 42,\n \"target\": \"raw\",\n \"status\": \"ready\",\n \"archiveName\": \"Job_42_raw.zip\",\n \"outputPath\": null,\n \"createdAt\": \"2026-03-30T10:00:00.000Z\",\n \"updatedAt\": \"2026-03-30T10:01:00.000Z\",\n \"errorMessage\": null\n }\n ],\n \"summary\": {\n \"total\": 3,\n \"pending\": 1,\n \"processing\": 0,\n \"ready\": 1,\n \"failed\": 1\n }\n}\nStatus-Werte:
Status Beschreibungpending In der Queue, noch nicht gestartet processing ZIP wird gerade erstellt ready ZIP fertig, Download verf\u00fcgbar failed Fehler bei der Erstellung"},{"location":"api/downloads/#get-apidownloadssummary","title":"GET /api/downloads/summary","text":"Nur die Zusammenfassung der Download-Queue (ohne Item-Liste).
Response:
{\n \"summary\": {\n \"total\": 3,\n \"pending\": 1,\n \"processing\": 0,\n \"ready\": 1,\n \"failed\": 1\n }\n}\nPOST /api/downloads/history/:jobId","text":"Job-Ausgabe in die Download-Queue einreihen.
Parameter:
Parameter Typ BeschreibungjobId number ID des Jobs in der Historie Body:
{\n \"target\": \"raw\",\n \"outputPath\": null\n}\ntarget string raw raw (RAW-Dateien) oder movie (Ausgabedateien) outputPath string null Optionaler expliziter Ausgabepfad Response (201 Created):
{\n \"created\": true,\n \"id\": \"dl-42-raw\",\n \"status\": \"pending\",\n \"summary\": { \"total\": 1, \"pending\": 1, \"processing\": 0, \"ready\": 0, \"failed\": 0 }\n}\nIst der Eintrag bereits vorhanden, wird 201 durch 200 ersetzt und created: false zur\u00fcckgegeben.
GET /api/downloads/:id/file","text":"Fertige ZIP-Datei herunterladen.
Parameter:
Parameter Typ Beschreibungid string Download-ID (z. B. dl-42-raw) Response: Datei-Download (Content-Disposition: attachment).
Schl\u00e4gt fehl mit 404, wenn kein Download-Eintrag mit dieser ID existiert oder die Datei noch nicht bereit ist.
DELETE /api/downloads/:id","text":"Download-Eintrag l\u00f6schen (auch fertige ZIP-Dateien werden vom Dateisystem entfernt).
Response:
{\n \"ok\": true,\n \"summary\": { \"total\": 2, \"pending\": 0, \"processing\": 0, \"ready\": 2, \"failed\": 0 }\n}\nStatus\u00e4nderungen werden \u00fcber DOWNLOADS_UPDATED in Echtzeit gemeldet. Vollst\u00e4ndige Dokumentation: WebSocket Events.
Endpunkte f\u00fcr Job-Historie, Metadaten-Nachpflege, Orphan-Import und L\u00f6schoperationen.
"},{"location":"api/history/#get-apihistory","title":"GET /api/history","text":"Liefert Jobs mit optionalen Filtern.
Query-Parameter:
Parameter Typ Beschreibungstatus string Einzelstatus-Filter (legacy-kompatibel). statuses string Mehrfachstatus als CSV, z. B. FINISHED,ERROR. search string Suche in Titel-/IMDb-Feldern. limit number Maximale Anzahl Ergebnisse. lite bool Ohne Dateisystem-Checks (schneller). includeChildren bool Child-Jobs (z. B. Serien-/Multipart-Kinder) explizit einbeziehen. Beispiel:
GET /api/history?statuses=FINISHED,ERROR&search=Inception&limit=50&lite=1\nResponse (Beispiel):
{\n \"jobs\": [\n {\n \"id\": 42,\n \"status\": \"FINISHED\",\n \"title\": \"Inception\",\n \"job_kind\": \"bluray\",\n \"raw_path\": \"/mnt/raw/Inception - RAW - job-42\",\n \"output_path\": \"/mnt/movies/Inception (2010)/Inception (2010).mkv\",\n \"mediaType\": \"bluray\",\n \"ripSuccessful\": true,\n \"encodeSuccess\": true,\n \"created_at\": \"2026-03-10T08:00:00.000Z\",\n \"updated_at\": \"2026-03-10T10:00:00.000Z\"\n }\n ]\n}\nLiefert Job-Detail.
Query-Parameter:
Parameter Typ Standard BeschreibungincludeLogs bool false Prozesslog laden. includeLiveLog bool false Live-/Tail-Log laden. includeAllLogs bool false vollst\u00e4ndiges Log statt Tail. logTailLines number 800 Tail-L\u00e4nge falls nicht includeAllLogs. lite bool false Detailantwort ohne FS-Checks. Response (Beispiel):
{\n \"job\": {\n \"id\": 42,\n \"status\": \"FINISHED\",\n \"makemkvInfo\": {},\n \"mediainfoInfo\": {},\n \"handbrakeInfo\": {},\n \"encodePlan\": {},\n \"log\": \"...\",\n \"log_count\": 1,\n \"logMeta\": {\n \"loaded\": true,\n \"total\": 800,\n \"returned\": 800,\n \"truncated\": true\n }\n }\n}\nSucht RAW-Ordner ohne zugeh\u00f6rigen Job.
"},{"location":"api/history/#post-apihistoryorphan-rawimport","title":"POST /api/history/orphan-raw/import","text":"Importiert einen RAW-Ordner als Job und triggert optional die Analyse des Imports.
Request:
{ \"rawPath\": \"/mnt/raw/Inception (2010) [tt1375666] - RAW - job-99\" }\nResponse (Beispiel):
{\n \"job\": { \"id\": 77, \"status\": \"FINISHED\" },\n \"activation\": { \"started\": true },\n \"activationError\": null\n}\nWeist OMDb-/Filmdaten nachtr\u00e4glich zu.
"},{"location":"api/history/#post-apihistoryidcdassign","title":"POST /api/history/:id/cd/assign","text":"Weist CD-Metadaten (z. B. MusicBrainz) nachtr\u00e4glich zu.
"},{"location":"api/history/#post-apihistoryiderrorack","title":"POST /api/history/:id/error/ack","text":"Quittiert einen Fehlerzustand im Historieneintrag.
"},{"location":"api/history/#get-apihistoryiddelete-preview","title":"GET /api/history/:id/delete-preview","text":"Liefert eine Vorschau der l\u00f6schbaren Pfade (inkl. Scope auf verkn\u00fcpfte Jobs).
Query-Parameter:
Parameter Typ Standard BeschreibungincludeRelated bool true Verkn\u00fcpfte Jobs in die Vorschau einbeziehen. Response (Beispiel):
{\n \"preview\": {\n \"jobId\": 42,\n \"relatedJobs\": [{ \"id\": 42 }, { \"id\": 73 }],\n \"pathCandidates\": {\n \"raw\": [{ \"path\": \"/mnt/raw/...\", \"exists\": true, \"isDirectory\": true }],\n \"movie\": [{ \"path\": \"/mnt/movies/...\", \"exists\": true, \"isDirectory\": true }]\n }\n }\n}\nL\u00f6scht Dateien eines Jobs, beh\u00e4lt DB-Eintrag.
Request:
{\n \"target\": \"both\",\n \"includeRelated\": true,\n \"selectedRawPaths\": [\"/mnt/raw/Inception - RAW - Disc1\"],\n \"selectedMoviePaths\": [\"/mnt/movies/Inception (2010)\"]\n}\ntarget: raw | movie | both
selectedRawPaths / selectedMoviePaths sind optional und begrenzen die L\u00f6schung auf ausgew\u00e4hlte Pfade aus der Vorschau.
L\u00f6scht Job aus DB; optional auch Dateien.
Request:
{\n \"target\": \"both\",\n \"includeRelated\": true,\n \"resetDriveState\": false,\n \"keepDetectedDevice\": true,\n \"preserveRawForImportJobs\": false,\n \"selectedRawPaths\": [\"/mnt/raw/Inception - RAW - Disc1\"],\n \"selectedMoviePaths\": [\"/mnt/movies/Inception (2010)\"]\n}\ntarget: none | raw | movie | both
Response (Beispiel):
{\n \"deleted\": true,\n \"jobId\": 42,\n \"fileTarget\": \"both\",\n \"fileSummary\": {\n \"target\": \"both\",\n \"raw\": { \"filesDeleted\": 10 },\n \"movie\": { \"filesDeleted\": 1 }\n },\n \"uiReset\": {\n \"reset\": true,\n \"state\": \"IDLE\"\n },\n \"safeguards\": {\n \"containsOrphanRawImportJob\": false,\n \"resetDriveStateApplied\": false,\n \"keepDetectedDeviceApplied\": true\n }\n}\n409).includeRelated und Pfadselektionen den genauen Scope.Endpunkte zur Steuerung des Pipeline-Workflows.
"},{"location":"api/pipeline/#get-apipipelinestate","title":"GET /api/pipeline/state","text":"Liefert aktuellen Pipeline- und Hardware-Monitoring-Snapshot.
Response (Beispiel):
{\n \"pipeline\": {\n \"state\": \"READY_TO_ENCODE\",\n \"activeJobId\": 42,\n \"progress\": 0,\n \"eta\": null,\n \"statusText\": \"Mediainfo best\u00e4tigt - Encode manuell starten\",\n \"context\": {\n \"jobId\": 42\n },\n \"jobProgress\": {\n \"42\": {\n \"state\": \"MEDIAINFO_CHECK\",\n \"progress\": 68.5,\n \"eta\": null,\n \"statusText\": \"MEDIAINFO_CHECK 68.50%\"\n }\n },\n \"queue\": {\n \"maxParallelJobs\": 1,\n \"runningCount\": 1,\n \"queuedCount\": 2,\n \"runningJobs\": [],\n \"queuedJobs\": []\n }\n },\n \"hardwareMonitoring\": {\n \"enabled\": true,\n \"intervalMs\": 5000,\n \"updatedAt\": \"2026-03-10T09:00:00.000Z\",\n \"sample\": {\n \"cpu\": {},\n \"memory\": {},\n \"gpu\": {},\n \"storage\": {}\n },\n \"error\": null\n }\n}\nStartet Disc-Analyse und legt Job an.
Response:
{\n \"result\": {\n \"jobId\": 42,\n \"detectedTitle\": \"INCEPTION\",\n \"omdbCandidates\": []\n }\n}\nErzwingt erneute Laufwerkspr\u00fcfung.
Response (Beispiel):
{\n \"result\": {\n \"present\": true,\n \"changed\": true,\n \"emitted\": \"discInserted\",\n \"device\": {\n \"path\": \"/dev/sr0\",\n \"discLabel\": \"INCEPTION\",\n \"mediaProfile\": \"bluray\"\n }\n }\n}\nErzwingt Rescan f\u00fcr ein konkretes Laufwerk.
Request:
{ \"devicePath\": \"/dev/sr0\" }\nOMDb-Titelsuche.
Response:
{\n \"results\": [\n {\n \"imdbId\": \"tt1375666\",\n \"title\": \"Inception\",\n \"year\": \"2010\",\n \"type\": \"movie\",\n \"poster\": \"https://...\"\n }\n ]\n}\nTMDb-Seriensuche (f\u00fcr Serien-Workflow bei DVD/Blu-ray).
","text":""},{"location":"api/pipeline/#get-apipipelinecddrives","title":"GET /api/pipeline/cd/drivesLiefert Snapshot der aktuell bekannten CD-Laufwerke.
","text":""},{"location":"api/pipeline/#get-apipipelinecdmusicbrainzsearchq","title":"GET /api/pipeline/cd/musicbrainz/search?q=MusicBrainz-Suche f\u00fcr CD-Metadaten.
","text":""},{"location":"api/pipeline/#get-apipipelinecdmusicbrainzreleasembid","title":"GET /api/pipeline/cd/musicbrainz/release/:mbIdL\u00e4dt Release-Details zu einer MusicBrainz-ID.
","text":""},{"location":"api/pipeline/#post-apipipelinecdselect-metadata","title":"POST /api/pipeline/cd/select-metadata\u00dcbernimmt CD-Metadaten f\u00fcr einen Job.
Request (Beispiel):
{\n \"jobId\": 91,\n \"title\": \"Album\",\n \"artist\": \"Artist\",\n \"year\": 2020,\n \"mbId\": \"f5093c06-23e3-404f-aeaa-40f72885ee3a\",\n \"coverUrl\": \"https://...\",\n \"tracks\": []\n}\nStartet/queued CD-Rip mit Format-/Script-/Chain-Konfiguration.
","text":""},{"location":"api/pipeline/#post-apipipelineaudiobookupload","title":"POST /api/pipeline/audiobook/uploadUpload von AAX-Datei (Multipart/FormData).
FormData-Felder:
file (Pflicht)format (optional)startImmediately (optional)Zeigt AAX-Jobs mit fehlenden Activation-Bytes.
","text":""},{"location":"api/pipeline/#post-apipipelineaudiobookstartjobid","title":"POST /api/pipeline/audiobook/start/:jobIdStartet Audiobook-Job mit optionaler Konfiguration.
","text":""},{"location":"api/pipeline/#get-apipipelineaudiobookjobs","title":"GET /api/pipeline/audiobook/jobsLiefert Audiobook-Jobliste.
","text":""},{"location":"api/pipeline/#get-apipipelineaudiobookoutput-tree","title":"GET /api/pipeline/audiobook/output-treeRead-only Baumansicht des Audiobook-Ausgabeordners.
","text":""},{"location":"api/pipeline/#post-apipipelineselect-metadata","title":"POST /api/pipeline/select-metadataSetzt Metadaten (und optional Playlist) f\u00fcr einen Job.
Request:
{\n \"jobId\": 42,\n \"title\": \"Inception\",\n \"year\": 2010,\n \"imdbId\": \"tt1375666\",\n \"poster\": \"https://...\",\n \"fromOmdb\": true,\n \"selectedPlaylist\": \"00800\"\n}\nWichtige optionale Felder:
selectedHandBrakeTitleId / selectedHandBrakeTitleIds: Titel-Auswahl f\u00fcr Review/MediaInfo.metadataProvider: omdb oder tmdb.workflowKind: bei Disc-Jobs typischerweise film oder series.discNumber: Pflicht f\u00fcr Serien-Disc-Zuordnung (workflowKind=series).duplicateAction: Duplikatverhalten bei Film-Metadaten (allow_new oder multipart_movie).existingJobId: optionaler Referenzjob f\u00fcr multipart_movie.existingDiscNumber: Disc-Nummer des bestehenden Jobs f\u00fcr multipart_movie.Response:
{ \"job\": { \"id\": 42, \"status\": \"READY_TO_START\" } }\nKonflikt-Response (Beispiel, HTTP 409):
{\n \"message\": \"Metadaten bereits in der Historie gefunden. Bitte Auswahl \u00fcbernehmen oder Multipart movie w\u00e4hlen.\",\n \"details\": [\n {\n \"code\": \"METADATA_DUPLICATE_FOUND\",\n \"mediaProfile\": \"bluray\",\n \"existingJob\": {\n \"id\": 17,\n \"title\": \"Inception\",\n \"year\": 2010,\n \"status\": \"FINISHED\",\n \"jobKind\": \"bluray\",\n \"discNumber\": 1,\n \"isMultipartMovie\": false\n }\n }\n ]\n}\nRelevante Fehlercodes (POST /api/pipeline/select-metadata):
METADATA_DUPLICATE_FOUND Film-Metadaten existieren bereits in der Historie (Konfliktdialog im UI). MULTIPART_DISC_REQUIRED F\u00fcr Multipart fehlen Disc-Nummern (discNumber/existingDiscNumber). MULTIPART_DISC_ALREADY_EXISTS Disc-Nummer im Multipart-Container bereits vergeben oder doppelt. MULTIPART_MEDIA_MISMATCH Multipart nur bei gleichem Medientyp (DVD oder Blu-ray). MULTIPART_SERIES_NOT_ALLOWED Multipart ist nur f\u00fcr Film-Jobs erlaubt, nicht f\u00fcr Serien-Workflow. MULTIPART_METADATA_MISMATCH Ausgew\u00e4hlter bestehender Job passt nicht zu den Film-Metadaten. SERIES_DISC_ALREADY_EXISTS Serien-Disc-Nummer innerhalb einer Staffel bereits vorhanden.","text":""},{"location":"api/pipeline/#post-apipipelinejobsjobidraw-decision","title":"POST /api/pipeline/jobs/:jobId/raw-decision Trifft Entscheidung bei vorhandenem RAW (continue oder restart je nach Dialogfluss).
Request:
{ \"decision\": \"continue\" }\nStartet vorbereiteten Job oder queued ihn (je nach Parallel-Limit).
M\u00f6gliche Responses:
{ \"result\": { \"started\": true, \"stage\": \"RIPPING\" } }\n{ \"result\": { \"queued\": true, \"started\": false, \"queuePosition\": 2, \"action\": \"START_PREPARED\" } }\nBest\u00e4tigt Review-Auswahl (Tracks, Pre/Post-Skripte/Ketten, User-Preset).
Request (typisch):
{\n \"selectedEncodeTitleId\": 1,\n \"selectedTrackSelection\": {\n \"1\": {\n \"audioTrackIds\": [1, 2],\n \"subtitleTrackIds\": [3]\n }\n },\n \"selectedPreEncodeScriptIds\": [1],\n \"selectedPostEncodeScriptIds\": [2, 7],\n \"selectedPreEncodeChainIds\": [3],\n \"selectedPostEncodeChainIds\": [4],\n \"selectedUserPresetId\": 5,\n \"skipPipelineStateUpdate\": false\n}\nResponse:
{ \"job\": { \"id\": 42, \"encode_review_confirmed\": 1 } }\nBricht laufenden Job ab oder entfernt Queue-Eintrag.
Request (optional):
{ \"jobId\": 42 }\nM\u00f6gliche Responses:
{ \"result\": { \"cancelled\": true, \"queuedOnly\": true, \"jobId\": 42 } }\n{ \"result\": { \"cancelled\": true, \"queuedOnly\": false, \"jobId\": 42 } }\n{ \"result\": { \"cancelled\": true, \"queuedOnly\": false, \"pending\": true, \"jobId\": 42 } }\nRetry f\u00fcr ERROR/CANCELLED-Jobs (oder Queue-Einreihung).
Startet Re-Encode aus bestehendem RAW.
","text":""},{"location":"api/pipeline/#post-apipipelinerestart-reviewjobid","title":"POST /api/pipeline/restart-review/:jobIdBerechnet Review aus RAW neu.
","text":""},{"location":"api/pipeline/#post-apipipelinerestart-encodejobid","title":"POST /api/pipeline/restart-encode/:jobIdStartet Encoding mit letzter best\u00e4tigter Review neu.
","text":""},{"location":"api/pipeline/#post-apipipelinerestart-cd-reviewjobid","title":"POST /api/pipeline/restart-cd-review/:jobIdBerechnet CD-Review aus vorhandenem RAW neu.
","text":""},{"location":"api/pipeline/#post-apipipelineresume-readyjobid","title":"POST /api/pipeline/resume-ready/:jobIdL\u00e4dt READY_TO_ENCODE-Job nach Neustart wieder in aktive Session.
Liefert bekannte Output-Ordner entlang der Job-Lineage.
","text":""},{"location":"api/pipeline/#post-apipipelinedelete-output-foldersjobid","title":"POST /api/pipeline/delete-output-folders/:jobIdL\u00f6scht ausgew\u00e4hlte Output-Ordner.
Request:
{ \"folderPaths\": [\"/mnt/movies/Inception (2010)\"] }\nAlle Endpunkte liefern { result: ... } bzw. { job: ... }.
Liefert Queue-Snapshot.
{\n \"queue\": {\n \"maxParallelJobs\": 1,\n \"runningCount\": 1,\n \"queuedCount\": 3,\n \"runningJobs\": [\n {\n \"jobId\": 41,\n \"title\": \"Inception\",\n \"status\": \"ENCODING\",\n \"lastState\": \"ENCODING\"\n }\n ],\n \"queuedJobs\": [\n {\n \"entryId\": 11,\n \"position\": 1,\n \"type\": \"job\",\n \"jobId\": 42,\n \"action\": \"START_PREPARED\",\n \"actionLabel\": \"Start\",\n \"title\": \"Matrix\",\n \"status\": \"READY_TO_ENCODE\",\n \"lastState\": \"READY_TO_ENCODE\",\n \"hasScripts\": true,\n \"hasChains\": false,\n \"enqueuedAt\": \"2026-03-10T09:00:00.000Z\"\n },\n {\n \"entryId\": 12,\n \"position\": 2,\n \"type\": \"wait\",\n \"waitSeconds\": 30,\n \"title\": \"Warten 30s\",\n \"status\": \"QUEUED\",\n \"enqueuedAt\": \"2026-03-10T09:01:00.000Z\"\n }\n ],\n \"updatedAt\": \"2026-03-10T09:01:02.000Z\"\n }\n}\nSortiert Queue-Eintr\u00e4ge neu.
Request:
{\n \"orderedEntryIds\": [12, 11]\n}\nLegacy fallback wird akzeptiert:
{\n \"orderedJobIds\": [42, 43]\n}\nF\u00fcgt Nicht-Job-Queue-Eintrag hinzu (script, chain, wait).
Request-Beispiele:
{ \"type\": \"script\", \"scriptId\": 3 }\n{ \"type\": \"chain\", \"chainId\": 2, \"insertAfterEntryId\": 11 }\n{ \"type\": \"wait\", \"waitSeconds\": 45 }\nResponse:
{\n \"result\": { \"entryId\": 12, \"type\": \"wait\", \"position\": 2 },\n \"queue\": { \"...\": \"...\" }\n}\nEntfernt Queue-Eintrag.
Response:
{ \"queue\": { \"...\": \"...\" } }\nIDLE Wartet auf Medium DISC_DETECTED Medium erkannt ANALYZING MakeMKV-Analyse l\u00e4uft METADATA_SELECTION Metadaten-Auswahl WAITING_FOR_USER_DECISION Nutzerentscheidung erforderlich (Playlist-Auswahl oder RAW-Entscheidung) READY_TO_START \u00dcbergang vor Start RIPPING MakeMKV-Rip l\u00e4uft MEDIAINFO_CHECK Titel-/Track-Auswertung READY_TO_ENCODE Review bereit ENCODING HandBrake-Encoding l\u00e4uft CD_METADATA_SELECTION CD-Metadatenauswahl aktiv CD_READY_TO_RIP CD-Job ist startbereit CD_ANALYZING CD-Struktur/Tracks werden vorbereitet CD_RIPPING CD-Ripping l\u00e4uft CD_ENCODING CD-Encode l\u00e4uft FINISHED Abgeschlossen DONE Abgeschlossen (v. a. Audiobook/Converter/CD-Varianten) CANCELLED Abgebrochen ERROR Fehler","text":""},{"location":"api/runtime-activities/","title":"Runtime Activities API","text":"Ripster verfolgt alle laufenden und k\u00fcrzlich abgeschlossenen Aktivit\u00e4ten (Skripte, Skript-Ketten, Cron-Jobs, interne Tasks) in Echtzeit \u00fcber den RuntimeActivityService.
Aktivit\u00e4ten entstehen, wenn Ripster intern Aktionen ausf\u00fchrt \u2013 z. B. beim Start eines Cron-Jobs, beim Ausf\u00fchren einer Skript-Kette oder beim Durchlaufen von Pipeline-Schritten. Sie sind nicht persistent (kein DB-Speicher) und werden nur im Arbeitsspeicher gehalten.
active): Laufen gerade.recent): Abgeschlossen, max. 120 Eintr\u00e4ge.\u00c4nderungen werden \u00fcber WebSocket (RUNTIME_ACTIVITY_CHANGED) in Echtzeit gesendet.
{\n \"id\": 7,\n \"type\": \"chain\",\n \"name\": \"Post-Encode Aufr\u00e4umen\",\n \"status\": \"running\",\n \"source\": \"cron\",\n \"message\": \"Schritt 2 von 3\",\n \"currentStep\": \"cleanup.sh\",\n \"currentStepType\": \"script\",\n \"currentScriptName\": \"cleanup.sh\",\n \"stepIndex\": 2,\n \"stepTotal\": 3,\n \"parentActivityId\": null,\n \"jobId\": 42,\n \"cronJobId\": 3,\n \"chainId\": 5,\n \"scriptId\": null,\n \"canCancel\": true,\n \"canNextStep\": false,\n \"outcome\": \"running\",\n \"errorMessage\": null,\n \"output\": null,\n \"stdout\": null,\n \"stderr\": null,\n \"stdoutTruncated\": false,\n \"stderrTruncated\": false,\n \"startedAt\": \"2026-03-10T10:00:00.000Z\",\n \"finishedAt\": null,\n \"durationMs\": null,\n \"exitCode\": null,\n \"success\": null\n}\nid number Eindeutige ID (Laufz\u00e4hler, nicht persistent) type string Art der Aktivit\u00e4t: script | chain | cron | task name string \\| null Anzeigename der Aktivit\u00e4t status string Aktueller Status: running | success | error source string \\| null Ausl\u00f6ser (z. B. cron, pipeline, manual) message string \\| null Kurztext zum aktuellen Zustand currentStep string \\| null Name des aktuell ausgef\u00fchrten Schritts currentStepType string \\| null Typ des Schritts (z. B. script, wait) currentScriptName string \\| null Name des Skripts im aktuellen Schritt stepIndex number \\| null Aktueller Schritt (1-basiert) stepTotal number \\| null Gesamtanzahl Schritte parentActivityId number \\| null ID der \u00fcbergeordneten Aktivit\u00e4t jobId number \\| null Verkn\u00fcpfte Job-ID cronJobId number \\| null Verkn\u00fcpfte Cron-Job-ID chainId number \\| null Verkn\u00fcpfte Skript-Ketten-ID scriptId number \\| null Verkn\u00fcpfte Skript-ID canCancel boolean Abbrechen \u00fcber API m\u00f6glich canNextStep boolean N\u00e4chster Schritt \u00fcber API ausl\u00f6sbar outcome string \\| null Abschluss-Ergebnis: success | error | cancelled | skipped | running errorMessage string \\| null Fehlermeldung (max. 2.000 Zeichen) output string \\| null Allgemeine Ausgabe (max. 12.000 Zeichen) stdout string \\| null Standardausgabe des Prozesses (max. 12.000 Zeichen) stderr string \\| null Fehlerausgabe des Prozesses (max. 12.000 Zeichen) stdoutTruncated boolean true, wenn stdout gek\u00fcrzt wurde stderrTruncated boolean true, wenn stderr gek\u00fcrzt wurde startedAt string ISO-8601-Zeitstempel des Starts finishedAt string \\| null ISO-8601-Zeitstempel des Endes durationMs number \\| null Laufzeit in Millisekunden exitCode number \\| null Exit-Code des Prozesses success boolean \\| null Erfolgsstatus (null bei laufender Aktivit\u00e4t)"},{"location":"api/runtime-activities/#snapshot-objekt","title":"Snapshot-Objekt","text":"Alle Aktivit\u00e4ts-Endpunkte geben einen Snapshot zur\u00fcck:
{\n \"active\": [ /* laufende Aktivit\u00e4ten, nach startedAt absteigend */ ],\n \"recent\": [ /* abgeschlossene Aktivit\u00e4ten, nach finishedAt absteigend, max. 120 */ ],\n \"updatedAt\": \"2026-03-10T10:05:00.000Z\"\n}\n/api/runtime/activities","text":"Aktuellen Aktivit\u00e4ts-Snapshot abrufen.
Antwort:
{\n \"active\": [],\n \"recent\": [\n {\n \"id\": 5,\n \"type\": \"script\",\n \"name\": \"notify.sh\",\n \"status\": \"success\",\n \"outcome\": \"success\",\n \"startedAt\": \"2026-03-10T09:58:00.000Z\",\n \"finishedAt\": \"2026-03-10T09:58:02.000Z\",\n \"durationMs\": 2100,\n \"exitCode\": 0,\n \"success\": true,\n \"canCancel\": false,\n \"canNextStep\": false\n }\n ],\n \"updatedAt\": \"2026-03-10T10:05:00.000Z\"\n}\n/api/runtime/activities/:id/cancel","text":"Aktive Aktivit\u00e4t abbrechen (nur wenn canCancel: true).
Parameter:
Name In Typ Beschreibungid path number Aktivit\u00e4ts-ID reason body string Optionaler Abbruchgrund Request Body:
{ \"reason\": \"Manueller Abbruch durch Benutzer\" }\nAntwort (Erfolg):
{\n \"ok\": true,\n \"action\": null,\n \"snapshot\": { \"active\": [], \"recent\": [], \"updatedAt\": \"...\" }\n}\nFehlercodes:
HTTP Bedeutung404 Aktivit\u00e4t nicht gefunden oder bereits abgeschlossen 409 Abbrechen wird von dieser Aktivit\u00e4t nicht unterst\u00fctzt"},{"location":"api/runtime-activities/#post-apiruntimeactivitiesidnext-step","title":"POST /api/runtime/activities/:id/next-step","text":"N\u00e4chsten Schritt einer Aktivit\u00e4t ausl\u00f6sen (nur wenn canNextStep: true).
Parameter:
Name In Typ Beschreibungid path number Aktivit\u00e4ts-ID Antwort (Erfolg):
{\n \"ok\": true,\n \"action\": null,\n \"snapshot\": { \"active\": [], \"recent\": [], \"updatedAt\": \"...\" }\n}\nFehlercodes:
HTTP Bedeutung404 Aktivit\u00e4t nicht gefunden 409 N\u00e4chster Schritt wird von dieser Aktivit\u00e4t nicht unterst\u00fctzt"},{"location":"api/runtime-activities/#post-apiruntimeactivitiesclear-recent","title":"POST /api/runtime/activities/clear-recent","text":"Alle abgeschlossenen Aktivit\u00e4ten aus recent l\u00f6schen.
Antwort:
{\n \"ok\": true,\n \"removed\": 14,\n \"snapshot\": { \"active\": [], \"recent\": [], \"updatedAt\": \"...\" }\n}\nrecent-Eintr\u00e4ge 120 Maximale L\u00e4nge stdout / stderr / output 12.000 Zeichen Maximale L\u00e4nge errorMessage / message 2.000 Zeichen Maximale L\u00e4nge outcome 40 Zeichen Gek\u00fcrzte Ausgaben erhalten den Suffix ...[gek\u00fcrzt] (bei Inline-Text) bzw. \\n...[gek\u00fcrzt] (bei mehrzeiligem Output).
\u00c4nderungen werden automatisch als RUNTIME_ACTIVITY_CHANGED WebSocket-Event gesendet. Die Frontend-Komponente braucht GET /api/runtime/activities nur beim initialen Laden aufzurufen.
Endpunkte f\u00fcr Einstellungen, Skripte, Skript-Ketten und User-Presets.
"},{"location":"api/settings/#get-apisettings","title":"GET /api/settings","text":"Liefert alle Einstellungen kategorisiert.
Response (Struktur):
{\n \"categories\": [\n {\n \"category\": \"Pfade\",\n \"settings\": [\n {\n \"key\": \"raw_dir\",\n \"label\": \"Raw Ausgabeordner\",\n \"type\": \"path\",\n \"required\": true,\n \"description\": \"...\",\n \"defaultValue\": \"data/output/raw\",\n \"options\": [],\n \"validation\": { \"minLength\": 1 },\n \"value\": \"data/output/raw\",\n \"orderIndex\": 100\n }\n ]\n }\n ]\n}\nAktualisiert eine einzelne Einstellung.
Request:
{ \"value\": \"/mnt/storage/raw\" }\nResponse:
{\n \"setting\": {\n \"key\": \"raw_dir\",\n \"value\": \"/mnt/storage/raw\"\n },\n \"reviewRefresh\": {\n \"triggered\": false,\n \"reason\": \"not_ready\"\n }\n}\nreviewRefresh ist null oder ein Objekt mit Status der optionalen Review-Neuberechnung.
Aktualisiert mehrere Einstellungen atomar.
Request:
{\n \"settings\": {\n \"raw_dir\": \"/mnt/storage/raw\",\n \"movie_dir\": \"/mnt/storage/movies\",\n \"handbrake_preset_bluray\": \"H.264 MKV 1080p30\"\n }\n}\nResponse:
{\n \"changes\": [\n { \"key\": \"raw_dir\", \"value\": \"/mnt/storage/raw\" },\n { \"key\": \"movie_dir\", \"value\": \"/mnt/storage/movies\" }\n ],\n \"reviewRefresh\": {\n \"triggered\": true,\n \"jobId\": 42,\n \"relevantKeys\": [\"handbrake_preset_bluray\"]\n }\n}\nBei Validierungsfehlern kommt 400 mit error.details[].
Liest Preset-Liste via HandBrakeCLI -z (mit Fallback auf konfigurierte Presets).
Response (Beispiel):
{\n \"source\": \"handbrake-cli\",\n \"message\": null,\n \"options\": [\n { \"label\": \"General/\", \"value\": \"__group__general\", \"disabled\": true, \"category\": \"General\" },\n { \"label\": \" Fast 1080p30\", \"value\": \"Fast 1080p30\", \"category\": \"General\" }\n ]\n}\nSendet Testnachricht \u00fcber aktuelle PushOver-Settings.
Request (optional):
{\n \"title\": \"Test\",\n \"message\": \"Ripster Test\"\n}\nResponse:
{\n \"result\": {\n \"sent\": true,\n \"eventKey\": \"test\",\n \"requestId\": \"...\"\n }\n}\nWenn PushOver deaktiviert ist oder Credentials fehlen, kommt i. d. R. ebenfalls 200 mit sent: false + reason.
Basis: /api/settings/scripts
{ \"scripts\": [ { \"id\": 1, \"name\": \"...\", \"scriptBody\": \"...\", \"orderIndex\": 1, \"createdAt\": \"...\", \"updatedAt\": \"...\" } ] }\n{ \"name\": \"Move\", \"scriptBody\": \"mv \\\"$RIPSTER_OUTPUT_PATH\\\" /mnt/movies/\" }\nResponse: 201 mit { \"script\": { ... } }
Body wie POST, Response { \"script\": { ... } }.
Response { \"removed\": { ... } }.
{ \"orderedScriptIds\": [3, 1, 2] }\nResponse { \"scripts\": [ ... ] }.
F\u00fchrt Skript als Testlauf aus.
{\n \"result\": {\n \"scriptId\": 1,\n \"scriptName\": \"Move\",\n \"success\": true,\n \"exitCode\": 0,\n \"signal\": null,\n \"timedOut\": false,\n \"durationMs\": 120,\n \"stdout\": \"...\",\n \"stderr\": \"...\",\n \"stdoutTruncated\": false,\n \"stderrTruncated\": false\n }\n}\nDiese Variablen werden beim Ausf\u00fchren gesetzt:
RIPSTER_SCRIPT_RUN_ATRIPSTER_JOB_IDRIPSTER_JOB_TITLERIPSTER_MODERIPSTER_INPUT_PATHRIPSTER_OUTPUT_PATHRIPSTER_RAW_PATHRIPSTER_SCRIPT_IDRIPSTER_SCRIPT_NAMERIPSTER_SCRIPT_SOURCEBasis: /api/settings/script-chains
Eine Kette hat Schritte vom Typ:
script (scriptId erforderlich)wait (waitSeconds 1..3600)Response { \"chains\": [ ... ] } (inkl. steps[]).
Response { \"chain\": { ... } }.
{\n \"name\": \"After Encode\",\n \"steps\": [\n { \"stepType\": \"script\", \"scriptId\": 1 },\n { \"stepType\": \"wait\", \"waitSeconds\": 15 },\n { \"stepType\": \"script\", \"scriptId\": 2 }\n ]\n}\nResponse: 201 mit { \"chain\": { ... } }
Body wie POST, Response { \"chain\": { ... } }.
Response { \"removed\": { ... } }.
{ \"orderedChainIds\": [2, 1, 3] }\nResponse { \"chains\": [ ... ] }.
Response:
{\n \"result\": {\n \"chainId\": 2,\n \"chainName\": \"After Encode\",\n \"steps\": 3,\n \"succeeded\": 3,\n \"failed\": 0,\n \"aborted\": false,\n \"results\": []\n }\n}\nBasis: /api/settings/user-presets
Optionaler Query-Parameter: media_type=bluray|dvd|other|all
{\n \"presets\": [\n {\n \"id\": 1,\n \"name\": \"Blu-ray HQ\",\n \"mediaType\": \"bluray\",\n \"handbrakePreset\": \"H.264 MKV 1080p30\",\n \"extraArgs\": \"--encoder-preset slow\",\n \"description\": \"...\",\n \"createdAt\": \"...\",\n \"updatedAt\": \"...\"\n }\n ]\n}\n{\n \"name\": \"Blu-ray HQ\",\n \"mediaType\": \"bluray\",\n \"handbrakePreset\": \"H.264 MKV 1080p30\",\n \"extraArgs\": \"--encoder-preset slow\",\n \"description\": \"optional\"\n}\nResponse: 201 mit { \"preset\": { ... } }
Body mit beliebigen Feldern aus POST, Response { \"preset\": { ... } }.
Response { \"removed\": { ... } }.
Liefert aufgel\u00f6ste, effektiv genutzte Pfade aus den Settings (f\u00fcr UI- und Diagnosezwecke).
"},{"location":"api/settings/#post-apisettingscoverartrecover","title":"POST /api/settings/coverart/recover","text":"Startet eine manuelle Coverart-Recovery.
Response (Beispiel):
{\n \"result\": { \"started\": true },\n \"scheduler\": { \"enabled\": true }\n}\nLiest gecachte AAX-Activation-Bytes.
"},{"location":"api/settings/#post-apisettingsactivation-bytes","title":"POST /api/settings/activation-bytes","text":"Speichert Activation-Bytes.
Request:
{\n \"checksum\": \"abc123...\",\n \"activationBytes\": \"1a2b3c4d\"\n}\nLiefert erkannte optische Laufwerke (/dev/...) inkl. MakeMKV-Disc-Index.
Erzwingt Entsperren aktiver Laufwerkslocks.
Hinweis: Expertenmodus (ui_expert_mode) ist erforderlich, sonst 403.
Request (ein Laufwerk):
{ \"devicePath\": \"/dev/sr0\" }\nRequest (alle):
{ \"all\": true }\nLiest einen persistierten UI-Preference-Wert.
"},{"location":"api/settings/#put-apisettingsprefskey","title":"PUT /api/settings/prefs/:key","text":"Speichert einen persistierten UI-Preference-Wert.
Request:
{ \"value\": \"{\\\"columns\\\":[\\\"id\\\",\\\"status\\\"]}\" }\nRipster sendet Echtzeit-Updates \u00fcber /ws.
const ws = new WebSocket('ws://localhost:3001/ws');\n\nws.onmessage = (event) => {\n const msg = JSON.parse(event.data);\n console.log(msg.type, msg.payload);\n};\nDie meisten Broadcasts haben dieses Schema:
{\n \"type\": \"EVENT_TYPE\",\n \"payload\": {},\n \"timestamp\": \"2026-03-10T09:00:00.000Z\"\n}\nAusnahme: WS_CONNECTED beim Verbindungsaufbau enth\u00e4lt kein timestamp.
Sofort nach erfolgreicher Verbindung.
{\n \"type\": \"WS_CONNECTED\",\n \"payload\": {\n \"connectedAt\": \"2026-03-10T09:00:00.000Z\"\n }\n}\nNeuer Pipeline-Snapshot.
{\n \"type\": \"PIPELINE_STATE_CHANGED\",\n \"payload\": {\n \"state\": \"ENCODING\",\n \"activeJobId\": 42,\n \"progress\": 62.5,\n \"eta\": \"00:12:34\",\n \"statusText\": \"ENCODING 62.50%\",\n \"context\": {},\n \"jobProgress\": {\n \"42\": {\n \"state\": \"ENCODING\",\n \"progress\": 62.5,\n \"eta\": \"00:12:34\",\n \"statusText\": \"ENCODING 62.50%\"\n }\n },\n \"queue\": {\n \"maxParallelJobs\": 1,\n \"runningCount\": 1,\n \"queuedCount\": 2,\n \"runningJobs\": [],\n \"queuedJobs\": []\n }\n }\n}\nLaufende Fortschrittsupdates.
{\n \"type\": \"PIPELINE_PROGRESS\",\n \"payload\": {\n \"state\": \"ENCODING\",\n \"activeJobId\": 42,\n \"progress\": 62.5,\n \"eta\": \"00:12:34\",\n \"statusText\": \"ENCODING 62.50%\"\n }\n}\nQueue-Snapshot aktualisiert.
"},{"location":"api/websocket/#disc_detected-disc_removed","title":"DISC_DETECTED / DISC_REMOVED","text":"Disc-Insertion/-Removal.
{\n \"type\": \"DISC_DETECTED\",\n \"payload\": {\n \"device\": {\n \"path\": \"/dev/sr0\",\n \"discLabel\": \"INCEPTION\",\n \"model\": \"ASUS BW-16D1HT\",\n \"fstype\": \"udf\",\n \"mountpoint\": null,\n \"mediaProfile\": \"bluray\"\n }\n }\n}\nmediaProfile: bluray | dvd | other | null
Snapshot aus Hardware-Monitoring.
{\n \"type\": \"HARDWARE_MONITOR_UPDATE\",\n \"payload\": {\n \"enabled\": true,\n \"intervalMs\": 5000,\n \"updatedAt\": \"2026-03-10T09:00:00.000Z\",\n \"sample\": {\n \"cpu\": {},\n \"memory\": {},\n \"gpu\": {},\n \"storage\": {}\n },\n \"error\": null\n }\n}\nFehler bei Disc-Event-Verarbeitung in Pipeline.
"},{"location":"api/websocket/#disk_detection_error","title":"DISK_DETECTION_ERROR","text":"Fehler in Laufwerkserkennung.
"},{"location":"api/websocket/#settings_updated","title":"SETTINGS_UPDATED","text":"Einzelnes Setting wurde gespeichert.
"},{"location":"api/websocket/#settings_bulk_updated","title":"SETTINGS_BULK_UPDATED","text":"Bulk-Settings gespeichert.
{\n \"type\": \"SETTINGS_BULK_UPDATED\",\n \"payload\": {\n \"count\": 3,\n \"keys\": [\"raw_dir\", \"movie_dir\", \"handbrake_preset_bluray\"]\n }\n}\nSkript ge\u00e4ndert (created|updated|deleted|reordered).
Skript-Kette ge\u00e4ndert (created|updated|deleted|reordered).
User-Preset ge\u00e4ndert (created|updated|deleted).
Cron-Config ge\u00e4ndert (created|updated|deleted).
Laufzeitstatus eines Cron-Jobs ge\u00e4ndert.
{\n \"type\": \"CRON_JOB_UPDATED\",\n \"payload\": {\n \"id\": 1,\n \"lastRunStatus\": \"running\",\n \"lastRunAt\": \"2026-03-10T10:00:00.000Z\",\n \"nextRunAt\": null\n }\n}\nVollst\u00e4ndiger Snapshot aller laufenden und k\u00fcrzlich abgeschlossenen Aktivit\u00e4ten.
Wird ausgel\u00f6st, wenn eine Aktivit\u00e4t gestartet, aktualisiert oder abgeschlossen wird sowie nach clear-recent.
{\n \"type\": \"RUNTIME_ACTIVITY_CHANGED\",\n \"payload\": {\n \"active\": [\n {\n \"id\": 7,\n \"type\": \"chain\",\n \"name\": \"Post-Encode Aufr\u00e4umen\",\n \"status\": \"running\",\n \"source\": \"cron\",\n \"message\": \"Schritt 2 von 3\",\n \"currentStep\": \"cleanup.sh\",\n \"currentStepType\": \"script\",\n \"stepIndex\": 2,\n \"stepTotal\": 3,\n \"canCancel\": true,\n \"canNextStep\": false,\n \"outcome\": \"running\",\n \"startedAt\": \"2026-03-10T10:00:00.000Z\",\n \"finishedAt\": null,\n \"durationMs\": null\n }\n ],\n \"recent\": [],\n \"updatedAt\": \"2026-03-10T10:00:05.000Z\"\n }\n}\nVollst\u00e4ndige Feldbeschreibung: Runtime Activities API.
"},{"location":"api/websocket/#converter_scan_update","title":"CONVERTER_SCAN_UPDATE","text":"Wird nach einem Scan des Converter-Eingangsordners gesendet (manuell oder per Polling).
{\n \"type\": \"CONVERTER_SCAN_UPDATE\",\n \"payload\": {\n \"entryCount\": 12\n }\n}\nWird bei jeder Status\u00e4nderung in der Download-Queue gesendet.
{\n \"type\": \"DOWNLOADS_UPDATED\",\n \"payload\": {\n \"reason\": \"ready\",\n \"item\": {\n \"id\": \"dl-1\",\n \"jobId\": 42,\n \"status\": \"ready\",\n \"archiveName\": \"Job_42_movie.zip\",\n \"createdAt\": \"2026-03-30T10:00:00.000Z\"\n },\n \"summary\": {\n \"total\": 3,\n \"pending\": 1,\n \"processing\": 0,\n \"ready\": 1,\n \"failed\": 1\n }\n }\n}\nM\u00f6gliche reason-Werte: queued, processing, ready, failed, deleted.
useWebSocket verbindet bei Abbruch automatisch neu:
1500msDieser Bereich enth\u00e4lt die technische Referenz hinter dem Benutzerhandbuch.
"},{"location":"appendix/#inhalt","title":"Inhalt","text":"Ripster ist eine Client-Server-Anwendung mit REST + WebSocket und externen CLI-Tools.
"},{"location":"architecture/#systemuberblick","title":"System\u00fcberblick","text":"graph TB\n subgraph Browser[\"Browser (React)\"]\n Ripper[Ripper]\n Settings[Einstellungen]\n History[Historie]\n end\n\n subgraph Backend[\"Node.js Backend\"]\n API[REST API\\nExpress]\n WS[WebSocket\\n/ws]\n Pipeline[pipelineService]\n Cron[cronService]\n DB[(SQLite)]\n end\n\n subgraph Tools[\"Externe Tools\"]\n MakeMKV[makemkvcon]\n HandBrake[HandBrakeCLI]\n MediaInfo[mediainfo]\n end\n\n Browser <-->|HTTP| API\n Browser <-->|WebSocket| WS\n Pipeline --> MakeMKV\n Pipeline --> HandBrake\n Pipeline --> MediaInfo\n API --> DB\n Pipeline --> DB\n Cron --> DBDas Backend ist in Services aufgeteilt, die von Express-Routen orchestriert werden. Seit v0.12.0 erfolgt die Medienverarbeitung \u00fcber ein Plugin-System.
"},{"location":"architecture/backend/#plugin-system-srcplugins","title":"Plugin-System (src/plugins/)","text":"Ab v0.12.0 ist die Pipeline modular aufgebaut. Jeder Medientyp wird von einem eigenen Plugin verwaltet.
"},{"location":"architecture/backend/#basisklassen","title":"Basisklassen","text":"PluginBase.js \u2014 Abstrakte Basisklasse SourcePlugin mit Lifecycle-MethodenPluginRegistry.js \u2014 Dynamische Plugin-Erkennung, priorit\u00e4tsbasierte Auswahl, Settings-Schema-AggregationPluginContext.js \u2014 Ausf\u00fchrungskontext (Logger, Callbacks, Signals) f\u00fcr Plugin-AufrufeJedes Plugin implementiert die folgenden Methoden:
Methode Beschreibungdetect(discInfo) Medientyp-Erkennung analyze(devicePath, job, ctx) Analyse / Metadaten-Extraktion rip(job, ctx) Rohdaten-Extraktion review(job, ctx) Optionale Vorschau-Vorbereitung encode(job, ctx) Finales Encoding/Konvertierung finalize(job, ctx) Nachbearbeitung onCancel(job, ctx) Bereinigung bei Abbruch onRetry(job, ctx) Zustand-Reset vor Retry"},{"location":"architecture/backend/#implementierte-plugins","title":"Implementierte Plugins","text":"BluRayPlugin.js \u2014 Blu-ray via MakeMKV (Backup-Modus)DVDPlugin.js \u2014 DVD via MakeMKV (MKV-Modus)CdPlugin.js \u2014 Audio-CD via cdparanoia + FFmpeg (experimentell)AudiobookPlugin.js \u2014 AAX/M4B via FFmpeg mit Kapitel-SplittingConverterPlugin.js \u2014 Generische Audio/Video-Konvertierung via FFmpegVideoDiscPlugin.js \u2014 Gemeinsame Basis f\u00fcr Blu-ray/DVD (MediaInfo-Parsing)pipelineService.js","text":"Zentrale Workflow-Orchestrierung.
Aufgaben:
pipeline_state)script|chain|wait Eintr\u00e4ge)createConverterJobFromEntry, uploadConverterFiles, startConverterJob)Wichtige Methoden:
analyzeDisc()selectMetadata()startPreparedJob()confirmEncodeReview()cancel()retry()reencodeFromRaw()restartReviewFromRaw()restartEncodeWithLastSettings()resumeReadyToEncodeJob()enqueueNonJobEntry(), reorderQueue(), removeQueueEntry()createConverterJobFromEntry(), createConverterJobsFromSelection()uploadConverterFiles(), startConverterJob()diskDetectionService.js","text":"Pollt Laufwerk(e) und emittiert:
discInserteddiscRemovederrorZusatz:
auto oder explicitmediaProfile-Erkennung (bluray/dvd/other)rescanAndEmit() f\u00fcr manuellen TriggersettingsService.js","text":"Settings-Layer mit Validation/Serialisierung.
Features:
getCategorizedSettings() f\u00fcr UI-FormsetSettingValue() / setSettingsBulk()resolveEffectiveToolSettings)HandBrakeCLI -zmakemkv_registration_keyhistoryService.js","text":"Historie + Dateioperationen.
Features:
raw|movie|both)none|raw|movie|both)audiobookService.js","text":"Audiobook-Verarbeitung (AAX/M4B).
Features:
{author}, {title}, {year}, {narrator}, {series}, {part})activationBytesService.js","text":"Verwaltung von Audible-Activation-Bytes f\u00fcr AAX-DRM-Handling.
Features:
aax_activation_bytes-Tabelle cachenaudnexService (wenn konfiguriert)converterScanService.js","text":"Dateisystem-\u00dcberwachung des Converter-Eingangsordners.
Features:
getTree())getEntries())CONVERTER_SCAN_UPDATEdownloadService.js","text":"Download-Queue f\u00fcr Ausgabedateien aus der Historie.
Features:
enqueueHistoryJob)archiver)res.download()DOWNLOADS_UPDATED bei Status-\u00c4nderungencronService.js","text":"Integriertes Cron-System ohne externe Parser-Library.
Features:
nextRun-Berechnungscript oder chaincron_run_logs)CRON_JOBS_UPDATED, CRON_JOB_UPDATEDruntimeActivityService.js","text":"In-Memory-Tracking aller laufenden und k\u00fcrzlich abgeschlossenen Aktivit\u00e4ten (Skripte, Ketten, Cron-Jobs, Tasks).
Features:
startActivity(type, payload) \u2192 Aktivit\u00e4t registrieren, ID zur\u00fcckgebenupdateActivity(id, patch) \u2192 Laufende Aktivit\u00e4t aktualisierencompleteActivity(id, payload) \u2192 Aktivit\u00e4t abschlie\u00dfen und in recent verschiebensetControls(id, { cancel, nextStep }) \u2192 Steuer-Handler registrieren (f\u00fcr canCancel/canNextStep)requestCancel(id) / requestNextStep(id) \u2192 Steuer-Handler aufrufenclearRecent() \u2192 Abgeschlossene Aktivit\u00e4ten l\u00f6schengetSnapshot() \u2192 Snapshot mit active + recent + updatedAtRUNTIME_ACTIVITY_CHANGED \u00fcber WebSocket bei jeder \u00c4nderungLimits:
recent max. 120 Eintr\u00e4gestdout/stderr/output max. 12.000 Zeichenmessage/errorMessage max. 2.000 ZeichenVollst\u00e4ndige API-Dokumentation: Runtime Activities API
"},{"location":"architecture/backend/#weitere-services","title":"Weitere Services","text":"scriptService.js (CRUD + Test + Wrapper-Ausf\u00fchrung)scriptChainService.js (CRUD + Step-Execution)userPresetService.js (HandBrake User-Presets)hardwareMonitorService.js (CPU/RAM/GPU/Storage)websocketService.js (Client-Registry + Broadcast)notificationService.js (PushOver)cdRipService.js (CD-Ripping mit cdparanoia)musicBrainzService.js (MusicBrainz-Metadaten-Lookup)audnexService.js (Audnex-API f\u00fcr Audiobook-Metadaten)coverArtRecoveryService.js (Cover-Art-Wiederherstellung)thumbnailService.js (Vorschaubild-Generierung)omdbService.js (OMDb-Metadaten-Suche)logger.js (rotierende Datei-Logs)src/index.js)","text":"Beim Start:
/wsRipster verwendet SQLite (backend/data/ripster.db).
settings_schema\nsettings_values\njobs\njob_lineage_artifacts\njob_output_folders\npipeline_state\nscripts\nscript_chains\nscript_chain_steps\nuser_presets\ncron_jobs\ncron_run_logs\naax_activation_bytes\nuser_prefs\nconverter_scan_entries\njobs","text":"Speichert Pipeline-Lifecycle und Artefakte pro Job.
Zentrale Felder:
title, year, imdb_id, poster_url, omdb_json, selected_from_omdbstart_time, end_time, status, last_stateraw_path, output_path, encode_input_pathmakemkv_info_json, handbrake_info_json, mediainfo_info_json, encode_plan_jsonencode_review_confirmed, rip_successful, error_messagemedia_type (bluray|dvd|cd|audiobook|converter)job_kind, parent_job_idis_multipart_movie, disc_number, metadata_fingerprintaax_checksum (f\u00fcr AAX-Dateien)created_at, updated_atTypische job_kind-Werte:
bluray, dvd, cd, audiobook, converter_audio, converter_video, converter_isodvd_series_container, dvd_series_childmultipart_movie_container, multipart_movie_childWichtige Indizes:
idx_jobs_statusidx_jobs_parent_job_ididx_jobs_job_kindidx_jobs_disc_numberidx_jobs_metadata_fingerprintjob_lineage_artifacts","text":"Verkn\u00fcpft Jobs mit ihren Quell-Jobs (z. B. Re-Encode aus einem vorherigen Rip).
Felder:
job_id \u2014 der abgeleitete Jobsource_job_id \u2014 der Quell-Jobartifact_type \u2014 Art der Verkn\u00fcpfung (z. B. reencode, restart_review)created_atjob_output_folders","text":"Verfolgt Ausgabepfade pro Job (mehrere Ausgaben m\u00f6glich, z. B. bei Kapitel-Splitting).
Felder:
job_idfolder_pathlabel \u2014 optionaler Bezeichnercreated_atpipeline_state","text":"Singleton-Tabelle (id = 1) f\u00fcr aktiven Snapshot:
stateactive_job_idprogressetastatus_textcontext_jsonupdated_atsettings_schema + settings_values","text":"settings_schema: Definition (Typ, Default, Validation, Reihenfolge)settings_values: aktueller Wert pro Keyscripts, script_chains, script_chain_steps","text":"scripts: Shell-Skripte (name, script_body, order_index)script_chains: Ketten (name, order_index)script_chain_steps: Schritte je Kettestep_type: script oder waitscript_id oder wait_secondsuser_presets","text":"Benannte HandBrake-Preset-Sets:
namemedia_type (bluray|dvd|other|all)handbrake_presetextra_argsdescriptioncron_jobs + cron_run_logs","text":"cron_jobs: Zeitplan + Statuscron_run_logs: einzelne L\u00e4ufestatus: running|success|erroroutputerror_messageaax_activation_bytes","text":"Cache f\u00fcr Audible-Activation-Bytes (AAX-DRM).
Felder:
checksum \u2014 SHA-1-Pr\u00fcfsumme der AAX-Datei (Prim\u00e4rschl\u00fcssel)activation_bytes \u2014 Hex-String der Activation Bytescreated_atuser_prefs","text":"Benutzer-spezifische Einstellungen (Key-Value).
Felder:
keyvalueupdated_atconverter_scan_entries","text":"DB-seitige Erfassung gescannter Dateien im Converter-Eingangsordner.
Felder:
rel_path \u2014 relativer Pfad zum converter_raw_diris_dir \u2014 Verzeichnis-Flagsize \u2014 Dateigr\u00f6\u00dfe in Bytesmodified_at \u2014 Datei-\u00c4nderungsdatumjob_id \u2014 zugewiesener Converter-Job (falls vorhanden)scanned_atBeim Start werden Schema und Settings-Metadaten automatisch abgeglichen.
Bei korruptem SQLite-File:
backend/data/corrupt-backups/ verschobensqlite3 backend/data/ripster.db\n\n.mode table\nSELECT id, status, title, media_type, created_at FROM jobs ORDER BY created_at DESC;\nSELECT id, parent_job_id, job_kind, is_multipart_movie, disc_number FROM jobs ORDER BY created_at DESC;\nSELECT key, value FROM settings_values ORDER BY key;\nSELECT checksum, activation_bytes FROM aax_activation_bytes;\nSELECT rel_path, job_id FROM converter_scan_entries;\nFrontend: React + PrimeReact + Vite.
"},{"location":"architecture/frontend/#hauptseiten","title":"Hauptseiten","text":""},{"location":"architecture/frontend/#jobsinboxpagejsx","title":"JobsInboxPage.jsx","text":"Zentrale Job-Inbox:
Ripper/Converter)RipperPage.jsx","text":"Pipeline-Steuerung:
SettingsPage.jsx","text":"Konfiguration:
DynamicSettingsForm)CronJobsTab)HistoryPage.jsx","text":"Historie:
ConverterPage.jsx","text":"Datei-Converter:
AudiobooksPage.jsx","text":"Dedizierter AAX-/Audiobook-Flow:
DownloadsPage.jsx","text":"Download-Queue:
DatabasePage.jsx","text":"Expert-Modus:
PipelineStatusCard.jsx \u2014 Pipeline-Status-Anzeige mit ProgressMetadataSelectionDialog.jsx \u2014 OMDb-Metadaten-AuswahlMediaInfoReviewPanel.jsx \u2014 Track-Auswahl-Interface (Video/Audio/Untertitel)JobDetailDialog.jsx \u2014 Job-Detailansicht mit LogsCronJobsTab.jsx \u2014 Cron-Job-VerwaltungDynamicSettingsForm.jsx \u2014 Schema-gesteuertes EinstellungsformularConverterJobCard.jsx \u2014 Converter-Job-DarstellungCdRipConfigPanel.jsx \u2014 Konfiguration f\u00fcr Audio-CD-Rippingapi/client.js)","text":"request() mit JSON-HandlingError(message) gemapptVITE_API_BASE default /apihooks/useWebSocket.js)","text":"VITE_WS_URL oder automatisch ws(s)://<host>/wsIn App.jsx werden u. a. verarbeitet:
PIPELINE_STATE_CHANGEDPIPELINE_PROGRESSPIPELINE_QUEUE_CHANGEDHARDWARE_MONITOR_UPDATEDOWNLOADS_UPDATEDCONVERTER_SCAN_UPDATERUNTIME_ACTIVITY_CHANGED# dev\nnpm run dev --prefix frontend\n\n# prod build\nnpm run build --prefix frontend\npipelineService h\u00e4lt einen Snapshot der State-Machine und broadcastet \u00c4nderungen sofort via WebSocket.
State-\u00c4nderung -> PIPELINE_STATE_CHANGED/PIPELINE_PROGRESS -> Frontend-Update\nRoute -> Service -> DB/Tool-Execution\nRoutes enthalten kaum Business-Logik.
"},{"location":"architecture/overview/#schema-getriebene-settings","title":"Schema-getriebene Settings","text":"Settings sind DB-schema-getrieben (settings_schema + settings_values), UI rendert dynamisch aus diesen Daten.
WebSocket l\u00e4uft auf /ws.
Wichtige Events:
PIPELINE_STATE_CHANGED, PIPELINE_PROGRESS, PIPELINE_QUEUE_CHANGEDHARDWARE_MONITOR_UPDATESETTINGS_UPDATED, SETTINGS_BULK_UPDATEDSETTINGS_SCRIPTS_UPDATED, SETTINGS_SCRIPT_CHAINS_UPDATED, USER_PRESETS_UPDATEDCRON_JOBS_UPDATED, CRON_JOB_UPDATEDPIPELINE_ERROR, DISK_DETECTION_ERRORExterne Tools werden als Child-Processes gestartet (processRunner):
progressParsers.js)SQLite-Datei: backend/data/ripster.db
Kern-Tabellen:
jobs, pipeline_statesettings_schema, settings_valuesscripts, script_chains, script_chain_stepsuser_presetscron_jobs, cron_run_logsBeim Start werden Schema und Settings-Migrationen automatisch ausgef\u00fchrt.
"},{"location":"architecture/overview/#fehlerbehandlung","title":"Fehlerbehandlung","text":"Zentrales Error-Handling liefert:
{\n \"error\": {\n \"message\": \"...\",\n \"statusCode\": 400,\n \"reqId\": \"...\",\n \"details\": []\n }\n}\nFehlgeschlagene Jobs bleiben in der Historie (Fehler oder Abgebrochen) und k\u00f6nnen erneut gestartet werden.
CORS_ORIGIN default: *LOG_LEVEL default: infoDB_PATH/LOG_DIR konfigurierbarDieser Abschnitt ist die technische Referenz zu allen Konfigurationsarten in Ripster.
"},{"location":"configuration/#inhalte","title":"Inhalte","text":"Einstellungsreferenz
Vollst\u00e4ndige Liste aller UI-Settings (Typ, Default, Hinweise).
Einstellungsreferenz
Umgebungsvariablen
backend/.env und frontend/.env inkl. Priorit\u00e4ten.
Umgebungsvariablen
Umgebungsvariablen steuern Backend/Vite au\u00dferhalb der DB-basierten UI-Settings.
"},{"location":"configuration/environment/#backend-backendenv","title":"Backend (backend/.env)","text":"Variable Default (Code) Beschreibung PORT 3001 Express-Port DB_PATH backend/data/ripster.db SQLite-Datei (relativ zu backend/) LOG_DIR backend/logs Fallback-Logverzeichnis (wenn log_dir-Setting nicht gesetzt/lesbar) CORS_ORIGIN * CORS-Origin f\u00fcr API LOG_LEVEL info debug, info, warn, error Beispiel:
PORT=3001\nDB_PATH=/var/lib/ripster/ripster.db\nLOG_DIR=/var/log/ripster\nCORS_ORIGIN=http://192.168.1.50:5173\nLOG_LEVEL=info\nHinweis: backend/.env.example enth\u00e4lt bewusst dev-freundliche Werte (z. B. lokaler CORS_ORIGIN).
frontend/.env)","text":"Variable Default Beschreibung VITE_API_BASE /api API-Basis f\u00fcr Fetch-Client VITE_WS_URL automatisch aus window.location + /ws Optional explizite WebSocket-URL VITE_PUBLIC_ORIGIN leer \u00d6ffentliche Vite-Origin (Remote-Dev) VITE_ALLOWED_HOSTS true Komma-separierte Hostliste f\u00fcr Vite allowedHosts VITE_HMR_PROTOCOL abgeleitet aus VITE_PUBLIC_ORIGIN HMR-Protokoll (ws/wss) VITE_HMR_HOST abgeleitet aus VITE_PUBLIC_ORIGIN HMR-Host VITE_HMR_CLIENT_PORT abgeleitet aus VITE_PUBLIC_ORIGIN HMR-Client-Port Beispiele:
# lokal (mit Vite-Proxy)\nVITE_API_BASE=/api\n# remote dev\nVITE_API_BASE=http://192.168.1.50:3001/api\nVITE_WS_URL=ws://192.168.1.50:3001/ws\nVITE_PUBLIC_ORIGIN=http://192.168.1.50:5173\nVITE_ALLOWED_HOSTS=192.168.1.50,ripster.local\nVITE_HMR_PROTOCOL=ws\nVITE_HMR_HOST=192.168.1.50\nVITE_HMR_CLIENT_PORT=5173\n.envDiese Seite dokumentiert alle UI-Settings mit ihrer Wirkung auf Flows, Pfade, Queue und Automatisierung.
"},{"location":"configuration/settings-reference/#wie-ripster-settings-auflost","title":"Wie Ripster Settings aufl\u00f6st","text":"Ripster arbeitet intern mit profilspezifischen Settings (bluray, dvd, cd, audiobook) und bildet sie auf effektive Laufzeitwerte ab.
Wichtige Regeln:
bluray wird bei fehlenden profilierten Toolwerten auf dvd zur\u00fcckgefallen, und umgekehrt.cd und audiobook gibt es nur das eigene Profil.raw_dir, movie_dir, series_dir plus Owner) fallen bei leeren Werten auf Installationsdefaults zur\u00fcck.Installationsdefaults:
data/output/rawdata/output/moviesdata/output/seriesdata/output/cddata/output/audiobook-rawdata/output/audiobooksdata/output/converter-rawdata/output/converted-moviesdata/output/converted-audioDiese Settings bestimmen direkt:
Relevante Besonderheiten:
raw_dir_*_series.series_dir_* und Serien-Templates (Episode/Multi-Episode).movie_dir_* und Film-Template.Incomplete_job-<id> und finalisiert danach in den Zielpfad.Die vier Limits greifen kombiniert:
pipeline_max_parallel_jobs (Film/Video-Lane)pipeline_max_parallel_cd_encodes (Audio/CD-Lane)pipeline_max_total_encodes (globaler Deckel)pipeline_cd_bypasses_queue (Audio-Lane darf Filmwarteschlange umgehen)Effekt:
Skript, Kette, Warten) enthalten.Diese steuern die Serienqualit\u00e4t direkt:
Toolfelder (makemkv_*, mediainfo_*, handbrake_*, ffmpeg_*, ffprobe_*, cdparanoia_*) wirken unmittelbar auf die tats\u00e4chlich ausgef\u00fchrten CLI-Aufrufe.
Typische Auswirkungen:
${title}, ${year}, ${imdbId}{seriesTitle}, {seasonNr}, {episodeNr}, {episodeNoStart}, {episodeNoEnd}{episodeRange}, {episodeTitle}, {parts}, {discNr}, {year}, {language}{0:seasonNr} etc.{author}, {title}, {year}, {narrator}, {series}, {part}, {format}{title}, {year}{artist}, {title}, {album}, {year}, {trackNr}Expertenmodus ui_expert_mode boolean false Schaltet erweiterte Einstellungen in der UI ein. PushOver aktiviert pushover_enabled boolean false Master-Schalter f\u00fcr PushOver Versand. PushOver Token pushover_token string leer Application Token f\u00fcr PushOver. PushOver User pushover_user string leer User-Key f\u00fcr PushOver. PushOver Device (optional) pushover_device string leer Optionales Ziel-Device in PushOver. PushOver Titel-Pr\u00e4fix pushover_title_prefix string Ripster Prefix im PushOver Titel. PushOver Priority pushover_priority number 0 Priorit\u00e4t -2 bis 2. PushOver Timeout (ms) pushover_timeout_ms number 7000 HTTP Timeout f\u00fcr PushOver Requests. Bei Metadaten-Auswahl senden pushover_notify_metadata_ready boolean true Sendet wenn Metadaten zur Auswahl bereitstehen. Bei Rip-Start senden pushover_notify_rip_started boolean true Sendet beim Start des MakeMKV-Rips. Bei Encode-Start senden pushover_notify_encoding_started boolean true Sendet beim Start von HandBrake. Bei Erfolg senden pushover_notify_job_finished boolean true Sendet bei erfolgreich abgeschlossenem Job. Bei Fehler senden pushover_notify_job_error boolean true Sendet bei Fehlern in der Pipeline. Bei Abbruch senden pushover_notify_job_cancelled boolean true Sendet wenn Job manuell abgebrochen wurde. Bei Re-Encode Start senden pushover_notify_reencode_started boolean true Sendet beim Start von RAW Re-Encode. Bei Re-Encode Erfolg senden pushover_notify_reencode_finished boolean true Sendet bei erfolgreichem RAW Re-Encode."},{"location":"configuration/settings-reference/#kategorie-converter","title":"Kategorie: Converter","text":"GUI-Feld Key Typ Default Wirkung im System Erlaubte Datei-Endungen* converter_scan_extensions string mkv,mp4,m2ts,iso,avi,mov,flac,mp3,wav,m4a,ogg,opus Erlaubte Datei-Endungen f\u00fcr den Converter-Scan (ohne Punkt). Wird in der UI als Checkbox-Liste gepflegt. Auto-Scan (Polling) converter_polling_enabled boolean false Converter Raw-Ordner automatisch in regelm\u00e4\u00dfigen Abst\u00e4nden scannen. Polling-Intervall (Sekunden) converter_polling_interval number 300 Intervall f\u00fcr automatischen Scan des Converter-Ordners."},{"location":"configuration/settings-reference/#kategorie-laufwerk","title":"Kategorie: Laufwerk","text":"GUI-Feld Key Typ Default Wirkung im System Laufwerksmodus drive_mode select auto Auto-Discovery oder explizites Device. Device Pfad drive_device path /dev/sr0 Nur f\u00fcr expliziten Modus, z.B. /dev/sr0. MakeMKV Source Index makemkv_source_index number 0 Disc Index im Auto-Modus. Automatische Disk-Erkennung disc_auto_detection_enabled boolean true Wenn deaktiviert, findet keine automatische Laufwerkspr\u00fcfung statt. Neue Disks werden nur per \"Laufwerk neu lesen\" erkannt. Polling Intervall (ms) disc_poll_interval_ms number 4000 Intervall f\u00fcr Disk-Erkennung."},{"location":"configuration/settings-reference/#kategorie-metadaten","title":"Kategorie: Metadaten","text":"GUI-Feld Key Typ Default Wirkung im System OMDb API Key omdb_api_key string leer API Key f\u00fcr Metadatensuche. TMDb Read Access Token tmdb_api_read_access_token string leer Read Access Token f\u00fcr Serien-Metadaten \u00fcber TheMovieDB (TMDb). DVD Serien-Sprache dvd_series_language string de-DE Bevorzugte Sprache f\u00fcr Serien-Metadaten im TMDb-Format, z.B. de-DE oder en-US. DVD Serien-Fallback-Sprachen dvd_series_fallback_languages string de-DE,en-US Kommagetrennte TMDb-Sprachen f\u00fcr Fallback-Titel, z.B. de-DE,en-US,fr-FR. DVD Serien-Ordnung dvd_series_order_preference select episode_group Bevorzugte Episodenordnung f\u00fcr DVD-Serien. Episode Groups nutzen TMDb Alternate Orders, falls vorhanden. DVD Disc-Profile wiederverwenden dvd_series_reuse_disc_profiles boolean true Verwendet zuvor best\u00e4tigte Disc-Profile erneut, um Episoden automatischer zuzuordnen. OMDb Typ omdb_default_type select movie Vorauswahl f\u00fcr Suche. MusicBrainz aktiviert musicbrainz_enabled boolean true MusicBrainz-Metadatensuche f\u00fcr CDs aktivieren. Coverart-Nachladen aktiv coverart_recovery_enabled boolean true Wenn aktiv, werden fehlende Coverarts automatisch in Intervallen gepr\u00fcft und nachgeladen. Coverart-Pr\u00fcfintervall (Stunden) coverart_recovery_interval_hours number 6 Intervall f\u00fcr automatische Pr\u00fcfung fehlender Coverarts in Stunden."},{"location":"configuration/settings-reference/#kategorie-monitoring","title":"Kategorie: Monitoring","text":"GUI-Feld Key Typ Default Wirkung im System Hardware Monitoring aktiviert hardware_monitoring_enabled boolean true Master-Schalter: aktiviert/deaktiviert das komplette Hardware-Monitoring (Polling + Berechnung + WebSocket-Updates). Hardware Monitoring Intervall (ms) hardware_monitoring_interval_ms number 5000 Polling-Intervall f\u00fcr CPU/RAM/GPU/Storage-Metriken."},{"location":"configuration/settings-reference/#kategorie-pfade","title":"Kategorie: Pfade","text":"GUI-Feld Key Typ Default Wirkung im System Raw-Ordner (Blu-ray) raw_dir_bluray path leer RAW-Zielpfad f\u00fcr Blu-ray. Leer = Standardpfad (data/output/raw). Raw-Ordner (DVD) raw_dir_dvd path leer RAW-Zielpfad f\u00fcr DVD. Leer = Standardpfad (data/output/raw). CD RAW-Ordner raw_dir_cd path leer Basisordner f\u00fcr rohe CD-WAV-Dateien (cdparanoia-Output). Leer = Standardpfad (data/output/cd). Audiobook RAW-Ordner raw_dir_audiobook path leer Basisordner f\u00fcr hochgeladene AAX-Dateien. Leer = Standardpfad (data/output/audiobook-raw). Serien-Ordner (Blu-ray) series_dir_bluray path leer Zielordner f\u00fcr Blu-ray-Serienfolgen. Leer = Standardpfad (data/output/series). Film-Ordner (Blu-ray) movie_dir_bluray path leer Encode-Zielpfad f\u00fcr Blu-ray. Leer = Standardpfad (data/output/movies). Film-Ordner (DVD) movie_dir_dvd path leer Encode-Zielpfad f\u00fcr DVD. Leer = Standardpfad (data/output/movies). Serien-Ordner (DVD) series_dir_dvd path leer Zielordner f\u00fcr DVD-Serienfolgen. Leer = Standardpfad (data/output/series). CD Output-Ordner movie_dir_cd path leer Zielordner f\u00fcr encodierte CD-Ausgaben (FLAC, MP3 usw.). Leer = gleicher Ordner wie CD RAW-Ordner. Audiobook Output-Ordner movie_dir_audiobook path leer Zielordner f\u00fcr encodierte Audiobook-Dateien. Leer = Standardpfad (data/output/audiobooks). Externe Speicher external_storage_paths path [] Wird links unter \"Freie Speicher\" angezeigt. Log Ordner log_dir path data/logs Basisordner f\u00fcr Logs. Job-Logs liegen direkt hier, Backend-Logs in /backend. CD Output Template cd_output_template string {artist} - {album} ({year})/{trackNr} {artist} - {title} Template f\u00fcr relative CD-Ausgabepfade ohne Dateiendung. Platzhalter: {artist}, {album}, {year}, {title}, {trackNr}, {trackNo}. Unterordner sind \u00fcber \"/\" m\u00f6glich \u2013 alles nach dem letzten \"/\" ist der Dateiname. Die Endung wird \u00fcber das gew\u00e4hlte Ausgabeformat gesetzt. Output Template (Blu-ray) output_template_bluray string ${title} (${year})/${title} (${year}) Template f\u00fcr Ordner und Dateiname. Platzhalter: ${title}, ${year}, ${imdbId}. Unterordner \u00fcber \"/\" m\u00f6glich \u2013 alles nach dem letzten \"/\" ist der Dateiname. Die Endung wird \u00fcber das gew\u00e4hlte Ausgabeformat gesetzt. Output Template (Blu-ray Serie, Episode) output_template_bluray_series_episode string {seriesTitle}/Staffel {seasonNr}/S{seasonNr}E{episodeNr} - {episodeTitle} Template f\u00fcr einzelne Blu-ray-Serienepisoden ohne Dateiendung. Platzhalter: {seriesTitle}, {seasonNr}, {episodeNr}, {episodeTitle}, {discNr}, {year}, {language}. Optional mit f\u00fchrender Null: {0:seasonNr}, {0:episodeNr}. Output Template (Blu-ray Serie, Multi-Episode) output_template_bluray_series_multi_episode string {seriesTitle}/Staffel {seasonNr}/S{0:seasonNr}E{episodeRange} - {episodeTitle} (Teil {parts}) Template f\u00fcr zusammengefasste Blu-ray-Serienepisoden ohne Dateiendung. Platzhalter: {seriesTitle}, {seasonNr}, {episodeNoStart}, {episodeNoEnd}, {episodeRange}, {episodeTitle}, {parts}, {discNr}, {year}, {language}. Optional mit f\u00fchrender Null: {0:seasonNr}, {0:episodeNoStart}, {0:episodeNoEnd}. Output Template (DVD) output_template_dvd string ${title} (${year})/${title} (${year}) Template f\u00fcr Ordner und Dateiname. Platzhalter: ${title}, ${year}, ${imdbId}. Unterordner \u00fcber \"/\" m\u00f6glich \u2013 alles nach dem letzten \"/\" ist der Dateiname. Die Endung wird \u00fcber das gew\u00e4hlte Ausgabeformat gesetzt. Output Template (DVD Serie, Episode) output_template_dvd_series_episode string {seriesTitle}/Staffel {seasonNr}/S{seasonNr}E{episodeNr} - {episodeTitle} Template f\u00fcr einzelne DVD-Serienepisoden ohne Dateiendung. Platzhalter: {seriesTitle}, {seasonNr}, {episodeNr}, {episodeTitle}, {discNr}, {year}, {language}. Optional mit f\u00fchrender Null: {0:seasonNr}, {0:episodeNr}. Output Template (DVD Serie, Multi-Episode) output_template_dvd_series_multi_episode string {seriesTitle}/Staffel {seasonNr}/S{0:seasonNr}E{episodeRange} - {episodeTitle} (Teil {parts}) Template f\u00fcr zusammengefasste DVD-Serienepisoden ohne Dateiendung. Platzhalter: {seriesTitle}, {seasonNr}, {episodeNoStart}, {episodeNoEnd}, {episodeRange}, {episodeTitle}, {parts}, {discNr}, {year}, {language}. Optional mit f\u00fchrender Null: {0:seasonNr}, {0:episodeNoStart}, {0:episodeNoEnd}. Output Template (Audiobook) output_template_audiobook string {author}/{author} - {title} ({year}) Template f\u00fcr relative Audiobook-Ausgabepfade ohne Dateiendung. Platzhalter: {author}, {title}, {year}, {narrator}, {series}, {part}, {format}. Unterordner sind \u00fcber \"/\" m\u00f6glich. Audiobook RAW Template audiobook_raw_template string {author} - {title} ({year}) Template f\u00fcr relative Audiobook-RAW-Ordner. Platzhalter: {author}, {title}, {year}, {narrator}, {series}, {part}. Converter Raw-Ordner converter_raw_dir path leer Eingangsordner f\u00fcr den Converter (Import-Scan und Datei-Uploads). Jeder Upload erh\u00e4lt einen Unterordner. Leer = Standardpfad (data/output/converter-raw). Converter Ausgabe (Video) converter_movie_dir path leer Ausgabepfad f\u00fcr konvertierte Video-Dateien. Leer = Standardpfad (data/output/converted-movies). Converter Ausgabe (Audio) converter_audio_dir path leer Ausgabepfad f\u00fcr konvertierte Audio-Dateien. Leer = Standardpfad (data/output/converted-audio). Output-Template (Video) converter_output_template_video string {title} Dateiname-Template f\u00fcr konvertierte Video-Dateien (ohne Endung). Platzhalter: {title}, {year}. Output-Template (Audio) converter_output_template_audio string {artist} - {title} Dateiname-Template f\u00fcr konvertierte Audio-Dateien (ohne Endung). Platzhalter: {artist}, {title}, {album}, {year}, {trackNr}. RAW-Ordner (Blu-ray Serie) raw_dir_bluray_series path leer RAW-Zielpfad f\u00fcr Blu-ray-Serien. Leer = gleicher Pfad wie RAW-Ordner (Blu-ray). Eigent\u00fcmer RAW-Ordner (Blu-ray Serie) raw_dir_bluray_series_owner string leer Eigent\u00fcmer der Dateien im Format user:gruppe f\u00fcr Blu-ray-Serien-RAW. Leer = Eigent\u00fcmer Raw-Ordner (Blu-ray). Eigent\u00fcmer Raw-Ordner (Blu-ray) raw_dir_bluray_owner string leer Eigent\u00fcmer der Dateien im Format user:gruppe. Nur aktiv wenn ein Pfad gesetzt ist. Leer = Standardbenutzer des Dienstes. RAW-Ordner (DVD Serie) raw_dir_dvd_series path leer RAW-Zielpfad f\u00fcr DVD-Serien. Leer = gleicher Pfad wie RAW-Ordner (DVD). Eigent\u00fcmer RAW-Ordner (DVD Serie) raw_dir_dvd_series_owner string leer Eigent\u00fcmer der Dateien im Format user:gruppe f\u00fcr DVD-Serien-RAW. Leer = Eigent\u00fcmer Raw-Ordner (DVD). Eigent\u00fcmer Raw-Ordner (DVD) raw_dir_dvd_owner string leer Eigent\u00fcmer der Dateien im Format user:gruppe. Nur aktiv wenn ein Pfad gesetzt ist. Leer = Standardbenutzer des Dienstes. Eigent\u00fcmer CD RAW-Ordner raw_dir_cd_owner string leer Eigent\u00fcmer der Dateien im Format user:gruppe. Nur aktiv wenn ein Pfad gesetzt ist. Leer = Standardbenutzer des Dienstes. Eigent\u00fcmer Audiobook RAW-Ordner raw_dir_audiobook_owner string leer Eigent\u00fcmer der Audiobook-RAW-Dateien im Format user:gruppe. Nur aktiv wenn ein Pfad gesetzt ist. Leer = Standardbenutzer des Dienstes. Eigent\u00fcmer Serien-Ordner (Blu-ray) series_dir_bluray_owner string leer Eigent\u00fcmer der Blu-ray-Serienausgaben im Format user:gruppe. Leer = Standardbenutzer des Dienstes. Eigent\u00fcmer Film-Ordner (Blu-ray) movie_dir_bluray_owner string leer Eigent\u00fcmer der Dateien im Format user:gruppe. Nur aktiv wenn ein Pfad gesetzt ist. Leer = Standardbenutzer des Dienstes. Eigent\u00fcmer Film-Ordner (DVD) movie_dir_dvd_owner string leer Eigent\u00fcmer der Dateien im Format user:gruppe. Nur aktiv wenn ein Pfad gesetzt ist. Leer = Standardbenutzer des Dienstes. Eigent\u00fcmer Serien-Ordner (DVD) series_dir_dvd_owner string leer Eigent\u00fcmer der DVD-Serienausgaben im Format user:gruppe. Leer = Standardbenutzer des Dienstes. Eigent\u00fcmer CD Output-Ordner movie_dir_cd_owner string leer Eigent\u00fcmer der encodierten CD-Ausgaben im Format user:gruppe. Leer = Standardbenutzer des Dienstes. Eigent\u00fcmer Audiobook Output-Ordner movie_dir_audiobook_owner string leer Eigent\u00fcmer der encodierten Audiobook-Dateien im Format user:gruppe. Leer = Standardbenutzer des Dienstes."},{"location":"configuration/settings-reference/#kategorie-tools","title":"Kategorie: Tools","text":"GUI-Feld Key Typ Default Wirkung im System MakeMKV Kommando makemkv_command string makemkvcon Pfad oder Befehl f\u00fcr makemkvcon. MakeMKV Key makemkv_registration_key string leer Optionaler Registrierungsschl\u00fcssel. Wird vor Analyze/Rip automatisch per \"makemkvcon reg\" gesetzt. Mediainfo Kommando mediainfo_command string mediainfo Pfad oder Befehl f\u00fcr mediainfo. Minimale Titell\u00e4nge (Minuten) makemkv_min_length_minutes number 60 Filtert kurze Titel beim Rip. HandBrake Kommando handbrake_command string HandBrakeCLI Pfad oder Befehl f\u00fcr HandBrakeCLI. Encode-Neustart: unvollst\u00e4ndige Ausgabe l\u00f6schen handbrake_restart_delete_incomplete_output boolean true Wenn aktiv, wird bei \"Encode neu starten\" der bisherige (nicht erfolgreiche) Output vor Start entfernt. Max. parallele Film/Video Encodes pipeline_max_parallel_jobs number 1 Maximale Anzahl parallel laufender Film/Video Encode-Jobs. Gilt zus\u00e4tzlich zum Gesamtlimit. Max. parallele Audio CD Jobs pipeline_max_parallel_cd_encodes number 2 Maximale Anzahl parallel laufender Audio CD Jobs (Rip + Encode als Einheit). Gilt zus\u00e4tzlich zum Gesamtlimit. Max. Encodes gesamt (medienunabh\u00e4ngig) pipeline_max_total_encodes number 3 Gesamtlimit f\u00fcr alle parallel laufenden Encode-Jobs (Film + Audio CD). Dieses Limit hat Vorrang vor den Einzellimits. Audio CDs: Queue-Reihenfolge \u00fcberspringen pipeline_cd_bypasses_queue boolean false Wenn aktiv, k\u00f6nnen Audio CD Jobs unabh\u00e4ngig von Film-Jobs starten (\u00fcberspringen die Film-Queue-Reihenfolge). Einzellimits und Gesamtlimit gelten weiterhin. Script-Test Timeout (ms) script_test_timeout_ms number 0 Timeout fuer Script-Tests in den Settings. 0 = kein Timeout. cdparanoia Kommando cdparanoia_command string cdparanoia Pfad oder Befehl f\u00fcr cdparanoia. Wird als Fallback genutzt wenn kein individuelles Kommando gesetzt ist. FFmpeg Kommando ffmpeg_command string ffmpeg Pfad oder Befehl f\u00fcr ffmpeg. Wird f\u00fcr Audiobook-Encoding genutzt. FFprobe Kommando ffprobe_command string ffprobe Pfad oder Befehl f\u00fcr ffprobe. Wird f\u00fcr Audiobook-Metadaten und Kapitel genutzt. Mediainfo Extra Args mediainfo_extra_args_bluray string leer Zus\u00e4tzliche CLI-Parameter f\u00fcr mediainfo (Blu-ray). MakeMKV Rip Modus makemkv_rip_mode_bluray select backup backup: vollst\u00e4ndige Blu-ray Struktur im RAW-Ordner (empfohlen, erm\u00f6glicht --decrypt). MakeMKV Analyze Extra Args makemkv_analyze_extra_args_bluray string leer Zus\u00e4tzliche CLI-Parameter f\u00fcr Analyze (Blu-ray). MakeMKV Rip Extra Args makemkv_rip_extra_args_bluray string leer Zus\u00e4tzliche CLI-Parameter f\u00fcr Rip (Blu-ray). HandBrake Preset handbrake_preset_bluray string H.264 MKV 1080p30 Preset Name f\u00fcr -Z (Blu-ray). Leer = kein Preset, nur CLI-Parameter werden verwendet. HandBrake Extra Args handbrake_extra_args_bluray string leer Zus\u00e4tzliche CLI-Argumente (Blu-ray). Ausgabeformat output_extension_bluray select mkv Dateiendung f\u00fcr finale Datei (Blu-ray). Mediainfo Extra Args mediainfo_extra_args_dvd string leer Zus\u00e4tzliche CLI-Parameter f\u00fcr mediainfo (DVD). MakeMKV Rip Modus makemkv_rip_mode_dvd select backup backup: vollst\u00e4ndige Disc-Struktur im RAW-Ordner (einzig g\u00fcltige Option f\u00fcr DVDs). MakeMKV Analyze Extra Args makemkv_analyze_extra_args_dvd string leer Zus\u00e4tzliche CLI-Parameter f\u00fcr Analyze (DVD). MakeMKV Rip Extra Args makemkv_rip_extra_args_dvd string leer Zus\u00e4tzliche CLI-Parameter f\u00fcr Rip (DVD). HandBrake Preset handbrake_preset_dvd string H.264 MKV 480p30 Preset Name f\u00fcr -Z (DVD). Leer = kein Preset, nur CLI-Parameter werden verwendet. HandBrake Extra Args handbrake_extra_args_dvd string leer Zus\u00e4tzliche CLI-Argumente (DVD). Ausgabeformat output_extension_dvd select mkv Dateiendung f\u00fcr finale Datei (DVD)."},{"location":"deployment/","title":"Anhang: Deployment","text":"Technische Betriebsdokumentation f\u00fcr Entwicklung und Produktion.
Entwicklungsumgebung
Lokale Entwicklung mit Hot-Reload.
Entwicklung
Produktion
Installation und Betrieb auf Servern.
Produktion
makemkvcon, HandBrakeCLI, mediainfo)./start.sh\nStartet:
http://localhost:3001, mit nodemon)http://localhost:5173, mit Vite HMR)Stoppen: Ctrl+C.
cd backend\nnpm install\nnpm run dev\ncd frontend\nnpm install\nnpm run dev\nfrontend/vite.config.js proxied standardm\u00e4\u00dfig:
/api -> http://127.0.0.1:3001/ws -> ws://127.0.0.1:3001Beispiel frontend/.env.local:
VITE_API_BASE=http://192.168.1.100:3001/api\nVITE_WS_URL=ws://192.168.1.100:3001/ws\nVITE_PUBLIC_ORIGIN=http://192.168.1.100:5173\nVITE_ALLOWED_HOSTS=192.168.1.100,ripster.local\nVITE_HMR_PROTOCOL=ws\nVITE_HMR_HOST=192.168.1.100\nVITE_HMR_CLIENT_PORT=5173\n# Root dev (backend + frontend)\nnpm run dev\n\n# einzeln\nnpm run dev:backend\nnpm run dev:frontend\n\n# Frontend Build\nnpm run build:frontend\nDas mitgelieferte install.sh richtet Ripster vollautomatisch ein \u2013 inklusive Node.js, MakeMKV, HandBrake, nginx und systemd-Dienst.
Unterst\u00fctzte Systeme laut Script: Debian, Ubuntu, Linux Mint, Pop!_OS Voraussetzung: root-Rechte, Internetzugang
"},{"location":"deployment/production/#schnellstart-via-curl","title":"Schnellstart via curl","text":"curl -fsSL https://raw.githubusercontent.com/Mboehmlaender/ripster/main/install.sh | sudo bash\nOder mit wget:
wget -qO- https://raw.githubusercontent.com/Mboehmlaender/ripster/main/install.sh | sudo bash\nOptionen nur via Datei
Beim Pipen von curl/wget k\u00f6nnen keine Argumente \u00fcbergeben werden. F\u00fcr benutzerdefinierte Optionen zuerst herunterladen und dann mit sudo bash install.sh [Optionen] ausf\u00fchren.
--branch <branch> dev Git-Branch f\u00fcr die Installation --dir <pfad> /opt/ripster Installationsverzeichnis --user <benutzer> ripster Systembenutzer f\u00fcr den Dienst --port <port> 3001 Backend-Port --host <hostname> Auto (Maschinen-IP) Hostname/IP f\u00fcr die Weboberfl\u00e4che --no-makemkv \u2013 MakeMKV-Installation \u00fcberspringen --no-handbrake \u2013 HandBrake-Installation \u00fcberspringen --no-nginx \u2013 nginx-Einrichtung \u00fcberspringen --reinstall \u2013 Bestehende Installation aktualisieren (Daten bleiben erhalten) -h, --help \u2013 Hilfe anzeigen"},{"location":"deployment/production/#beispiele","title":"Beispiele","text":"# Standard-Installation\nsudo bash install.sh\n\n# Anderen Branch und Port verwenden\nsudo bash install.sh --branch dev --port 8080\n\n# Ohne MakeMKV (bereits installiert)\nsudo bash install.sh --no-makemkv\n\n# Bestehende Installation aktualisieren\nsudo bash install.sh --reinstall\n\n# Ohne nginx (eigener Reverse-Proxy)\nsudo bash install.sh --no-nginx --host mein-server.local\ncurl, wget, git, mediainfo, udev u. a.--no-makemkv \u00fcbersprungen werden)apt install handbrake-cli)bin/HandBrakeCLIripster \u2013 ohne Login-Shell und ohne Home-Verzeichnis; Gruppen werden (falls vorhanden) erg\u00e4nzt: cdrom, optical, disk, video, render--dir (bei --reinstall: sichert backend/data, aktualisiert Repo, stellt Daten wieder her)backend/data, backend/logs, backend/data/output/raw, backend/data/output/movies, backend/data/logsnpm run build mit relativen API-URLs (nginx-kompatibel).env \u2013 wird automatisch generiert (bei --reinstall bleibt bestehende .env erhalten)ripster:ripster auf Installationsverzeichnis; bei sudo-Aufruf werden Output-/Log-Ordner auf <aufrufender user>:ripster mit 775 gesetzt; .env wird auf 600 gesetzt~/.MakeMKV f\u00fcr den aufrufenden Benutzerripster-backend.service erstellt, aktiviert und gestartet/api/ und /ws (kann mit --no-nginx \u00fcbersprungen werden)# Status pr\u00fcfen\nsudo systemctl status ripster-backend\n\n# Logs verfolgen\nsudo journalctl -u ripster-backend -f\n\n# Neustart\nsudo systemctl restart ripster-backend\n\n# Aktualisieren\nsudo bash /opt/ripster/install.sh --reinstall\nZugriff: http://<Maschinen-IP> (oder der mit --host angegebene Hostname)
Bei nicht-interaktiver Ausf\u00fchrung (Pipe von curl) wird automatisch die Standard-Version gew\u00e4hlt. F\u00fcr die GPU-Version zuerst herunterladen:
curl -fsSL https://raw.githubusercontent.com/Mboehmlaender/ripster/main/install.sh -o install.sh\nsudo bash install.sh\n# \u2192 Interaktive Auswahl: Option 2 f\u00fcr NVDEC\nDas geb\u00fcndelte Binary liegt unter bin/HandBrakeCLI und wird nach /usr/local/bin/HandBrakeCLI kopiert.
Die folgenden Abschnitte beschreiben die einzelnen Schritte f\u00fcr manuelle oder angepasste Setups.
"},{"location":"deployment/production/#empfohlene-architektur","title":"Empfohlene Architektur","text":"Client\n -> nginx (Reverse Proxy + statisches Frontend)\n -> Backend API/WebSocket (Node.js, Port 3001)\nWichtig: Das Backend serviert im aktuellen Stand keine frontend/dist-Dateien automatisch.
cd frontend\nnpm install\nnpm run build\nArtefakte liegen in frontend/dist/.
Beispiel /etc/systemd/system/ripster-backend.service:
[Unit]\nDescription=Ripster Backend\nAfter=network.target\n\n[Service]\nType=simple\nUser=ripster\nWorkingDirectory=/opt/ripster/backend\nExecStart=/usr/bin/env node src/index.js\nRestart=on-failure\nRestartSec=5\nEnvironment=NODE_ENV=production\nEnvironment=PORT=3001\nEnvironment=LOG_LEVEL=info\n\n[Install]\nWantedBy=multi-user.target\nAktivieren:
sudo systemctl daemon-reload\nsudo systemctl enable --now ripster-backend\nsudo systemctl status ripster-backend\nBeispiel /etc/nginx/sites-available/ripster:
server {\n listen 80;\n server_name ripster.local;\n client_max_body_size 8G;\n\n root /opt/ripster/frontend/dist;\n index index.html;\n\n location / {\n try_files $uri $uri/ /index.html;\n }\n\n location /api/ {\n proxy_pass http://127.0.0.1:3001;\n proxy_set_header Host $host;\n proxy_set_header X-Real-IP $remote_addr;\n }\n\n location /ws {\n proxy_pass http://127.0.0.1:3001;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_set_header Host $host;\n }\n}\nAktivieren:
sudo ln -s /etc/nginx/sites-available/ripster /etc/nginx/sites-enabled/\nsudo nginx -t\nsudo systemctl reload nginx\nHinweis: Fuer groessere Uploads wie .aax-Audiobooks muss client_max_body_size ausreichend hoch gesetzt sein. Im mitgelieferten Beispiel sind 8G hinterlegt.
sqlite3 /opt/ripster/backend/data/ripster.db \\\n \".backup '/var/backups/ripster-$(date +%Y%m%d).db'\"\n.env, Settings-Felder).Dieses Kapitel ist f\u00fcr den Betrieb von Ripster im Alltag geschrieben.
"},{"location":"getting-started/#zielgruppe","title":"Zielgruppe","text":"Diese Seite ist die Betriebs-Checkliste vor dem ersten produktiven Lauf.
"},{"location":"getting-started/configuration/#ziel-der-ersteinrichtung","title":"Ziel der Ersteinrichtung","text":"Vor dem ersten Job m\u00fcssen drei Dinge stabil sein:
Settings -> Konfiguration","text":"Setze zuerst:
Raw-Ordner und Film-/Serien-OrdnerLog OrdnerMakeMKV Kommando, HandBrake Kommando, Mediainfo KommandoOMDb API KeyDann speichern.
"},{"location":"getting-started/configuration/#2-profile-pro-medium-festziehen","title":"2) Profile pro Medium festziehen","text":"Ripster l\u00f6st viele Werte profilspezifisch auf (bluray, dvd, cd, audiobook).
Pflichtpr\u00fcfung:
F\u00fcr Serien zus\u00e4tzlich:
RAW-Ordner (Blu-ray/DVD Serie)Serien-Ordner (Blu-ray/DVD)Stelle ein:
Max. parallele Film/Video EncodesMax. parallele Audio CD JobsMax. Encodes gesamtAudio CDs: Queue-Reihenfolge \u00fcberspringenDamit steuerst du Durchsatz, Priorit\u00e4t und Lastverteilung.
"},{"location":"getting-started/configuration/#4-metadatenquellen-absichern","title":"4) Metadatenquellen absichern","text":"Film:
Serien:
CD/Audiodaten:
MusicBrainz aktiviert nach BedarfPushOver Test ausf\u00fchrenRipper erkennen lassen.Analyse starten.Bereit zum Encodieren laufen.Historie pr\u00fcfen.Die empfohlene Installation l\u00e4uft \u00fcber install.sh und richtet Ripster vollst\u00e4ndig ein.
Du musst daf\u00fcr keine Tools manuell vorinstallieren. Das Skript installiert die ben\u00f6tigten Abh\u00e4ngigkeiten automatisch, sofern sie nicht explizit mit --no-* \u00fcbersprungen werden.
debian, ubuntu, linuxmint, poproot (oder via sudo)wget -qO install.sh https://raw.githubusercontent.com/Mboehmlaender/ripster/main/install.sh\nsudo bash install.sh\nW\u00e4hrend der Installation w\u00e4hlst du den HandBrake-Modus:
1 Standard (Paketinstallation)2 GPU/NVDEC (geb\u00fcndeltes Binary)sudo systemctl status ripster-backend\nhttp://<Server-IP>--no-nginx): API auf http://<Server-IP>:3001/apiinstall.sh konkret einrichtet","text":"curl, wget, git, mediainfo, udev ...)ripster an (ohne Login-Shell, ohne Home) und erg\u00e4nzt Gruppen (cdrom, optical, disk, video, render, falls vorhanden)/opt/ripster (oder aktualisiert bei --reinstall)/opt/ripster/backend/data/opt/ripster/backend/logs/opt/ripster/backend/data/output/raw/opt/ripster/backend/data/output/movies/opt/ripster/backend/data/logsbackend/.env (bei --reinstall bleibt bestehende .env erhalten)~/.MakeMKV f\u00fcr den aufrufenden Benutzerripster-backend.service--branch <branch> dev Branch f\u00fcr die Installation --dir <pfad> /opt/ripster Installationsverzeichnis --user <benutzer> ripster Service-Benutzer --port <port> 3001 Backend-Port --host <hostname> automatisch ermittelte Host-IP Hostname/IP f\u00fcr Webzugriff/CORS --no-makemkv aus MakeMKV-Installation \u00fcberspringen --no-handbrake aus HandBrake-Installation \u00fcberspringen --no-nginx aus nginx-Setup \u00fcberspringen --reinstall aus bestehende Installation aktualisieren Beispiele:
sudo bash install.sh --branch dev\nsudo bash install.sh --port 8080 --host ripster.local\nsudo bash install.sh --reinstall\n# Logs live ansehen\nsudo journalctl -u ripster-backend -f\n\n# Dienst neu starten\nsudo systemctl restart ripster-backend\n\n# Update aus bestehender Installation\nsudo bash /opt/ripster/install.sh --reinstall\n--no-*: Tool nachinstallieren oder Befehl in Settings korrigierenDie Voraussetzungen h\u00e4ngen davon ab, wie du Ripster betreibst.
"},{"location":"getting-started/prerequisites/#produktionsbetrieb-mit-installsh-standard","title":"Produktionsbetrieb mitinstall.sh (Standard)","text":"F\u00fcr den normalen Betrieb sind nur wenige Punkte vorab n\u00f6tig.
"},{"location":"getting-started/prerequisites/#pflicht","title":"Pflicht","text":"root-Rechteinstall.sh installiert die ben\u00f6tigten Tools selbst (u. a. Node.js, MakeMKV, HandBrakeCLI, MediaInfo), sofern sie nicht explizit per --no-* \u00fcbersprungen werden.
ls /dev/sr*\nlsblk | grep rom\nWenn n\u00f6tig Rechte setzen (Beispiel):
sudo chmod a+rw /dev/sr0\nSettings gesetzt werden)Wenn du lokal entwickelst (./start.sh, npm run dev), gelten zus\u00e4tzliche Voraussetzungen:
makemkvcon, HandBrakeCLI, mediainfo im PATHDetails: Entwicklungsumgebung
"},{"location":"getting-started/prerequisites/#abschluss-checkliste","title":"Abschluss-Checkliste","text":"Dieser Ablauf f\u00fchrt einen vollst\u00e4ndigen Disc-Job von Erkennung bis fertiger Datei durch.
"},{"location":"getting-started/quickstart/#1-disc-erkennen","title":"1) Disc erkennen","text":"Ripper \u00f6ffnen.Medium erkannt warten.Pr\u00fcfen:
Disk-Information zeigt Device/Label.Laufwerk neu lesen.Aktion:
Analyse startenErwartung:
AnalyseIm Dialog:
Auswahl \u00fcbernehmen.M\u00f6gliche Abzweigungen:
\u00dcbernahme erzwingen oder Multipart movieNormalfall:
Startbereit -> Rippen -> Mediainfo-PruefungM\u00f6gliche Alternativen:
Warte auf Auswahl f\u00fcr Playlist/TitelBei Bereit zum Encodieren:
Dann:
Encoding startenW\u00e4hrend Encodieren:
Nach Fertig:
Historie \u00f6ffnen.Kontrollpunkte:
Incomplete_)OMDb neu zuordnenReview neu startenRAW neu encodierenEncode neu startenDieses Kapitel ist das Bedienhandbuch f\u00fcr die Oberfl\u00e4chen im Alltag.
"},{"location":"gui/#seitenuberblick","title":"Seiten\u00fcberblick","text":"Seite Rolle im Betrieb Typischer Einsatz Jobs zentrale Inbox Gesamtlage pr\u00fcfen und in Fachseite springen Ripper Live-Steuerung der Pipeline Disc-Flow starten, Queue steuern, Review freigeben Audiobooks AAX-Spezialflow Upload, Konfiguration und Encode von Audiobooks Settings Konfiguration/Automatisierung Pfade, Tools, Queue-Limits, Skripte, Cron Historie Nachbearbeitung und Kontrolle Logs, Re-Encode, L\u00f6schvorschau, Recovery-Aktionen Converter dateibasierte Konvertierung Video/Audio/ISO ohne Disc-Rip verarbeiten Downloads ZIP-Exports RAW/Output aus Historie bereitstellen Database (Expert) Recovery-Sicht orphan RAW finden und importieren"},{"location":"gui/#empfohlener-tagesablauf","title":"Empfohlener Tagesablauf","text":"Jobs: Statuslage und Auff\u00e4lligkeiten pr\u00fcfen.Ripper oder Converter/Audiobooks: neue Arbeit starten.Historie: Ergebnisse validieren und ggf. nachbearbeiten.Downloads: Exporte f\u00fcr externe \u00dcbergabe erzeugen.Settings: Regeln und Limits nur kontrolliert anpassen.Direkt in der Top-Navigation:
Jobs, Ripper, Converter, Audiobooks, Settings, Historie, DownloadsNur per URL:
Database unter /databaseDie Seite Audiobooks ist der spezialisierte AAX-Workflow.
Die Oberfl\u00e4che ist in drei Bereiche gegliedert:
Audiobooks UploadAudiobook JobsAudiobook Output ExplorerDer Upload verarbeitet ausschlie\u00dflich AAX-Dateien.
Direkt nach Upload passieren im Hintergrund:
Audiobook RAW TemplateWichtige Parameter:
m4b, mp3, flac)Toolabh\u00e4ngigkeit:
ffprobe_command f\u00fcr Metadaten/Kapitelffmpeg_command f\u00fcr Encode/Cover-ExtraktionJobkarten zeigen Zustand, Fortschritt und verf\u00fcgbare Aktionen.
Typische Aktionen:
StartenAbbrechenRetryL\u00f6schenIm Ripper (Kontextwechsel)Die Karten werden regelm\u00e4\u00dfig aktualisiert und durch WebSocket-Ereignisse erg\u00e4nzt.
"},{"location":"gui/audiobooks/#3-audiobook-output-explorer","title":"3) Audiobook Output Explorer","text":"Read-only Explorer des Audiobook-Outputpfads:
raw_dir_audiobook + audiobook_raw_template Finale Ausgabe movie_dir_audiobook + output_template_audiobook Dateiformat Jobkonfiguration (m4b, mp3, flac)"},{"location":"gui/audiobooks/#typische-probleme","title":"Typische Probleme","text":"ffmpeg/ffprobe nicht aufrufbar.Die Seite Converter verarbeitet bereits vorhandene Dateien (Video, Audio, ISO) ohne Laufwerks-Rip.
Der Converter arbeitet auf dem Eingangspfad converter_raw_dir:
Wichtig:
Der Explorer zeigt den kompletten Baum unter converter_raw_dir.
Aktionen:
Aktion WirkungUpload Dateien werden in den Raw-Baum geschrieben Ordner erstellen legt Unterordner im Raw-Baum an Umbenennen benennt Datei/Ordner im Raw-Baum um Verschieben verschiebt innerhalb des Raw-Baums L\u00f6schen entfernt Datei/Ordner dauerhaft Scannen synchronisiert Explorer und DB-Zuordnungen Upload-Regeln:
Erlaubte Datei-Endungen* enthalten seinEs gibt zwei Audio-Strategien:
Ein Job pro DateiGemeinsamer Job (Audio)Verhalten:
Shared-Audio-Job:
inputPathsVor Start je Job einstellbar:
converterMediaType (video, audio, iso)outputFormatSpezifika:
converter_movie_dirOutput-Template (Video)converter_audio_dirOutput-Template (Audio)Converter-Jobs laufen \u00fcber dieselbe Pipeline-/Queue-Logik:
Parallelit\u00e4t richtet sich nach den globalen Encode-Limits in Settings.
Mit aktiviertem Polling:
converter_raw_dir wird zyklisch gescanntRelevante Settings:
Auto-Scan (Polling)Polling-Intervall (Sekunden)Converter: beliebige Audio/Video/ISO-DateienAudiobooks: dedizierter AAX-Workflow mit Kapitel-/Audiobook-Metadaten/database ist die Recovery- und Expertensicht f\u00fcr F\u00e4lle, in denen Dateisystem und Historie nicht mehr sauber zusammenpassen.
/databaseGefundene RAW-Eintr\u00e4ge","text":"Dieser Bereich listet RAW-Verzeichnisse ohne zugeordneten Historie-Job.
Aktionen:
RAW pr\u00fcfen: scannt konfigurierte RAW-WurzelnJob anlegen: erstellt aus einem orphan RAW einen neuen Historie-JobJob anlegen passiert","text":"Typischer Einsatz:
Auf Downloads werden ZIP-Archive f\u00fcr Historie-Artefakte erstellt und bereitgestellt.
Ein Download-Eintrag referenziert immer einen Historie-Job und genau ein Ziel:
RAWOutputErzeugt wird ein ZIP-Archiv im Download-Verzeichnis des Backends.
"},{"location":"gui/downloads/#statusmodell","title":"Statusmodell","text":"Status Bedeutungqueued Eintrag erstellt, wartet auf Verarbeitung processing ZIP wird gerade gebaut ready Archiv fertig, Download-Link aktiv failed Erzeugung oder Zugriff fehlgeschlagen"},{"location":"gui/downloads/#eintrag-anlegen","title":"Eintrag anlegen","text":"Startpunkt ist die Historie:
RAW oder Output) w\u00e4hlen.Downloads verfolgen.queued/processing-Eintr\u00e4ge gepr\u00fcft und fortgesetzt.ready, wird der Eintrag auf failed gesetzt.Bei Status ready:
/api/downloads/:id/file.L\u00f6schen entfernt:
Nicht erlaubt:
queued/processingDie Seite reagiert auf DOWNLOADS_UPDATED per WebSocket. Dadurch sind Statuswechsel ohne Reload sichtbar.
Historie ist die Kontroll- und Nachbearbeitungsoberfl\u00e4che f\u00fcr alle bereits angelegten Jobs.
Filter und Arbeitsmittel:
Jeder Eintrag zeigt auf einen Blick:
Der Detaildialog b\u00fcndelt:
Tail oder vollst\u00e4ndig)Bei Seriencontainern wird disk-/child-orientiert dargestellt, nicht nur als Einzeljob.
"},{"location":"gui/history/#nachbearbeitungsaktionen-und-wirkung","title":"Nachbearbeitungsaktionen und Wirkung","text":"Aktion Typischer Einsatz Technische WirkungOMDb neu zuordnen falsches Match, Titel/Jahr korrigieren Metadatenfelder werden neu geschrieben; Folder-Rename wird best effort angesto\u00dfen Review neu starten neue Track-/Titelbewertung n\u00f6tig Mediainfo/Review wird aus RAW neu aufgebaut RAW neu encodieren neuer Encode aus vorhandenem RAW startet Encode ohne neuen Laufwerks-Rip Encode neu starten gleiche best\u00e4tigte Auswahl erneut fahren letzter best\u00e4tigter Plan wird geladen, optional mit Bereinigung unvollst\u00e4ndiger Ausgabe Retry Rippen Rip/Analyse neu ansto\u00dfen neuer Rip-Lauf, inkl. erneuter RAW-Phase L\u00f6schaktionen im Dialog:
RAW l\u00f6schenMovie l\u00f6schenBeides l\u00f6schenHistorieneintrag l\u00f6schenVor endg\u00fcltigem L\u00f6schen zeigt Ripster eine Vorschau mit:
RAW-KandidatenMovie-/Episoden-KandidatenWichtige Punkte:
Im Ripper \u00f6ffnen hilft bei Bereit zum Encodieren-Kindern.Tail laden (800) f\u00fcr schnellen FehlerkontextVollst\u00e4ndiges Log laden f\u00fcr forensische AnalyseEmpfehlung:
Jobs ist die zentrale Inbox \u00fcber alle Jobarten und dient als schneller Einstieg in den Tagesbetrieb.
Die Liste vereinheitlicht:
Dadurch kannst du unabh\u00e4ngig von der Fachseite zuerst den Gesamtzustand pr\u00fcfen.
"},{"location":"gui/jobs/#filterlogik","title":"Filterlogik","text":""},{"location":"gui/jobs/#view-filter","title":"View-Filter","text":"Alle JobsRipper-ViewConverter-ViewAudiobooksAlleAktivFehler/AbbruchZus\u00e4tzlich:
Die Ansicht wird periodisch aktualisiert und erg\u00e4nzt sich mit WebSocket-Events.
"},{"location":"gui/jobs/#schnellaktion-pro-zeile","title":"Schnellaktion pro Zeile","text":"Im Ripper \u00f6ffnen f\u00fcr Disc-/Audiobook-nahe JobsIm Converter \u00f6ffnen f\u00fcr Converter-JobsSo kommst du ohne Umwege in die Oberfl\u00e4che mit den passenden Detailaktionen.
"},{"location":"gui/jobs/#empfohlener-einsatz","title":"Empfohlener Einsatz","text":"Jobs St\u00f6rungen und Auslastung identifizieren.Ripper, Converter oder Historie springen.Die Seite Ripper ist die Live-Steuerung der Pipeline. Hier laufen Disc-Erkennung, Queue-Steuerung, Review und Encode-Start zusammen.
Die Bereiche erscheinen in dieser Reihenfolge:
Hardware MonitoringJob QueueSkript- / Cron-StatusJob \u00dcbersichtDisk-InformationZeigt kontinuierlich:
Nutzen im Betrieb:
Gesteuert \u00fcber Settings:
Hardware Monitoring aktiviertHardware Monitoring Intervall (ms)Es gibt zwei operative Zonen:
Laufende JobsWarteschlangeM\u00f6gliche Queue-Eintr\u00e4ge:
Start, Retry Rippen, RAW neu encodieren, Encode neu starten, Review neu berechnen, Audio CD starten)Skript, Skriptkette, Warten)Wichtige Regeln:
Warten blockiert nachfolgende Queue-Starts bis kein aktiver Prozess mehr l\u00e4uft.Skript und Skriptkette werden als Queue-Eintr\u00e4ge mitgef\u00fchrt.Parallelit\u00e4t kommt aus Settings:
Max. parallele Film/Video EncodesMax. parallele Audio CD JobsMax. Encodes gesamtAudio CDs: Queue-Reihenfolge \u00fcberspringenZeigt Runtime-Aktivit\u00e4ten:
Aktionen:
N\u00e4chster Schritt bei KettenAbbrechenListe leerenDie Jobliste ist der zentrale Arbeitsbereich. Ein Klick \u00f6ffnet den jeweiligen Pipeline-Status.
Neben Status/Fortschritt zeigt die Liste je nach Job:
Serien-Container, Staffel/Disk)Multipart Movie, Disc-Nr.)Medium erkannt, Bereit Analyse starten startet MakeMKV-Analyse Metadatenauswahl Metadaten \u00f6ffnen Film/Serie ausw\u00e4hlen, Provider festlegen Warte auf Auswahl Playlist/Titel/RAW-Entscheidung best\u00e4tigen setzt Flow fort zur Pr\u00fcfung Startbereit Job starten startet Rip oder RAW-basierte Pr\u00fcfung Bereit zum Encodieren Encoding starten startet HandBrake mit best\u00e4tigter Auswahl Laufend (Analyse, Rippen, Encodieren) Abbrechen setzt Job auf Abgebrochen Fehler, Abgebrochen Retry Rippen neuer Rip-Anlauf Zusatzaktionen je nach Zustand und Jobtyp:
Review neu startenEncode neu startenRAW neu encodierenAus Queue l\u00f6schenBereit zum Encodieren)","text":"Hier wird die effektive Encode-Entscheidung festgelegt:
Ohne Best\u00e4tigung dieses Blocks startet kein produktiver Encode.
"},{"location":"gui/ripper/#raw-ordnerphasen-sichtbar-uber-logsdetails","title":"RAW-Ordnerphasen (sichtbar \u00fcber Logs/Details)","text":"Der Ripper arbeitet mit drei RAW-Zust\u00e4nden:
Incomplete_... w\u00e4hrend unvollst\u00e4ndigem RipRip_Complete_... nach erfolgreich abgeschlossenem Rip, vor EncodeDas ist wichtig f\u00fcr Recovery und Delete-Vorschau.
"},{"location":"gui/ripper/#5-disk-information","title":"5) Disk-Information","text":"Zeigt aktuelle Laufwerksdaten:
Aktionen:
Laufwerk neu lesenDisk neu analysierenHinweis:
Laufwerk neu lesen ist nicht mehr an einen festen Pipeline-State gebunden.Im Dialog werden Film-/Serienmetadaten best\u00e4tigt.
Sonderf\u00e4lle:
\u00dcbernahme erzwingen oder Multipart movieDisc-Nummer ist PflichtWenn passendes RAW existiert, fordert der Dialog eine explizite Entscheidung:
Du kannst gezielt ab Position einf\u00fcgen:
Die Seite Settings steuert alle Betriebsparameter von Ripster: Pfade, Tools, Queue-Limits, Metadatenquellen, Automatisierung.
Konfiguration globale und profilspezifische Laufzeitsettings Scripte einzelne Skripte verwalten und testen Skriptketten mehrstufige Abl\u00e4ufe aus Skript/Warten Encode-Presets wiederverwendbare HandBrake-Profile f\u00fcr Review Cronjobs zeitgesteuerte Ausf\u00fchrung von Skript/Kette"},{"location":"gui/settings/#tab-konfiguration","title":"Tab Konfiguration","text":""},{"location":"gui/settings/#bedienprinzip","title":"Bedienprinzip","text":"\u00c4nderungen speichern.Zus\u00e4tzliche Bedienhilfen:
Neu laden verwirft lokale Formzust\u00e4nde\u00c4nderungen verwerfen setzt auf zuletzt gespeicherten StandPushOver Test validiert Benachrichtigungszugang sofortPfade wo RAW, finale Ausgaben, Converter/Audiobook-Dateien landen Tools ob Analyze/Rip/Encode ausf\u00fchrbar sind Metadaten Film-/Serienzuordnung und Episode-Mapping Queue-Limits Durchsatz und Reihenfolgeverhalten Monitoring Sichtbarkeit von Last und Speicherengp\u00e4ssen Benachrichtigungen PushOver-Ereignisse je Pipelinephase"},{"location":"gui/settings/#tab-scripte","title":"Tab Scripte","text":"Funktionen:
Test)Testausf\u00fchrung liefert:
Wichtig:
Skriptketten","text":"Ketten bestehen aus Schritten:
SkriptWartenTypischer Einsatz:
In der Queue erscheinen Ketten als eigene Eintr\u00e4ge und werden dort ausgef\u00fchrt.
"},{"location":"gui/settings/#tab-encode-presets","title":"TabEncode-Presets","text":"Ein Preset b\u00fcndelt:
-Z)Im Ripper-Review kannst du Presets pro Job ausw\u00e4hlen, statt Parameter jedes Mal neu zu setzen.
"},{"location":"gui/settings/#tab-cronjobs","title":"TabCronjobs","text":"Funktionen:
Skript oder Skriptkette)Jetzt ausf\u00fchrenEmpfehlung:
Die vollst\u00e4ndige Wirkung jeder einzelnen Einstellung steht in Einstellungsreferenz.
"},{"location":"pipeline/","title":"Anhang: Pipeline intern","text":"Dieser Abschnitt beschreibt die technische Pipeline-Logik hinter den UI-Workflows.
Workflow & Zust\u00e4nde
Zustandsmodell, \u00dcberg\u00e4nge, Queue-Verhalten.
Workflow
Encode-Planung
Aufbereitung von Titeln/Tracks und Best\u00e4tigungslogik.
Encoding
Playlist-Analyse
Bewertung mehrdeutiger Blu-ray-Playlists.
Playlist-Analyse
Pre-/Post-Encode-Ausf\u00fchrungen
Skript- und Kettenlauf vor/nach dem Encoding.
Encode-Skripte
Vor dem eigentlichen Encoding erstellt Ripster einen Encode-Plan und zeigt ihn im Review an.
"},{"location":"pipeline/encoding/#ablauf","title":"Ablauf","text":"Quelle bestimmen (Disc/RAW)\n -> HandBrake-Scan (--scan --json)\n -> Plan erstellen (Titel, Audio, Untertitel)\n -> Status: Bereit zum Encodieren\n -> Benutzer bestaetigt Auswahl\n -> finaler HandBrake-Aufruf\nBereit zum Encodieren)","text":"burnInforceddefaultTrackconfirm-encode)","text":"Typischer Payload:
{\n \"selectedEncodeTitleId\": 1,\n \"selectedTrackSelection\": {\n \"1\": {\n \"audioTrackIds\": [1, 2],\n \"subtitleTrackIds\": [3]\n }\n },\n \"selectedPreEncodeScriptIds\": [1],\n \"selectedPostEncodeScriptIds\": [2],\n \"selectedPreEncodeChainIds\": [3],\n \"selectedPostEncodeChainIds\": [4],\n \"selectedUserPresetId\": 5\n}\nDie best\u00e4tigte Auswahl wird im Job gespeichert und f\u00fcr Neustarts wiederverwendet.
"},{"location":"pipeline/encoding/#handbrake-aufruf","title":"HandBrake-Aufruf","text":"Grundstruktur:
HandBrakeCLI \\\n -i <input> \\\n -o <output> \\\n -t <titleId> \\\n -Z \"<preset>\" \\\n <extra-args> \\\n -a <audioTrackIds|none> \\\n -s <subtitleTrackIds|none>\nUntertitel-Flags werden bei Bedarf erg\u00e4nzt:
--subtitle-burned=<id>--subtitle-default=<id>--subtitle-forced=<id> oder --subtitle-forcedFehlerverhalten:
Fehler (Encode startet nicht)Fertig bleiben, enth\u00e4lt aber Fehlerhinweis/Script-SummaryDer finale Outputpfad wird aus den Templates in den Settings aufgebaut.
Platzhalter:
${title}${year}${imdbId}Ung\u00fcltige Dateizeichen werden bereinigt.
"},{"location":"pipeline/playlist-analysis/","title":"Playlist-Analyse","text":"Ripster analysiert bei Blu-ray-\u00e4hnlichen Quellen Playlists und fordert bei Mehrdeutigkeit eine manuelle Auswahl an.
"},{"location":"pipeline/playlist-analysis/#ziel","title":"Ziel","text":"Erkennen, welche Playlist sehr wahrscheinlich der Hauptfilm ist, statt versehentlich eine Fake-/Dummy-Playlist zu verwenden.
"},{"location":"pipeline/playlist-analysis/#eingabedaten","title":"Eingabedaten","text":"Die Analyse basiert auf MakeMKV-Infos (u. a. Playlist-/Segment-Struktur, Laufzeiten, Titelzuordnung).
"},{"location":"pipeline/playlist-analysis/#auswertung-vereinfacht","title":"Auswertung (vereinfacht)","text":"F\u00fcr Kandidaten werden u. a. ber\u00fccksichtigt:
Daraus entstehen intern Kandidatenlisten, Bewertungen und eine Empfehlung.
"},{"location":"pipeline/playlist-analysis/#wann-muss-der-benutzer-entscheiden","title":"Wann muss der Benutzer entscheiden?","text":"Wenn nach Filterung mehr als ein relevanter Kandidat \u00fcbrig bleibt, wechselt der Job in der GUI auf:
Warte auf AuswahlDann muss eine Playlist best\u00e4tigt werden, bevor der Workflow weiterl\u00e4uft.
"},{"location":"pipeline/playlist-analysis/#konfigurationseinfluss","title":"Konfigurationseinfluss","text":"Feld inSettings Wirkung Minimale Titellaenge (Minuten) Mindestlaufzeit f\u00fcr Kandidaten Default ist aktuell 60 Minuten.
Bei manueller Entscheidung zeigt das Ripper Kandidaten inkl. Score/Bewertung und markiert eine Empfehlung.
Nach Best\u00e4tigung:
Mediainfo-PruefungStartbereit / RippenRipster kann Skripte und Skript-Ketten vor und nach dem Encode ausf\u00fchren.
"},{"location":"pipeline/post-encode-scripts/#ablauf","title":"Ablauf","text":"Bereit zum Encodieren\n -> Pre-Encode Skripte/Ketten\n -> HandBrake Encoding\n -> Post-Encode Skripte/Ketten\n -> Fertig oder Fehler\nIm Review-Panel kannst du getrennt w\u00e4hlen:
selectedPreEncodeScriptIdsselectedPostEncodeScriptIdsselectedPreEncodeChainIdsselectedPostEncodeChainIdsFehler.Fertig sein (mit Fehlerzusatz im Status/Log).Beim Script-Run werden gesetzt:
RIPSTER_SCRIPT_RUN_ATRIPSTER_JOB_IDRIPSTER_JOB_TITLERIPSTER_MODERIPSTER_INPUT_PATHRIPSTER_OUTPUT_PATHRIPSTER_RAW_PATHRIPSTER_SCRIPT_IDRIPSTER_SCRIPT_NAMERIPSTER_SCRIPT_SOURCEKetten unterst\u00fctzen zwei Step-Typen:
script (f\u00fchrt ein hinterlegtes Skript aus)wait (wartet waitSeconds)Bei Fehler in einem Script-Step wird die Kette abgebrochen.
"},{"location":"pipeline/post-encode-scripts/#testlaufe","title":"Testl\u00e4ufe","text":"POST /api/settings/scripts/:id/testPOST /api/settings/script-chains/:id/testErgebnisse enthalten Erfolg/Exit-Code, Laufzeit und stdout/stderr.
"},{"location":"pipeline/workflow/","title":"Workflow & Zust\u00e4nde","text":"Ripster steuert den Ablauf als Zustandsmaschine.
"},{"location":"pipeline/workflow/#zustandsdiagramm-vereinfacht","title":"Zustandsdiagramm (vereinfacht)","text":"flowchart LR\n A[Bereit] --> B[Medium erkannt]\n B --> C[Analyse]\n C --> D[Metadatenauswahl]\n D --> E[Startbereit]\n E --> F[Rippen]\n E --> G[Mediainfo-Pruefung]\n G --> H[Warte auf Auswahl]\n H --> G\n G --> I[Bereit zum Encodieren]\n I --> J[Encodieren]\n J --> K[Fertig]\n J --> L[Fehler]\n F --> L\n F --> M[Abgebrochen]Bereit Wartet auf Disc Medium erkannt Disc wurde erkannt Analyse MakeMKV-Analyse l\u00e4uft Metadatenauswahl Metadaten m\u00fcssen best\u00e4tigt werden Warte auf Auswahl Playlist-Auswahl ist erforderlich Warte auf Auswahl auch f\u00fcr RAW-Entscheidung bei vorhandenen Quelldaten genutzt Startbereit kurzer \u00dcbergang vor Start Rippen MakeMKV-Rip l\u00e4uft Mediainfo-Pruefung Titel/Spuren werden ausgewertet Bereit zum Encodieren Review ist bereit Encodieren HandBrake l\u00e4uft CD-Metadatenauswahl CD-Metadaten m\u00fcssen best\u00e4tigt werden CD-Startbereit CD-Job wartet auf Start CD-Analyse CD-Track-/Strukturaufbereitung CD-Rippen Audio-CD-Rip l\u00e4uft CD-Encodieren CD-Encode l\u00e4uft Fertig erfolgreich abgeschlossen Abgebrochen manuell oder technisch abgebrochen Fehler fehlgeschlagen"},{"location":"pipeline/workflow/#typische-pfade","title":"Typische Pfade","text":""},{"location":"pipeline/workflow/#standardfall-kein-vorhandenes-raw","title":"Standardfall (kein vorhandenes RAW)","text":"Startbereit springt direkt zu Mediainfo-Pruefung (kein neuer Rip).
Mediainfo-Pruefung -> Warte auf Auswahl bis Playlist best\u00e4tigt wurde.
Metadatenauswahl -> Warte auf Auswahl bis Entscheidung f\u00fcr Weiterverarbeitung (continue) oder Neustart getroffen wurde.
CD-Metadatenauswahl -> CD-Startbereit -> CD-Rippen -> CD-Encodieren -> Fertig
Wenn der Wert Parallele Jobs erreicht ist:
Skript, Kette, Warten)Abbrechen: laufenden Job stoppen oder Queue-Eintrag entfernenRetry Rippen: Fehler-/Abbruch-Job erneut startenRAW neu encodieren: aus vorhandenem RAW neu encodierenReview neu starten: Review aus RAW neu aufbauenEncode neu starten: Encoding mit letzter best\u00e4tigter Auswahl neu startenRipster orchestriert externe CLI-Tools. Dieser Abschnitt erkl\u00e4rt deren Rolle im Gesamtsystem.
MakeMKV
Disc-Analyse und Ripping.
MakeMKV
HandBrake
Video-Encoding inklusive Preset-Logik.
HandBrake
MediaInfo
Track-/Containeranalyse f\u00fcr Review und Auswahl.
MediaInfo
Ripster verwendet HandBrakeCLI f\u00fcr Scan und Encode.
HandBrakeCLI --scan --json -i <input> -t 0\nHandBrakeCLI \\\n -i <input> \\\n -o <output> \\\n -t <titleId> \\\n -Z \"<preset>\" \\\n <extra-args> \\\n -a <audioTrackIds|none> \\\n -s <subtitleTrackIds|none>\nOptional erg\u00e4nzt Ripster:
--subtitle-burned=<id>--subtitle-default=<id>--subtitle-forced=<id> oder --subtitle-forcedRipster liest Presets mit:
HandBrakeCLI -z\nSettings","text":"Feldname in der GUI Bedeutung HandBrake Kommando CLI-Binary HandBrake Preset (Blu-ray/DVD) profilspezifisches Preset HandBrake Extra Args (Blu-ray/DVD) profilspezifische Zusatzargumente Ausgabeformat (Blu-ray/DVD) Dateiendung der finalen Datei Encode-Neustart: unvollst\u00e4ndige Ausgabe l\u00f6schen unvollst\u00e4ndige Ausgabe bei Neustart l\u00f6schen"},{"location":"tools/handbrake/#fortschritts-parsing","title":"Fortschritts-Parsing","text":"Ripster parst HandBrake-Stderr (Prozent/ETA/Detail) und sendet WebSocket-Progress (PIPELINE_PROGRESS).
HandBrakeCLI -z pr\u00fcfen--encoder-preset)Das Produktions-Installer-Script install.sh bietet eine Option zur Installation eines geb\u00fcndelten HandBrakeCLI-Binaries mit NVDEC-Unterst\u00fctzung (NVIDIA GPU-Dekodierung). Diese Option erscheint interaktiv w\u00e4hrend der Installation.
Ripster nutzt makemkvcon f\u00fcr Disc-Analyse und Rip.
makemkvcon -r info <source>\n<source> ist typischerweise:
disc:<index> (Auto-Modus)dev:/dev/sr0 (explicit)file:<path> (Datei/Ordner-Analyse)makemkvcon mkv <source> <title-or-all> <rawDir> [--minlength=...] [...extraArgs]\nmakemkvcon backup <source> <rawDir> --decrypt\nWenn in Settings ein MakeMKV Key gesetzt ist, f\u00fchrt Ripster vor Analyse/Rip aus:
makemkvcon reg <key>\nSettings","text":"Feldname in der GUI Bedeutung MakeMKV Kommando CLI-Binary MakeMKV Source Index Source-Index im Auto-Modus Minimale Titellaenge (Minuten) Mindestlaufzeitfilter MakeMKV Rip Modus (Blu-ray/DVD) mkv oder backup MakeMKV Analyze Extra Args (Blu-ray/DVD) Zusatzargumente f\u00fcr Analyse MakeMKV Rip Extra Args (Blu-ray/DVD) Zusatzargumente f\u00fcr Rip"},{"location":"tools/makemkv/#hinweise","title":"Hinweise","text":"makemkvInfo im Job gespeichert.Ripster nutzt mediainfo zur JSON-Analyse von Medien-Dateien.
mediainfo --Output=JSON <input>\nDer Input ist typischerweise eine RAW-Datei oder ein vom Workflow gew\u00e4hlter Inputpfad.
"},{"location":"tools/mediainfo/#verwendung-in-ripster","title":"Verwendung in Ripster","text":"mediainfoInfo im Jobmediainfo_command CLI-Binary mediainfo_extra_args_bluray / _dvd profilspezifische Zusatzargumente"},{"location":"tools/mediainfo/#troubleshooting","title":"Troubleshooting","text":"mediainfo --Output=JSON <datei>und (undetermined)Diese Seite beschreibt die produktiven Abl\u00e4ufe als Handbuch: welche Entscheidung an welcher Stelle f\u00e4llt, welche Objekte dabei entstehen (Job, Container, Child-Job) und welche Dateien in welchen Ordnern landen.
"},{"location":"workflows/#gemeinsame-grundlagen","title":"Gemeinsame Grundlagen","text":""},{"location":"workflows/#statuskette-im-normalfall","title":"Statuskette im Normalfall","text":"Medium erkannt -> Analyse -> Metadatenauswahl -> Startbereit -> Rippen -> Mediainfo-Pruefung -> Bereit zum Encodieren -> Encodieren -> Fertig
Abweichungen:
Mediainfo-Pruefung -> Warte auf Auswahl -> zur\u00fcck in Mediainfo-PruefungStartbereit springt direkt in Review/Pr\u00fcfung ohne neuen Laufwerks-RipFehler oder Abgebrochen mit Wiederanlauf-Aktionendvd_series_container logischer Serien-Container (pro Serie/Staffel) Metadatenanker, aggregierter Status \u00fcber Kinder dvd_series_child einzelne Serien-Disc oder Serien-Episode-Job eigentliche RAW-/Encode-Arbeit multipart_movie_container logischer Multipart-Film-Container Zusammenfassung f\u00fcr mehrere Film-Discs multipart_movie_child einzelne Disc innerhalb Multipart-Film Disc-spezifische RAW-/Encode-Daten Wichtig:
Ripper Analyse starten.Auswahl \u00fcbernehmen.Wirkung:
Wenn Film mit gleichem Fingerprint bereits existiert, gibt es zwei Wege:
\u00dcbernahme erzwingen (allow_new): neuer unabh\u00e4ngiger Film-JobMultipart movie: neuer Job wird mit bestehendem Job in einem Multipart-Container verkn\u00fcpftBei Multipart gilt:
Disc-NummerMULTIPART_DISC_ALREADY_EXISTS)Ordnername basiert auf Metadaten plus Job-ID:
Incomplete_<Titel> (<Jahr>) - RAW - job-<id>Zustandswechsel des RAW-Ordners:
Incomplete_...Rip_Complete_...In Bereit zum Encodieren:
Beim Start:
Incomplete_job-<id>/<Datei>.<ext>Disc-Nummer setzen (Pflicht, ab 1).Wirkung:
seriesdvd_series_child darunter gef\u00fchrtBeim Speichern wird gepr\u00fcft:
Disc-Nummer?Wenn ja, wird blockiert (SERIES_DISC_ALREADY_EXISTS).
F\u00fcr Serien wird ein eigener RAW-Pfad bevorzugt:
raw_dir_bluray_series (Fallback: raw_dir_bluray)raw_dir_dvd_series (Fallback: raw_dir_dvd)RAW-Namensbasis enth\u00e4lt Staffel/Disc (SxDy) und wird ebenfalls mit den Prefix-Phasen gef\u00fchrt:
Incomplete_... -> Rip_Complete_... -> finalBeim Review werden Episoden-/Titelzuordnungen genutzt. Je nach Auswahl:
Ausgabepfad:
series_dir_* (Fallback auf movie_dir_*)Wenn mehrere Episoden-Titel aus einer Disc encodiert werden:
Multipart movie.Wirkung:
multipart_movie_container wird angelegt oder wiederverwendetmultipart_movie_childNach Metadaten-\u00dcbernahme erkennt Ripster passende RAW-Ordner und setzt den Job auf Entscheidungsstatus.
M\u00f6glichkeiten:
/database","text":"Database RAW pr\u00fcfen.Job anlegen.In Historie (Detaildialog):
OMDb neu zuordnen Metadaten neu schreiben, Folder-Rename wird best effort angesto\u00dfen Review neu starten Titel-/Spurpr\u00fcfung aus aktuellem RAW neu aufbauen RAW neu encodieren Encode erneut aus vorhandenem RAW starten Encode neu starten letzte best\u00e4tigte Review-Einstellungen wiederverwenden Retry Rippen Rip/Analyse neu starten; alter Job-RAW kann bereinigt werden"},{"location":"workflows/#wo-landet-was-artefakt-matrix","title":"Wo landet was? (Artefakt-Matrix)","text":"Artefakt Film Serie Multipart RAW raw_dir_* bevorzugt raw_dir_*_series pro Child-Job im normalen Film-RAW-Schema Finale Ausgabe movie_dir_* + Film-Template series_dir_* (Fallback movie_dir_*) + Serien-Templates pro Child-Job normaler Film-Output Container-Datensatz nein ja (dvd_series_container) ja (multipart_movie_container) L\u00f6schvorschau in Historie einzelner Job oder Related Scope Container-/Child-bezogen mit Pfadauswahl Container-/Child-bezogen mit Pfadauswahl"},{"location":"workflows/#queue-verhalten-im-alltag","title":"Queue-Verhalten im Alltag","text":"Die Startfreigabe h\u00e4ngt an vier Settings:
Max. parallele Film/Video EncodesMax. parallele Audio CD JobsMax. Encodes gesamtAudio CDs: Queue-Reihenfolge \u00fcberspringenPraxis:
Skript, Kette, Warten enthalten