0.14.0-4 Docs

site/search/search_index.json

@@ -1 +1 @@
-{"config":{"lang":["de"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Ripster Handbuch","text":"<p>Dieses Dokumentationsset ist als Benutzerhandbuch aufgebaut: erst Bedienung und Alltag, dann Technik im Anhang.</p>"},{"location":"#schnellstart-in-3-schritten","title":"Schnellstart in 3 Schritten","text":"<ol> <li>Voraussetzungen pr\u00fcfen und installieren: Installation</li> <li>Grundkonfiguration in der UI setzen: Ersteinrichtung</li> <li>Ersten vollst\u00e4ndigen Job durchlaufen: Erster Lauf</li> </ol>"},{"location":"#was-du-hier-findest","title":"Was du hier findest","text":"<ul> <li>Benutzerhandbuch</li> <li>Installation</li> <li>GUI-Seiten im Detail (<code>Jobs</code>, <code>Ripper</code>, <code>Converter</code>, <code>Audiobooks</code>, <code>Settings</code>, <code>Historie</code>, <code>Downloads</code>, <code>Database</code>)</li> <li>typische Arbeitsabl\u00e4ufe aus Anwendersicht</li> <li>Technischer Anhang</li> <li>vollst\u00e4ndige Einstellungsreferenz</li> <li>Pipeline-/API-/Architekturdetails</li> <li>Deployment und Tool-Hintergr\u00fcnde</li> </ul>"},{"location":"#empfohlene-lesereihenfolge","title":"Empfohlene Lesereihenfolge","text":"<ol> <li>Benutzerhandbuch \u00dcberblick</li> <li>GUI-Seiten</li> <li>Workflows aus Nutzersicht</li> <li>Bei Bedarf: Technischer Anhang</li> </ol>"},{"location":"api/","title":"Anhang: API-Referenz","text":"<p>REST- und WebSocket-Schnittstellen f\u00fcr Integration, Automatisierung und Debugging.</p>"},{"location":"api/#basis-url","title":"Basis-URL","text":"<pre><code>http://localhost:3001\n</code></pre> <p>API-Prefix: <code>/api</code></p>"},{"location":"api/#api-gruppen","title":"API-Gruppen","text":"<ul> <li> <p> Health</p> <p>Service-Liveness.</p> <p><code>GET /api/health</code></p> </li> <li> <p> Pipeline API</p> <p>Analyse, Start/Retry/Cancel, Queue, Re-Encode.</p> <p> Pipeline API</p> </li> <li> <p> Settings API</p> <p>Einstellungen, Skripte/Ketten, User-Presets.</p> <p> Settings API</p> </li> <li> <p> History API</p> <p>Job-Historie, Orphan-Import, L\u00f6schoperationen.</p> <p> History API</p> </li> <li> <p> Cron API</p> <p>Zeitgesteuerte Skript-/Kettenausf\u00fchrung.</p> <p> Cron API</p> </li> <li> <p> Converter API</p> <p>Datei-Explorer, Upload, Job-Verwaltung f\u00fcr den Converter.</p> <p> Converter API</p> </li> <li> <p> Downloads API</p> <p>Download-Queue f\u00fcr Ausgabedateien aus der Job-Historie.</p> <p> Downloads API</p> </li> <li> <p> Runtime Activities API</p> <p>Laufende und abgeschlossene Aktivit\u00e4ten (Skripte, Ketten, Cron, Tasks).</p> <p> Runtime Activities</p> </li> <li> <p>:material-websocket: WebSocket Events</p> <p>Pipeline-, Queue-, Disk-, Settings-, Cron-, Converter- und Download-Events.</p> <p> WebSocket</p> </li> </ul>"},{"location":"api/#hinweis","title":"Hinweis","text":"<p>Ripster hat keine eingebaute Authentifizierung und ist f\u00fcr lokalen, gesch\u00fctzten Betrieb gedacht.</p>"},{"location":"api/converter/","title":"Converter API","text":"<p>Endpunkte f\u00fcr den Datei-Converter: Datei-Explorer, Upload, Job-Verwaltung.</p> <p>Basis-Pfad: <code>/api/converter</code></p>"},{"location":"api/converter/#scan-explorer","title":"Scan &amp; Explorer","text":""},{"location":"api/converter/#get-apiconvertertree","title":"<code>GET /api/converter/tree</code>","text":"<p>Vollst\u00e4ndiger Verzeichnisbaum des <code>converter_raw_dir</code> (FS-basiert, keine DB).</p> <p>Response:</p> <pre><code>{\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}\n</code></pre>"},{"location":"api/converter/#get-apiconverterbrowseparentrelpath","title":"<code>GET /api/converter/browse?parent=relPath</code>","text":"<p>DB-basierter Datei-Explorer. Gibt Eintr\u00e4ge f\u00fcr einen Unterordner zur\u00fcck.</p> <p>Query-Parameter:</p> Parameter Typ Beschreibung <code>parent</code> string Relativer Pfad zum Unterordner (leer = Root) <p>Response:</p> <pre><code>{\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}\n</code></pre>"},{"location":"api/converter/#post-apiconverterscan","title":"<code>POST /api/converter/scan</code>","text":"<p>Manuellen Scan des <code>converter_raw_dir</code> ausl\u00f6sen. Aktualisiert <code>converter_scan_entries</code> in der DB.</p> <p>Response:</p> <pre><code>{ \"result\": { \"added\": 3, \"removed\": 1 } }\n</code></pre>"},{"location":"api/converter/#jobs-erstellen","title":"Jobs erstellen","text":""},{"location":"api/converter/#post-apiconverterjobsfrom-selection"Line truncated
+{"config":{"lang":["de"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Ripster Handbuch","text":"<p>Diese Dokumentation ist als vollst\u00e4ndiges Benutzerhandbuch aufgebaut: t\u00e4gliche Bedienung zuerst, technische Referenz danach.</p>"},{"location":"#einstieg-in-3-schritten","title":"Einstieg in 3 Schritten","text":"<ol> <li>Installation: Installation</li> <li>Betriebskonfiguration: Ersteinrichtung</li> <li>erster End-to-End-Lauf: Erster Lauf</li> </ol>"},{"location":"#was-das-handbuch-abdeckt","title":"Was das Handbuch abdeckt","text":"<ul> <li>alle GUI-Seiten mit Aktionen und Wirkung</li> <li>vollst\u00e4ndige Workflows f\u00fcr Film, Serie und Multipart</li> <li>Queue-, Job-, Container- und Recovery-Verhalten</li> <li>detaillierte Settings-Wirkung inklusive Fallbacks</li> </ul>"},{"location":"#empfohlene-lesereihenfolge","title":"Empfohlene Lesereihenfolge","text":"<ol> <li>Benutzerhandbuch \u00dcberblick</li> <li>GUI-Seiten</li> <li>Workflows aus Nutzersicht</li> <li>Einstellungsreferenz</li> <li>bei Bedarf technischer Tiefgang im Anhang</li> </ol>"},{"location":"api/","title":"Anhang: API-Referenz","text":"<p>REST- und WebSocket-Schnittstellen f\u00fcr Integration, Automatisierung und Debugging.</p>"},{"location":"api/#basis-url","title":"Basis-URL","text":"<pre><code>http://localhost:3001\n</code></pre> <p>API-Prefix: <code>/api</code></p>"},{"location":"api/#api-gruppen","title":"API-Gruppen","text":"<ul> <li> <p> Health</p> <p>Service-Liveness.</p> <p><code>GET /api/health</code></p> </li> <li> <p> Pipeline API</p> <p>Analyse, Start/Retry/Cancel, Queue, Re-Encode.</p> <p> Pipeline API</p> </li> <li> <p> Settings API</p> <p>Einstellungen, Skripte/Ketten, User-Presets.</p> <p> Settings API</p> </li> <li> <p> History API</p> <p>Job-Historie, Orphan-Import, L\u00f6schoperationen.</p> <p> History API</p> </li> <li> <p> Cron API</p> <p>Zeitgesteuerte Skript-/Kettenausf\u00fchrung.</p> <p> Cron API</p> </li> <li> <p> Converter API</p> <p>Datei-Explorer, Upload, Job-Verwaltung f\u00fcr den Converter.</p> <p> Converter API</p> </li> <li> <p> Downloads API</p> <p>Download-Queue f\u00fcr Ausgabedateien aus der Job-Historie.</p> <p> Downloads API</p> </li> <li> <p> Runtime Activities API</p> <p>Laufende und abgeschlossene Aktivit\u00e4ten (Skripte, Ketten, Cron, Tasks).</p> <p> Runtime Activities</p> </li> <li> <p>:material-websocket: WebSocket Events</p> <p>Pipeline-, Queue-, Disk-, Settings-, Cron-, Converter- und Download-Events.</p> <p> WebSocket</p> </li> </ul>"},{"location":"api/#hinweis","title":"Hinweis","text":"<p>Ripster hat keine eingebaute Authentifizierung und ist f\u00fcr lokalen, gesch\u00fctzten Betrieb gedacht.</p>"},{"location":"api/converter/","title":"Converter API","text":"<p>Endpunkte f\u00fcr den Datei-Converter: Datei-Explorer, Upload, Job-Verwaltung.</p> <p>Basis-Pfad: <code>/api/converter</code></p>"},{"location":"api/converter/#scan-explorer","title":"Scan &amp; Explorer","text":""},{"location":"api/converter/#get-apiconvertertree","title":"<code>GET /api/converter/tree</code>","text":"<p>Vollst\u00e4ndiger Verzeichnisbaum des <code>converter_raw_dir</code> (FS-basiert, keine DB).</p> <p>Response:</p> <pre><code>{\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}\n</code></pre>"},{"location":"api/converter/#get-apiconverterbrowseparentrelpath","title":"<code>GET /api/converter/browse?parent=relPath</code>","text":"<p>DB-basierter Datei-Explorer. Gibt Eintr\u00e4ge f\u00fcr einen Unterordner zur\u00fcck.</p> <p>Query-Parameter:</p> Parameter Typ Beschreibung <code>parent</code> string Relativer Pfad zum Unterordner (leer = Root) <p>Response:</p> <pre><code>{\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}\n</code></pre>"},{"location":"api/converter/#post-apiconverterscan","title":"<code>POST /api/converter/scan</code>","text":"<p>Manuellen Scan des <code>converter_raw_dir</code> ausl\u00f6sen. Aktualisiert <code>converter_scan_entries</code> in der DB.</p> <p>Response:</p> <pre><code>{ \"result\": { \"added\": 3, \"removed\": 1 } }\n</code></pre>"},{"location":"api/converter/#jobs-erstellen","title":"Jobs erstellen","text":""},{"location":"api/converter/#post-apiconverterjobsfrom-selection","title":"<code>POST /api/converter/jobs/from-selection</code>","text":"<p>Jobs aus im Datei-Explorer ausgew\u00e4hlten Dateien erstellen.</p> <p>Body:</p> <pre><code>{\n  \"relPaths\": [\"filme/film.mkv\", \"musik/track.flac\"],\n  \"audioModeLine truncated