1.0.0-rc1 Docs
This commit is contained in:
michael committed
1 parent
9b437fe5e5
commit
9b38d78042
61 files changed
+452
-419
No files matched your search
@@ -1,4 +1,4 @@
|
||||
<!doctype html><html lang=de class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Benutzerhandbuch für den Betrieb von Ripster mit technischem Anhang"><meta name=author content=Michael><link href=https://mboehmlaender.github.io/ripster/getting-started/installation/ rel=canonical><link href=../prerequisites/ rel=prev><link href=../configuration/ rel=next><link rel=icon href=../../assets/images/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.7.0"><title>Installation - Ripster</title><link rel=stylesheet href=../../assets/stylesheets/main.618322db.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.ab4e12ef.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../stylesheets/extra.css><script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=deep-purple data-md-color-accent=purple> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#installation class=md-skip> Zum Inhalt </a> </div> <div data-md-component=announce> </div> <div data-md-color-scheme=default data-md-component=outdated hidden> </div> <header class="md-header md-header--shadow md-header--lifted" data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Kopfzeile> <a href=../.. title=Ripster class="md-header__button md-logo" aria-label=Ripster data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 14a2 2 0 0 1-2-2c0-1.11.89-2 2-2s2 .89 2 2a2 2 0 0 1-2 2m0-10a8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8 8 8 0 0 0-8-8"/></svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> Ripster </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Installation </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media data-md-color-scheme=default data-md-color-primary=deep-purple data-md-color-accent=purple aria-label="Dunkelmodus aktivieren" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Dunkelmodus aktivieren" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> <input class=md-option data-md-color-media data-md-color-scheme=slate data-md-color-primary=deep-purple data-md-color-accent=purple aria-label="Hellmodus aktivieren" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Hellmodus aktivieren" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 Line truncated
|
||||
<!doctype html><html lang=de class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Benutzerhandbuch für den Betrieb von Ripster mit technischem Anhang"><meta name=author content=Michael><link href=https://mboehmlaender.github.io/ripster/getting-started/installation/ rel=canonical><link href=../prerequisites/ rel=prev><link href=../configuration/ rel=next><link rel=icon href=../../assets/images/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.7.0"><title>Installation - Ripster</title><link rel=stylesheet href=../../assets/stylesheets/main.618322db.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.ab4e12ef.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../stylesheets/extra.css><script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=deep-purple data-md-color-accent=purple> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#installation class=md-skip> Zum Inhalt </a> </div> <div data-md-component=announce> </div> <div data-md-color-scheme=default data-md-component=outdated hidden> </div> <header class="md-header md-header--shadow md-header--lifted" data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Kopfzeile> <a href=../.. title=Ripster class="md-header__button md-logo" aria-label=Ripster data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 14a2 2 0 0 1-2-2c0-1.11.89-2 2-2s2 .89 2 2a2 2 0 0 1-2 2m0-10a8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8 8 8 0 0 0-8-8"/></svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> Ripster </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Installation </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media data-md-color-scheme=default data-md-color-primary=deep-purple data-md-color-accent=purple aria-label="Dunkelmodus aktivieren" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Dunkelmodus aktivieren" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> <input class=md-option data-md-color-media data-md-color-scheme=slate data-md-color-primary=deep-purple data-md-color-accent=purple aria-label="Hellmodus aktivieren" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Hellmodus aktivieren" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 Line truncated
|
||||
</span></code></pre></div> <h3 id=2-installation-ausfuhren>2. Installation ausführen<a class=headerlink href=#2-installation-ausfuhren title="Permanent link">¶</a></h3> <div class="language-bash highlight"><pre><span></span><code><span id=__span-1-1><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a>sudo<span class=w> </span>bash<span class=w> </span>install.sh
|
||||
</span></code></pre></div> <p>Während der Installation wählst du den HandBrake-Modus:</p> <ul> <li><code>1</code> Standard (Paketinstallation)</li> <li><code>2</code> GPU/NVDEC (gebündeltes Binary)</li> </ul> <h3 id=3-dienststatus-prufen>3. Dienststatus prüfen<a class=headerlink href=#3-dienststatus-prufen title="Permanent link">¶</a></h3> <div class="language-bash highlight"><pre><span></span><code><span id=__span-2-1><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a>sudo<span class=w> </span>systemctl<span class=w> </span>status<span class=w> </span>ripster-backend
|
||||
</span></code></pre></div> <h3 id=4-weboberflache-offnen>4. Weboberfläche öffnen<a class=headerlink href=#4-weboberflache-offnen title="Permanent link">¶</a></h3> <ul> <li>mit nginx (Standard): <code>http://<Server-IP></code></li> <li>ohne nginx (<code>--no-nginx</code>): API auf <code>http://<Server-IP>:3001/api</code></li> </ul> <h2 id=was-installsh-konkret-einrichtet>Was <code>install.sh</code> konkret einrichtet<a class=headerlink href=#was-installsh-konkret-einrichtet title="Permanent link">¶</a></h2> <ol> <li>prüft Betriebssystem, Root-Rechte und ermittelt Host/IP</li> <li>aktualisiert Paketquellen und installiert Basispakete (<code>curl</code>, <code>wget</code>, <code>git</code>, <code>mediainfo</code>, <code>udev</code> ...)</li> <li>installiert Node.js 20 (falls nicht passend vorhanden)</li> <li>installiert optional MakeMKV (Build aus den offiziellen Quellen)</li> <li>installiert optional HandBrakeCLI (Standard oder GPU/NVDEC)</li> <li>installiert optional nginx</li> <li>legt den Systembenutzer <code>ripster</code> an (ohne Login-Shell, ohne Home) und ergänzt Gruppen (<code>cdrom</code>, <code>optical</code>, <code>disk</code>, <code>video</code>, <code>render</code>, falls vorhanden)</li> <li>klont das Repository nach <code>/opt/ripster</code> (oder aktualisiert bei <code>--reinstall</code>)</li> <li>legt Verzeichnisse an:</li> <li><code>/opt/ripster/backend/data</code></li> <li><code>/opt/ripster/backend/logs</code></li> <li><code>/opt/ripster/backend/data/output/raw</code></li> <li><code>/opt/ripster/backend/data/output/movies</code></li> <li><code>/opt/ripster/backend/data/logs</code></li> <li>installiert npm-Abhängigkeiten (Root, Backend, Frontend) und baut das Frontend</li> <li>erzeugt <code>backend/.env</code> (bei <code>--reinstall</code> bleibt bestehende <code>.env</code> erhalten)</li> <li>setzt Rechte/Besitz und erstellt bei sudo-Installation zusätzlich <code>~/.MakeMKV</code> für den aufrufenden Benutzer</li> <li>erzeugt und startet <code>ripster-backend.service</code></li> <li>konfiguriert und startet nginx (falls nicht übersprungen)</li> </ol> <h2 id=wichtige-optionen>Wichtige Optionen<a class=headerlink href=#wichtige-optionen title="Permanent link">¶</a></h2> <table> <thead> <tr> <th>Option</th> <th>Default laut Script</th> <th>Zweck</th> </tr> </thead> <tbody> <tr> <td><code>--branch <branch></code></td> <td><code>dev</code></td> <td>Branch für die Installation</td> </tr> <tr> <td><code>--dir <pfad></code></td> <td><code>/opt/ripster</code></td> <td>Installationsverzeichnis</td> </tr> <tr> <td><code>--user <benutzer></code></td> <td><code>ripster</code></td> <td>Service-Benutzer</td> </tr> <tr> <td><code>--port <port></code></td> <td><code>3001</code></td> <td>Backend-Port</td> </tr> <tr> <td><code>--host <hostname></code></td> <td>automatisch ermittelte Host-IP</td> <td>Hostname/IP für Webzugriff/CORS</td> </tr> <tr> <td><code>--no-makemkv</code></td> <td>aus</td> <td>MakeMKV-Installation überspringen</td> </tr> <tr> <td><code>--no-handbrake</code></td> <td>aus</td> <td>HandBrake-Installation überspringen</td> </tr> <tr> <td><code>--no-nginx</code></td> <td>aus</td> <td>nginx-Setup überspringen</td> </tr> <tr> <td><code>--reinstall</code></td> <td>aus</td> <td>bestehende Installation aktualisieren</td> </tr> </tbody> </table> <p>Beispiele:</p> <div class="language-bash highlight"><pre><span></span><code><span id=__span-3-1><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a>sudo<span class=w> </span>bash<span class=w> </span>install.sh<span class=w> </span>--branch<span class=w> </span>dev
|
||||
|
||||
Reference in new issue
Block a user