Files
docs/tutorials/media-manager/site/steps/install-docker/index.html
aetos 52c756e052
Some checks reported errors
continuous-integration/drone/push Build was killed
tutorials/media-manager (#1)
Reviewed-on: #1
2025-11-20 17:37:18 +00:00

948 lines
24 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../setup-mount-points/">
<link rel="next" href="../install-plex/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
<title>Install Docker - Media Manager Tutorial</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.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%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"JetBrains Mono"}</style>
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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="slate" data-md-color-primary="blue-grey" data-md-color-accent="teal">
<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="#installing-docker-what-it-is-how-it-works-and-why-we-use-it" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="Media Manager Tutorial" class="md-header__button md-logo" aria-label="Media Manager Tutorial" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 17H3V5h18m0-2H3a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h5v2h8v-2h5a2 2 0 0 0 2-2V5a2 2 0 0 0-2-2"/></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">
Media Manager Tutorial
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Install Docker
</span>
</div>
</div>
</div>
<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 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon 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 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--integrated" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="Media Manager Tutorial" class="md-nav__button md-logo" aria-label="Media Manager Tutorial" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 17H3V5h18m0-2H3a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h5v2h8v-2h5a2 2 0 0 0 2-2V5a2 2 0 0 0-2-2"/></svg>
</a>
Media Manager Tutorial
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Installation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Installation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../setup-mount-points/" class="md-nav__link">
<span class="md-ellipsis">
Setup Mount Points
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Install Docker
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Install Docker
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#what-is-docker" class="md-nav__link">
<span class="md-ellipsis">
🐳 What Is Docker?
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#why-use-docker" class="md-nav__link">
<span class="md-ellipsis">
🔧 Why Use Docker?
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#why-not-put-everything-in-docker" class="md-nav__link">
<span class="md-ellipsis">
🚫 Why Not Put Everything in Docker?
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#why-qbittorrent-is-not-in-docker" class="md-nav__link">
<span class="md-ellipsis">
❌ Why qBittorrent Is NOT in Docker
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#why-plex-is-not-in-docker" class="md-nav__link">
<span class="md-ellipsis">
❌ Why Plex Is NOT in Docker
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#why-the-arr-stack-is-in-docker" class="md-nav__link">
<span class="md-ellipsis">
🟩 Why the ARR Stack Is in Docker
</span>
</a>
<nav class="md-nav" aria-label="🟩 Why the ARR Stack Is in Docker">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#benefits" class="md-nav__link">
<span class="md-ellipsis">
Benefits:
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#summary-the-architecture-philosophy" class="md-nav__link">
<span class="md-ellipsis">
🧱 Summary — The Architecture Philosophy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#installing-docker-raspberry-pi-linux" class="md-nav__link">
<span class="md-ellipsis">
🧰 Installing Docker (Raspberry Pi / Linux)
</span>
</a>
<nav class="md-nav" aria-label="🧰 Installing Docker (Raspberry Pi / Linux)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#download-script" class="md-nav__link">
<span class="md-ellipsis">
📥 Download Script
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#after-installation" class="md-nav__link">
<span class="md-ellipsis">
🚀 After Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#next-step-install-plex-on-the-host" class="md-nav__link">
<span class="md-ellipsis">
➡️ Next Step: Install Plex on the Host
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../install-plex/" class="md-nav__link">
<span class="md-ellipsis">
Install Plex
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../install-qbittorrent/" class="md-nav__link">
<span class="md-ellipsis">
Install Qbittorrent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../setup-media-manager/" class="md-nav__link">
<span class="md-ellipsis">
Setup Media Manager
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
Optional Installation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Optional Installation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../install-samba/" class="md-nav__link">
<span class="md-ellipsis">
Install Samba
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="installing-docker-what-it-is-how-it-works-and-why-we-use-it">Installing Docker — What It Is, How It Works, and Why We Use It</h1>
<p>Before installing Docker, its helpful to understand <strong>what Docker does</strong>, <strong>how it fits into our media management setup
</strong>, and <strong>why we run only the ARR stack inside Docker</strong> while keeping <strong>qBittorrent and Plex on the host system</strong>.</p>
<p>This page breaks it down simply and practically.</p>
<hr />
<h2 id="what-is-docker">🐳 What Is Docker?</h2>
<p>Docker is a <strong>containerization platform</strong>.</p>
<p>It allows you to run applications in isolated environments called <strong>containers</strong>. Each container:</p>
<ul>
<li>Has its own filesystem</li>
<li>Includes its own dependencies and libraries</li>
<li>Runs separately from your main system</li>
<li>Can be recreated or removed easily</li>
</ul>
<p>Think of a container as:</p>
<blockquote>
<p><strong>A lightweight, specialized mini-computer dedicated to one app.</strong></p>
</blockquote>
<p>This approach makes apps more predictable, easier to manage, and simpler to update.</p>
<hr />
<h2 id="why-use-docker">🔧 Why Use Docker?</h2>
<ul>
<li><strong>Avoid dependency conflicts:</strong> Containers bundle the apps needed libraries, leaving your base OS clean.</li>
<li><strong>Easy updates:</strong> Updating Radarr/Sonarr/Prowlarr is as simple as running:</li>
</ul>
<div class="language-text highlight"><span class="filename">Text Only</span><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>docker compose pull
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>docker compose up -d
</code></pre></div>
<ul>
<li><strong>Easy backups:</strong> Configuration files are stored in small, manageable folders.</li>
<li><strong>Great for frequently changing apps:</strong> Apps like Prowlarr and Radarr update often, and Docker simplifies rollout.</li>
</ul>
<hr />
<h2 id="why-not-put-everything-in-docker">🚫 Why Not Put Everything in Docker?</h2>
<p>While you could put all components into Docker, some behave poorly or have limitations when containerized, especially on
Raspberry Pi or home servers.</p>
<hr />
<h2 id="why-qbittorrent-is-not-in-docker">❌ Why qBittorrent Is NOT in Docker</h2>
<p>qBittorrent requires:</p>
<ul>
<li>Precise file permission control</li>
<li>Direct disk access</li>
<li>Stable, predictable file paths</li>
<li>High-speed I/O for torrent hashing</li>
<li>Ability to handle sudden restarts and disk changes</li>
</ul>
<p>Within Docker, qBittorrent faces problems like:</p>
<table>
<thead>
<tr>
<th>Problem</th>
<th>Cause</th>
</tr>
</thead>
<tbody>
<tr>
<td>Slow hashing</td>
<td>Docker overlay filesystem overhead</td>
</tr>
<tr>
<td>Permission issues</td>
<td>UID/GID mismatch with bind mounts</td>
</tr>
<tr>
<td>Inconsistent paths</td>
<td>Container paths differ from host paths</td>
</tr>
<tr>
<td>Poor integration</td>
<td>Radarr/Sonarr struggles with Docker paths</td>
</tr>
</tbody>
</table>
<p><strong>Conclusion:</strong></p>
<ul>
<li>Running qBittorrent directly on the host is faster, more reliable, and simpler.</li>
</ul>
<hr />
<h2 id="why-plex-is-not-in-docker">❌ Why Plex Is NOT in Docker</h2>
<p>Plex relies on:</p>
<table>
<thead>
<tr>
<th>Feature</th>
<th>Issue in Docker</th>
</tr>
</thead>
<tbody>
<tr>
<td>Hardware transcoding (VAAPI/V4L2/QuickSync)</td>
<td>Often broken or complicated to configure</td>
</tr>
<tr>
<td>Direct I/O from huge libraries</td>
<td>Overlay filesystem slows down I/O</td>
</tr>
<tr>
<td>Network discovery (multicast/IGMP)</td>
<td>Blocked or isolated inside containers</td>
</tr>
<tr>
<td>Handling millions of metadata files</td>
<td>Poor container filesystem performance</td>
</tr>
</tbody>
</table>
<p><strong>Conclusion:</strong></p>
<ul>
<li>Plex runs best on the host machine for speed, compatibility, and stable transcoding.</li>
</ul>
<hr />
<h2 id="why-the-arr-stack-is-in-docker">🟩 Why the ARR Stack <em>Is</em> in Docker</h2>
<p>Radarr, Sonarr, Prowlarr, and Bazarr are:</p>
<ul>
<li>Lightweight and simple</li>
<li>Use stable, clean directory structures</li>
<li>Store config in small folders</li>
<li>Benefit from frequent updates</li>
<li>Dont require hardware passes</li>
<li>Designed to run smoothly in containers</li>
</ul>
<h3 id="benefits">Benefits:</h3>
<ul>
<li>Consistent file paths as long as <code>/mnt/omnissiah-vault</code> is mounted</li>
<li>Easy migration with just config copy and docker-compose run</li>
<li>Isolation protects other apps if something breaks</li>
</ul>
<hr />
<h2 id="summary-the-architecture-philosophy">🧱 Summary — The Architecture Philosophy</h2>
<table>
<thead>
<tr>
<th>Component</th>
<th>Location</th>
<th>Reason</th>
</tr>
</thead>
<tbody>
<tr>
<td>Docker Engine</td>
<td>Host</td>
<td>Foundation layer</td>
</tr>
<tr>
<td>ARR Stack (Radarr, Sonarr, Prowlarr, Bazarr)</td>
<td>Docker</td>
<td>Perfect container candidates</td>
</tr>
<tr>
<td>qBittorrent</td>
<td>Host</td>
<td>Needs real filesystem and speed</td>
</tr>
<tr>
<td>Plex</td>
<td>Host</td>
<td>Needs hardware transcoding and network integration</td>
</tr>
</tbody>
</table>
<p>This hybrid setup balances performance, reliability, and ease of maintenance.</p>
<hr />
<h2 id="installing-docker-raspberry-pi-linux">🧰 Installing Docker (Raspberry Pi / Linux)</h2>
<p>This tutorial uses an installation script that:</p>
<ul>
<li>Updates your system</li>
<li>Removes any old conflicting packages</li>
<li>Installs Docker using the official convenience script</li>
<li>Installs Docker Compose</li>
<li>Adds your user to the docker group</li>
<li>Enables and starts Docker service</li>
<li>Verifies successful install</li>
</ul>
<h3 id="download-script">📥 Download Script</h3>
<p>👉 <strong><a href="../../scripts/shell/install-docker.sh">install-docker.sh</a></strong></p>
<hr />
<h2 id="after-installation">🚀 After Installation</h2>
<ul>
<li>reboot your system:</li>
</ul>
<div class="language-bash highlight"><span class="filename">Bash</span><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>sudo<span class="w"> </span>reboot
</code></pre></div>
<p>Once rebooted, your system will be ready to run containerized ARR services.</p>
<hr />
<h2 id="next-step-install-plex-on-the-host">➡️ Next Step: Install Plex on the Host</h2>
<p>Once Docker is installed, move on to installing Plex directly on the host to ensure your server is ready to stream media
as the ARR stack populates your libraries.</p>
<p>Go to 👉 <a href="../install-plex/">Install Plex</a></p>
<hr />
</article>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.expand", "navigation.sections", "navigation.top", "toc.integrate", "content.code.annotate", "content.code.copy", "content.code.select", "content.code.line_numbers", "content.tabs.link", "content.tooltips", "content.action.edit", "search.suggest", "search.highlight", "search.share", "header.autohide", "announce.dismiss", "footer.social"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>
</html>