humanized version and link fixes
This commit is contained in:
@@ -1,91 +1,89 @@
|
|||||||
# Prerequisites
|
# Getting Started
|
||||||
|
|
||||||
Before beginning the Media Manager setup, ensure that your system — whether it is a **fully configured and networked Raspberry Pi** or any other **Linux-based OS** — meets the minimum preparation requirements. Although this guide uses a Raspberry Pi as the reference environment, the setup works on almost any Linux host with minimal or no modification.
|
Setting up a Raspberry Pi for media management is generally straightforward, and many users have their own preferred
|
||||||
|
setup methods. This guide provides basic guidelines to help you prepare your Raspberry Pi or any Linux-based system for
|
||||||
|
the Media Manager setup without going into exhaustive detail.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Recommended System Requirements
|
## Recommended System Requirements
|
||||||
|
|
||||||
* Raspberry Pi 4 / 5 (4GB or 8GB recommended), or any Linux server/VM
|
- Raspberry Pi 4 or 5 (4GB or 8GB RAM recommended) or any Linux server/VM
|
||||||
* 64-bit OS
|
- 64-bit operating system
|
||||||
* Minimum 32GB storage
|
- At least 32GB of storage
|
||||||
* External HDD/SSD for media storage
|
- External HDD or SSD for media storage
|
||||||
* Stable network connection (Ethernet recommended)
|
- Stable network connection (Ethernet preferred)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## What Should Already Be Set Up
|
## What You Should Have Done Already
|
||||||
|
|
||||||
|
While this document won’t cover detailed Raspberry Pi installation steps, your system should be ready with the
|
||||||
|
following:
|
||||||
|
|
||||||
### 1. Raspberry Pi flashed and booted
|
### 1. Raspberry Pi flashed and booted
|
||||||
|
|
||||||
Your system should already have:
|
- Raspberry Pi OS or Ubuntu Server installed
|
||||||
|
- Completed the first boot
|
||||||
* Raspberry Pi OS / Ubuntu Server installed
|
- System fully updated:
|
||||||
* First boot completed
|
|
||||||
* System updated:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo apt update && sudo apt upgrade -y
|
sudo apt update && sudo apt upgrade -y
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Network configuration
|
### 2. Network setup configured
|
||||||
|
|
||||||
You should have:
|
|
||||||
|
|
||||||
* Working network access
|
|
||||||
* Static IP or DHCP reservation
|
|
||||||
* SSH enabled (recommended):
|
|
||||||
|
|
||||||
|
- Working network with either static IP or DHCP reservation
|
||||||
|
- SSH enabled for remote access (recommended):
|
||||||
```bash
|
```bash
|
||||||
sudo systemctl enable ssh --now
|
sudo systemctl enable ssh --now
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Storage connected and mounted
|
### 3. Storage attached and mounted
|
||||||
|
|
||||||
If using external HDD/SSD:
|
- External drives physically connected
|
||||||
|
- Drives recognized and formatted
|
||||||
|
- Mounted persistently via `/etc/fstab`, or ready to be configured in the mount points step
|
||||||
|
|
||||||
* Drives physically connected
|
### 4. Timezone and system time set
|
||||||
* File systems recognized
|
|
||||||
* Drives mounted persistently via `/etc/fstab`, or prepared for mounting in the Setup Mount Points step
|
|
||||||
|
|
||||||
### 4. System time and timezone configured
|
|
||||||
|
|
||||||
|
- Set the correct timezone for your location:
|
||||||
```bash
|
```bash
|
||||||
sudo timedatectl set-timezone Asia/Kolkata
|
sudo timedatectl set-timezone Asia/Kolkata
|
||||||
```
|
```
|
||||||
|
|
||||||
### 5. Basic Linux familiarity
|
---
|
||||||
|
|
||||||
You should be comfortable with:
|
### 5. Basic Linux knowledge
|
||||||
|
|
||||||
* Navigating directories
|
- Comfortable navigating directories, editing files (nano or vim), and running commands remotely via SSH
|
||||||
* Editing files using nano or vim
|
|
||||||
* Running commands via SSH
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Optional but Recommended
|
## Optional but Helpful
|
||||||
|
|
||||||
### Enable UFW Firewall
|
|
||||||
|
|
||||||
|
- Enable UFW firewall for added security:
|
||||||
```bash
|
```bash
|
||||||
sudo apt install ufw
|
|
||||||
sudo ufw enable
|
sudo ufw enable
|
||||||
sudo ufw allow ssh
|
sudo ufw allow ssh
|
||||||
|
sudo ufw allow <port>/tcp
|
||||||
```
|
```
|
||||||
|
|
||||||
### Set a hostname
|
- Set a custom hostname for your device:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo hostnamectl set-hostname media-manager
|
sudo hostnamectl set-hostname media-manager
|
||||||
```
|
```
|
||||||
|
|
||||||
### Hardware acceleration for Plex (optional)
|
- For Raspberry Pi users, hardware acceleration for Plex (VAAPI/V4L2) can improve media transcoding performance.
|
||||||
|
|
||||||
Raspberry Pi users may enable VAAPI/V4L2 for improved transcoding.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Next Step
|
## Next Step
|
||||||
|
|
||||||
Proceed to **[Overview](steps/overview.md)** once the above setup is complete.
|
Once your Raspberry Pi or Linux host is prepared, continue to the **[Overview](steps/overview.md)** for the installation
|
||||||
|
workflow.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Note:* Setting up a Raspberry Pi is quite accessible with many guides available online. Since everyone tends to have
|
||||||
|
personal preferences for flashing and configuring their Pi, this guide keeps the instructions focused on what’s
|
||||||
|
essential for the Media Manager setup without rehashing basic Raspberry Pi tutorials.
|
||||||
|
|||||||
@@ -1,71 +1,74 @@
|
|||||||
# Media Manager Setup Guide
|
# Media Manager Setup Guide
|
||||||
|
|
||||||
Welcome to the **Media Manager Tutorial**.
|
Welcome to the **Media Manager Tutorial**!
|
||||||
This guide walks you through setting up a complete, automated media workflow using:
|
This comprehensive guide will help you set up an automated home media system, perfect for managing movies and TV
|
||||||
|
shows—from downloading to organizing and streaming.
|
||||||
|
|
||||||
- **Docker** (host)
|
### What’s Inside
|
||||||
- **Plex Media Server** (host)
|
|
||||||
- **qBittorrent** (host)
|
|
||||||
- **ARR Stack** (Radarr, Sonarr, Prowlarr, Bazarr) via **docker-compose**
|
|
||||||
|
|
||||||
Whether you're setting up a home media server or a full automated media pipeline, this documentation provides clear, step-by-step instructions from installation to daily usage.
|
You’ll learn how to use:
|
||||||
|
|
||||||
|
- **Docker** to run and manage your media applications.
|
||||||
|
- **Plex Media Server** for streaming your media library at home or remotely.
|
||||||
|
- **qBittorrent** to automate downloads.
|
||||||
|
- The **ARR Stack** (Radarr, Sonarr, Prowlarr, Bazarr), brought together in Docker containers using `docker-compose`, to
|
||||||
|
streamline everything from searching for new releases to handling subtitles and metadata.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📚 What You Will Build
|
## 📚 What You Will Build
|
||||||
|
|
||||||
By the end of this guide, you will have a fully configured media management system that:
|
By following this guide, you’ll create a powerful and hands-off media setup that can:
|
||||||
|
|
||||||
- Automates movie and TV downloads
|
- Automatically find and download movies and TV episodes.
|
||||||
- Organizes media files into structured libraries
|
- Keep your media library tidy and organized.
|
||||||
- Streams content through Plex locally or remotely
|
- Stream your collection anywhere using Plex.
|
||||||
- Integrates Radarr/Sonarr with qBittorrent
|
- Link Radarr/Sonarr with qBittorrent for true automation.
|
||||||
- Automatically searches for new releases
|
- Grab new releases as soon as they’re available.
|
||||||
- Repairs metadata and subtitles
|
- Fix metadata and fetch subtitles without hassle.
|
||||||
- Requires minimal manual intervention once running
|
- Stay largely self-maintaining, so you don’t have to babysit it each day.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📁 Components Overview
|
## 📁 Components Overview
|
||||||
|
|
||||||
| Component | Installed On | Purpose |
|
| Component | Where It Runs | What It Does |
|
||||||
|------------------|--------------|---------|
|
|--------------------------------------------------|----------------------------|------------------------------------------------------------------------------|
|
||||||
| **Docker** | Host | Runs containerized media services (ARR stack) |
|
| **Docker** | Your server or computer | Hosts and runs the ARR stack containers. |
|
||||||
| **Plex** | Host | Streams your organized movies/TV shows |
|
| **Plex** | Your server or computer | Streams your sorted media collection. |
|
||||||
| **qBittorrent** | Host | Torrent client for automated downloads |
|
| **qBittorrent** | Your server or computer | Handles torrent downloads automatically. |
|
||||||
| **Arr Stack** (Radarr, Sonarr, Prowlarr, Bazarr) | Docker-Compose | Automated search, download, organization, metadata, subtitles |
|
| **ARR Stack** (Radarr, Sonarr, Prowlarr, Bazarr) | Docker, via docker-compose | Manages searching, downloading, organizing, and handling metadata/subtitles. |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🚀 Quick Navigation
|
## 🚀 Quick Navigation
|
||||||
|
|
||||||
Use the links below to jump to any part of the guide:
|
Jump directly to any part of the guide:
|
||||||
|
|
||||||
| Section | Description |
|
| Section | What’s Covered |
|
||||||
|---------|-------------|
|
|-----------------------------------------------------|-------------------------------------------------------|
|
||||||
| [Getting Started](getting-started.md) | Requirements, OS, network, prerequisites |
|
| [Getting Started](getting-started.md) | Prerequisites, operating system, and network overview |
|
||||||
| [Overview](steps/overview.md) | Summary of the installation workflow |
|
| [Overview](steps/overview.md) | A bird’s-eye view of the whole process |
|
||||||
| [Setup Mount Points](steps/setup-mount-points.md) | Create directories for media, downloads, configs |
|
| [Setup Mount Points](steps/setup-mount-points.md) | How to create folders for your media |
|
||||||
| [Install Docker](steps/install-docker.md) | Install Docker + docker-compose |
|
| [Install Docker](steps/install-docker.md) | Instructions for Docker and docker-compose |
|
||||||
| [Install Plex](steps/install-plex.md) | Install and configure Plex Media Server |
|
| [Install Plex](steps/install-plex.md) | Plex setup and configuration |
|
||||||
| [Install qBittorrent](steps/install-qbittorrent.md) | Install and configure qBittorrent |
|
| [Install qBittorrent](steps/install-qbittorrent.md) | qBittorrent installation and tips |
|
||||||
| [Setup Media Manager](steps/setup-media-manager.md) | Deploy Radarr, Sonarr, Prowlarr, Bazarr with docker-compose |
|
| [Setup Media Manager](steps/setup-media-manager.md) | Deploying the ARR stack with docker-compose |
|
||||||
| [Usage Guide](usage.md) | How to use Plex, Arr, automation steps |
|
|
||||||
| [Troubleshooting](troubleshooting.md) | Common issues and fixes |
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🧭 How to Use This Guide
|
## 🧭 How to Use This Guide
|
||||||
|
|
||||||
This tutorial is structured linearly. You should follow the sections in order unless you already have certain components installed.
|
This guide is designed to be followed step by step. If you already have some tools installed, you can skip those
|
||||||
|
sections—otherwise, work through each part in order for a smooth setup.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 💬 Need Help?
|
## 💬 Need Help?
|
||||||
|
|
||||||
Each step includes explanations, commands, and troubleshooting tips.
|
Every step offers clear commands, explanations, and tips.
|
||||||
If you're stuck, refer to the troubleshooting section or review each command carefully.
|
If you hit a roadblock, check out the troubleshooting section or double-check the instructions provided.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Let’s begin with the basics → **[Getting Started](getting-started.md)**
|
Ready to get started? Head to → **[Getting Started](getting-started.md)**
|
||||||
|
|||||||
@@ -1,172 +1,162 @@
|
|||||||
# 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
|
||||||
|
|
||||||
Before installing Docker, it’s important to understand **what Docker actually does**, **how it fits into our media management setup**, and **why we run only the ARR stack inside Docker** while keeping **qBittorrent and Plex on the host system**.
|
Before installing Docker, it’s helpful to understand **what Docker does**, **how it fits into our media management setup
|
||||||
|
**, and **why we run only the ARR stack inside Docker** while keeping **qBittorrent and Plex on the host system**.
|
||||||
|
|
||||||
This page will walk you through all of that in simple, practical terms.
|
This page breaks it down simply and practically.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🐳 What Is Docker?
|
## 🐳 What Is Docker?
|
||||||
|
|
||||||
Docker is a **containerization platform**.
|
Docker is a **containerization platform**.
|
||||||
|
|
||||||
That means:
|
It allows you to run applications in isolated environments called **containers**. Each container:
|
||||||
|
|
||||||
### Docker lets you run applications in small, isolated environments called **containers**.
|
- Has its own filesystem
|
||||||
|
- Includes its own dependencies and libraries
|
||||||
|
- Runs separately from your main system
|
||||||
|
- Can be recreated or removed easily
|
||||||
|
|
||||||
A container:
|
Think of a container as:
|
||||||
|
|
||||||
- has its own filesystem
|
> **A lightweight, specialized mini-computer dedicated to one app.**
|
||||||
- has its own dependencies
|
|
||||||
- has its own libraries
|
|
||||||
- cannot interfere with your main system
|
|
||||||
- can be destroyed and recreated easily
|
|
||||||
|
|
||||||
Think of it like:
|
This approach makes apps more predictable, easier to manage, and simpler to update.
|
||||||
|
|
||||||
> **A lightweight, specialized mini-computer for one application.**
|
|
||||||
|
|
||||||
This makes apps more predictable, easier to upgrade, and easier to manage.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🔧 Why Use Docker?
|
## 🔧 Why Use Docker?
|
||||||
|
|
||||||
### ✔ Avoid dependency conflicts
|
- **Avoid dependency conflicts:** Containers bundle the app’s needed libraries, leaving your base OS clean.
|
||||||
Containers ship the libraries the app needs, so you don’t pollute your main OS.
|
- **Easy updates:** Updating Radarr/Sonarr/Prowlarr is as simple as running:
|
||||||
|
|
||||||
### ✔ Easy to update
|
|
||||||
Updating Radarr/Sonarr/Prowlarr becomes:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
docker compose pull
|
docker compose pull
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
### ✔ Easy to back up
|
- **Easy backups:** Configuration files are stored in small, manageable folders.
|
||||||
ARR services store their config in a small folder you can snapshot.
|
- **Great for frequently changing apps:** Apps like Prowlarr and Radarr update often, and Docker simplifies rollout.
|
||||||
|
|
||||||
### ✔ Perfect for things that change often
|
|
||||||
Indexers break, Prowlarr updates, Radarr adds features — Docker makes it painless.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🚫 Why Not Put Everything in Docker?
|
## 🚫 Why Not Put Everything in Docker?
|
||||||
|
|
||||||
You *can* put everything in Docker, but in a real-world Raspberry Pi / home-server environment, some apps **behave badly** or **have limitations** inside containers.
|
While you could put all components into Docker, some behave poorly or have limitations when containerized, especially on
|
||||||
|
Raspberry Pi or home servers.
|
||||||
Below is the reasoning for each major component.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# ❌ Why qBittorrent Is NOT in Docker
|
## ❌ Why qBittorrent Is NOT in Docker
|
||||||
|
|
||||||
### qBittorrent needs:
|
qBittorrent requires:
|
||||||
- fine-grained permission control
|
|
||||||
- direct disk access
|
|
||||||
- stable file paths
|
|
||||||
- high-speed I/O for torrent hashing
|
|
||||||
- ability to handle sudden restarts and disk states
|
|
||||||
|
|
||||||
Inside Docker, qBit often has problems:
|
- Precise file permission control
|
||||||
|
- Direct disk access
|
||||||
|
- Stable, predictable file paths
|
||||||
|
- High-speed I/O for torrent hashing
|
||||||
|
- Ability to handle sudden restarts and disk changes
|
||||||
|
|
||||||
| Problem | Why It Happens |
|
Within Docker, qBittorrent faces problems like:
|
||||||
|--------|----------------|
|
|
||||||
| Slow hashing | Docker’s overlay filesystem adds overhead |
|
|
||||||
| Permission issues | Containers struggle with mixed UID/GID + bind mounts |
|
|
||||||
| Inconsistent paths | qBit expects real Linux paths for completed downloads |
|
|
||||||
| Harder integration | Radarr/Sonarr sometimes misread container-mapped paths |
|
|
||||||
|
|
||||||
### 🧠 Therefore:
|
| Problem | Cause |
|
||||||
**qBittorrent on the host is cleaner, faster, and more stable.**
|
|--------------------|-------------------------------------------|
|
||||||
|
| Slow hashing | Docker overlay filesystem overhead |
|
||||||
|
| Permission issues | UID/GID mismatch with bind mounts |
|
||||||
|
| Inconsistent paths | Container paths differ from host paths |
|
||||||
|
| Poor integration | Radarr/Sonarr struggles with Docker paths |
|
||||||
|
|
||||||
|
### Conclusion:
|
||||||
|
|
||||||
|
Running qBittorrent directly on the host is faster, more reliable, and simpler.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# ❌ Why Plex Is NOT in Docker
|
## ❌ Why Plex Is NOT in Docker
|
||||||
|
|
||||||
This is even more important.
|
Plex relies on:
|
||||||
|
|
||||||
### Plex inside Docker struggles with:
|
|
||||||
|
|
||||||
| Feature | Issue in Docker |
|
| Feature | Issue in Docker |
|
||||||
|--------|-----------------|
|
|---------------------------------------------|------------------------------------------|
|
||||||
| **Hardware transcoding (VAAPI/V4L2/QuickSync)** | Often broken or requires special setup |
|
| Hardware transcoding (VAAPI/V4L2/QuickSync) | Often broken or complicated to configure |
|
||||||
| **Direct I/O from large libraries** | Docker overlay adds slowdowns |
|
| Direct I/O from huge libraries | Overlay filesystem slows down I/O |
|
||||||
| **Automatic network discovery** | Plex uses multicast/IGMP which Docker isolates |
|
| Network discovery (multicast/IGMP) | Blocked or isolated inside containers |
|
||||||
| **Large metadata directories** | Docker containers don’t like millions of tiny files |
|
| Handling millions of metadata files | Poor container filesystem performance |
|
||||||
|
|
||||||
Plex has a massive, constantly evolving I/O profile and **performs best on bare metal** (host).
|
### Conclusion:
|
||||||
|
|
||||||
### 🧠 Therefore:
|
Plex runs best on the host machine for speed, compatibility, and stable transcoding.
|
||||||
**Install Plex directly on the host for speed, compatibility, and transcoding support.**
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🟩 Why the ARR Stack *Is* in Docker
|
## 🟩 Why the ARR Stack *Is* in Docker
|
||||||
|
|
||||||
Radarr, Sonarr, and Prowlarr:
|
Radarr, Sonarr, Prowlarr, and Bazarr are:
|
||||||
|
|
||||||
- are lightweight
|
- Lightweight and simple
|
||||||
- use clean, simple paths
|
- Use stable, clean directory structures
|
||||||
- store configuration in manageable folders
|
- Store config in small folders
|
||||||
- benefit from frequent updates
|
- Benefit from frequent updates
|
||||||
- rarely need hardware access
|
- Don’t require hardware passes
|
||||||
- behave very predictably in containers
|
- Designed to run smoothly in containers
|
||||||
|
|
||||||
They’re practically **designed to live inside Docker**.
|
### Benefits:
|
||||||
|
|
||||||
### ✔ Consistent paths
|
- Consistent file paths as long as `/mnt/omnissiah-vault` is mounted
|
||||||
As long as `/mnt/omnissiah-vault` is mounted, containers have zero issues.
|
- Easy migration with just config copy and docker-compose run
|
||||||
|
- Isolation protects other apps if something breaks
|
||||||
### ✔ Easy migrations
|
|
||||||
Moving to a new server is as simple as:
|
|
||||||
|
|
||||||
```
|
|
||||||
copy configs → run docker-compose → done
|
|
||||||
```
|
|
||||||
|
|
||||||
### ✔ Better isolation
|
|
||||||
If Radarr breaks from an update, it won’t affect Plex or qBit.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🧱 Summary — The Architecture Philosophy
|
## 🧱 Summary — The Architecture Philosophy
|
||||||
|
|
||||||
| Component | Host or Docker? | Reason |
|
| Component | Location | Reason |
|
||||||
|----------|------------------|---------|
|
|----------------------------------------------|----------|----------------------------------------------------|
|
||||||
| **Docker Engine** | Host | Foundation layer |
|
| Docker Engine | Host | Foundation layer |
|
||||||
| **ARR Stack (Radarr / Sonarr / Prowlarr / Bazarr)** | Docker | Best candidates for containers |
|
| ARR Stack (Radarr, Sonarr, Prowlarr, Bazarr) | Docker | Perfect container candidates |
|
||||||
| **qBittorrent** | Host | Needs stable I/O + real filesystem access |
|
| qBittorrent | Host | Needs real filesystem and speed |
|
||||||
| **Plex** | Host | Needs hardware transcoding + network discovery |
|
| Plex | Host | Needs hardware transcoding and network integration |
|
||||||
|
|
||||||
This hybrid approach gives us the **best combination of performance, stability, and maintainability**.
|
This hybrid setup balances performance, reliability, and ease of maintenance.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🧰 Installing Docker (Raspberry Pi / Linux)
|
## 🧰 Installing Docker (Raspberry Pi / Linux)
|
||||||
|
|
||||||
Here is the installation script referenced in the flow:
|
This tutorial uses an installation script that:
|
||||||
|
|
||||||
|
- Updates your system
|
||||||
|
- Removes any old conflicting packages
|
||||||
|
- Installs Docker using the official convenience script
|
||||||
|
- Installs Docker Compose
|
||||||
|
- Adds your user to the docker group
|
||||||
|
- Enables and starts Docker service
|
||||||
|
- Verifies successful install
|
||||||
|
|
||||||
### 📥 Download Script
|
### 📥 Download Script
|
||||||
|
|
||||||
👉 **[install-docker.sh](../scripts/shell/install-docker.sh)**
|
👉 **[install-docker.sh](../scripts/shell/install-docker.sh)**
|
||||||
|
|
||||||
### 🖥️ What the script does
|
---
|
||||||
- updates the system
|
|
||||||
- removes conflicting old packages
|
|
||||||
- installs Docker using the official convenience script
|
|
||||||
- installs Docker Compose
|
|
||||||
- adds your user to the docker group
|
|
||||||
- enables and starts the Docker service
|
|
||||||
- verifies installation
|
|
||||||
|
|
||||||
After running it:
|
## 🚀 After Installation
|
||||||
|
|
||||||
|
- reboot your system:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo reboot
|
sudo reboot
|
||||||
```
|
```
|
||||||
Your system will be ready to run containerized ARR services.
|
|
||||||
|
|
||||||
# 🚀 Next Step: Configure Plex (Host Installation)
|
Once rebooted, your system will be ready to run containerized ARR services.
|
||||||
Once Docker is installed, we move forward with:
|
|
||||||
👉 Install Plex (steps/install-plex.md)
|
---
|
||||||
This ensures the server is ready to serve media once the ARR stack begins populating it.
|
|
||||||
|
## 🚀 Next Step: Install Plex on the Host
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Go to 👉 [Install Plex](install-plex.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|||||||
@@ -1,89 +1,83 @@
|
|||||||
# Installing Plex Media Server
|
# Installing Plex Media Server
|
||||||
|
|
||||||
Plex is the heart of your media ecosystem. It scans your library, fetches metadata, organizes everything neatly, and makes your movies and shows available to stream from anywhere. Installing Plex is straightforward, but **where you store its configuration and metadata** is extremely important.
|
Plex is the core of your media ecosystem. It scans your libraries, fetches metadata, organizes your content, and lets
|
||||||
|
you stream movies and shows from anywhere. While installing Plex is straightforward, **where you store its configuration
|
||||||
|
and metadata** is crucial for performance and longevity.
|
||||||
|
|
||||||
This guide explains:
|
This guide covers:
|
||||||
|
|
||||||
* What Plex is and how it works
|
- What Plex is and how it works
|
||||||
* Why it should *not* run inside Docker in this setup
|
- Why Plex should *not* run inside Docker in this setup
|
||||||
* Why its configuration directory must be placed on your external HDD
|
- Why its configuration directory belongs on your external HDD
|
||||||
* What gets stored there and how large it can grow
|
- What Plex stores and how large it can get
|
||||||
* The installation script used to set everything up
|
- The installation script used to set it all up
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🎬 What Is Plex?
|
## 🎬 What Is Plex?
|
||||||
|
|
||||||
Plex Media Server is an application that:
|
Plex Media Server is an application that:
|
||||||
|
|
||||||
* Indexes your media library
|
- Indexes your media collection
|
||||||
* Fetches rich metadata (posters, backgrounds, cast info, themes)
|
- Fetches rich metadata like posters, backgrounds, cast info, and themes
|
||||||
* Streams your content to TVs, phones, tablets, and browsers
|
- Streams content to TVs, phones, tablets, and browsers
|
||||||
* Transcodes media when needed
|
- Transcodes media when needed for smooth playback
|
||||||
* Manages user accounts, watch history, and recommendations
|
- Manages users, watch history, and personalized recommendations
|
||||||
|
|
||||||
Plex is extremely powerful — but with that power comes heavy disk usage.
|
With great power comes heavy disk usage.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🧱 Why Plex Runs *Outside* Docker
|
## 🧱 Why Plex Runs *Outside* Docker
|
||||||
|
|
||||||
Although Docker is fantastic for the ARR stack, Plex is more demanding and behaves better on the **host system**.
|
Though Docker is excellent for the ARR stack, Plex demands more and runs better directly on the host system.
|
||||||
|
|
||||||
Running Plex in Docker often introduces problems:
|
Common problems running Plex inside Docker:
|
||||||
|
|
||||||
| Issue | Why It Happens in Docker |
|
| Issue | Cause in Docker |
|
||||||
| ------------------------------------ | -------------------------------------------------------- |
|
|----------------------------------|---------------------------------------------------------|
|
||||||
| **Hardware transcoding failures** | Containerization interferes with VAAPI/V4L2/QuickSync |
|
| Hardware transcoding failures | Containerization blocks VAAPI/V4L2/QuickSync access |
|
||||||
| **Slow scanning of large libraries** | Docker's overlay filesystem slows metadata I/O |
|
| Slow scanning of large libraries | Overlay filesystem slows metadata read/write |
|
||||||
| **Network discovery issues** | Plex requires multicast/IGMP, blocked by Docker networks |
|
| Network discovery issues | Plex multicast/IGMP blocked by Docker network isolation |
|
||||||
| **Large metadata directory** | Containers struggle with millions of tiny files |
|
| Large metadata directories | Containers struggle with millions of tiny files |
|
||||||
|
|
||||||
Real-world experience proves Plex performs best when installed directly on the OS.
|
Practical experience shows Plex performs best installed natively on the OS.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🗃️ Why Move Plex Metadata to an External HDD?
|
## 🗃️ Why Move Plex Metadata to an External HDD?
|
||||||
|
|
||||||
Plex stores a massive amount of metadata — often **tens or hundreds of gigabytes** depending on library size.
|
Plex stores a huge amount of metadata—often tens to hundreds of gigabytes, depending on your library size.
|
||||||
|
|
||||||
Here’s what Plex stores inside its config directory:
|
Stored in its config directory are:
|
||||||
|
|
||||||
* Posters & artwork
|
- Posters and artwork
|
||||||
* Backdrops
|
- Backdrops
|
||||||
* Theme music
|
- Theme music
|
||||||
* Subtitles
|
- Subtitles
|
||||||
* Optimization cache
|
- Optimization and transcoding caches
|
||||||
* Transcoding cache
|
- Databases for libraries, watch history, video analysis, and intro detection
|
||||||
* Databases for:
|
|
||||||
|
|
||||||
* Libraries
|
### 📌 Typical Metadata Sizes
|
||||||
* Watch history
|
|
||||||
* Video analysis
|
|
||||||
* Intro detection
|
|
||||||
|
|
||||||
These files grow quickly.
|
- Small library (500 files): **5–10 GB**
|
||||||
|
- Medium library (2,000 files): **20–50 GB**
|
||||||
|
- Large library (10,000+ files): **100 GB+**
|
||||||
|
|
||||||
## 📌 Example Metadata Sizes
|
If this data stays on your system SD card or root SSD (e.g., `/var/lib/plexmediaserver`):
|
||||||
|
|
||||||
* Small library (500 files): **5–10 GB**
|
- The OS disk can fill up fast
|
||||||
* Medium library (2,000 files): **20–50 GB**
|
- SD cards may wear out prematurely
|
||||||
* Large library (10,000+ files): **100 GB+**
|
- Plex performance will degrade
|
||||||
|
|
||||||
If you keep this in `/var/lib/plexmediaserver` on the SD card or system SSD:
|
### ✔ Store metadata on your external HDD to:
|
||||||
|
|
||||||
* The OS disk will fill up
|
- Access large, fast storage
|
||||||
* SD cards will wear out quickly
|
- Protect your OS drive from filling
|
||||||
* Plex performance will suffer severely
|
- Extend SD card lifespan
|
||||||
|
- Boost Plex scanning and caching speeds
|
||||||
|
|
||||||
### ✔ Placing metadata on your external HDD solves everything
|
This is why Plex config is relocated to:
|
||||||
|
|
||||||
* Massive storage availability
|
|
||||||
* Higher endurance than SD cards
|
|
||||||
* Faster scanning and caching
|
|
||||||
* No risk of filling the root filesystem
|
|
||||||
|
|
||||||
This is why we relocate Plex config to:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
/mnt/omnissiah-vault/configs/plex
|
/mnt/omnissiah-vault/configs/plex
|
||||||
@@ -91,34 +85,42 @@ This is why we relocate Plex config to:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# ⚙️ Installation Script
|
## ⚙️ Installation Script
|
||||||
|
|
||||||
Below is the installation script used for this tutorial. It:
|
This tutorial uses an installation script that:
|
||||||
|
|
||||||
* Installs Plex Media Server from the official repository
|
- Installs Plex Media Server from the official repository
|
||||||
* Stops the service
|
- Stops the Plex service temporarily
|
||||||
* Moves its entire metadata/config directory to your mounted HDD
|
- Moves the entire Plex metadata and config folder to your external HDD
|
||||||
* Creates a symlink so Plex still sees the expected path
|
- Creates a symbolic link so Plex finds its config in the expected place
|
||||||
* Ensures correct ownership for the `plex` user
|
- Fixes file ownerships for the `plex` user
|
||||||
* Restarts and enables the service
|
- Restarts and enables Plex to run on boot
|
||||||
* 📥 Download Script
|
|
||||||
👉 **[install-docker.sh](../scripts/shell/install-plex.sh)**
|
### 📥 Download Script
|
||||||
|
|
||||||
|
👉 **[install-plex.sh](../scripts/shell/install-plex.sh)**
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🚀 After Installation
|
## 🚀 After Installation
|
||||||
|
|
||||||
Once Plex is installed and its metadata moved to your external drive, you can:
|
Once Plex is installed and its metadata moved:
|
||||||
|
|
||||||
* Open the Web UI
|
- Open the Plex Web UI in your browser
|
||||||
* Sign in with your Plex account
|
- Sign in with your Plex account
|
||||||
* Add your libraries from `/mnt/omnissiah-vault/media`
|
- Add your media libraries pointing to `/mnt/omnissiah-vault/media`
|
||||||
* Run a full scan
|
- Run a full library scan
|
||||||
|
|
||||||
Everything moving forward — including posters, metadata, intro detection, and caching — will stay safely on the external HDD.
|
All ongoing metadata, caching, posters, and intro markers will safely reside on your external HDD.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# ➡️ Next Step
|
## ➡️ Next Step: Install qBittorrent on the Host
|
||||||
|
|
||||||
Proceed to **Install qBittorrent** to complete the host-based components.
|
After successfully installing Plex and configuring its metadata on your external HDD, it’s time to set up **qBittorrent
|
||||||
|
**, the torrent client responsible for downloading your media files automatically.
|
||||||
|
|
||||||
|
Proceed to the detailed installation and configuration instructions here:
|
||||||
|
Go to 👉 **[Install qBittorrent](install-qbittorrent.md)**
|
||||||
|
|
||||||
|
---
|
||||||
|
|||||||
@@ -1,110 +1,104 @@
|
|||||||
# Installing qBittorrent (Host Installation)
|
# Installing qBittorrent (Host Installation)
|
||||||
|
|
||||||
qBittorrent is the download engine of your media automation setup. It handles all torrent activity triggered by Radarr, Sonarr, and Prowlarr. Installing it on the **host system** (not Docker) ensures optimal speed, stable paths, and maximum compatibility.
|
qBittorrent is the download engine of your media automation setup. It handles all torrent activity triggered by Radarr,
|
||||||
|
Sonarr, and Prowlarr. Installing it on the **host system** (not Docker) ensures optimal speed, stable paths, and maximum
|
||||||
|
compatibility.
|
||||||
|
|
||||||
This guide explains:
|
This guide explains:
|
||||||
|
|
||||||
* What qBittorrent does in the media pipeline
|
- What qBittorrent does in the media pipeline
|
||||||
* Why it should *not* run inside Docker in a real-world Pi/home server setup
|
- Why it should *not* run inside Docker in a real-world Pi/home server setup
|
||||||
* Why its configuration does **not** need to be moved to your external drive
|
- Why its configuration does **not** need to be moved to your external drive
|
||||||
* The installation script used to install and run qBittorrent as a systemd service
|
- The installation script used to install and run qBittorrent as a systemd service
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🌀 What Is qBittorrent?
|
## 🌀 What Is qBittorrent?
|
||||||
|
|
||||||
qBittorrent is an open‑source torrent client with:
|
qBittorrent is an open‑source torrent client featuring:
|
||||||
|
|
||||||
* A lightweight Web UI
|
- Lightweight Web UI
|
||||||
* Fast download engine
|
- Fast download engine
|
||||||
* Built-in category and tagging support
|
- Built-in category and tagging support
|
||||||
* Excellent integration with Radarr & Sonarr
|
- Excellent integration with Radarr & Sonarr
|
||||||
* Very low resource usage
|
- Very low resource usage
|
||||||
|
|
||||||
It acts as the **download worker** for the entire Media Manager.
|
It acts as the **download worker** for the entire Media Manager.
|
||||||
|
|
||||||
When Radarr/Sonarr find a new movie or episode, they send the torrent to qBittorrent. When the download completes, ARR handles renaming and moving the file.
|
When Radarr or Sonarr find new media, they send the torrent to qBittorrent. Upon completion, ARR processes renaming and
|
||||||
|
file management.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# ❌ Why qBittorrent Should NOT Run in Docker
|
## ❌ Why qBittorrent Should NOT Run in Docker
|
||||||
|
|
||||||
Although qBittorrent *can* run in Docker, it performs **significantly worse** and causes practical issues when used on low-power servers like Raspberry Pi.
|
Though technically possible, running qBittorrent in Docker on low-power hardware like Raspberry Pi causes significant
|
||||||
|
issues:
|
||||||
|
|
||||||
Here’s why.
|
### 1. Docker slows torrent hashing
|
||||||
|
|
||||||
## 🐌 1. Docker slows down torrent hashing
|
- Torrenting requires intensive hashing and verifying large files
|
||||||
|
- Docker’s overlay filesystem adds overhead, causing slower hashing and higher CPU usage
|
||||||
|
|
||||||
qBit must:
|
### 2. Permissions become complicated
|
||||||
|
|
||||||
* Hash large files
|
- Bind-mounted volumes in Docker cause UID/GID mismatches
|
||||||
* Verify blocks
|
- Sonarr/Radarr struggle to access or import completed downloads correctly
|
||||||
* Manage partial pieces
|
- On the host, file permissions behave predictably and natively
|
||||||
|
|
||||||
Docker overlays add filesystem overhead → hashing becomes slower → CPU usage increases.
|
### 3. Stable real file paths are necessary
|
||||||
|
|
||||||
## 🔐 2. Permissions become messy
|
- qBittorrent expects actual Linux paths (e.g., `/mnt/omnissiah-vault/downloads`)
|
||||||
|
- Containers often abstract paths, confusing ARR’s automation
|
||||||
|
|
||||||
Inside Docker:
|
### 4. Performance is better on the host
|
||||||
|
|
||||||
* Download paths are bind-mounted
|
- Download speeds, disk writes, and hashing all run faster without Docker’s overhead
|
||||||
* UID/GID mapping becomes inconsistent
|
|
||||||
* Sonarr/Radarr sometimes cannot see or import completed downloads
|
|
||||||
|
|
||||||
On the host:
|
### ✔ Conclusion:
|
||||||
|
|
||||||
* Files are native
|
**qBittorrent performs best installed directly on the host system.**
|
||||||
* Permissions are predictable
|
|
||||||
* ARR integration is flawless
|
|
||||||
|
|
||||||
## 📁 3. Real file paths are required for stability
|
|
||||||
|
|
||||||
qBit expects stable, real Linux paths like:
|
|
||||||
|
|
||||||
```
|
|
||||||
/mnt/omnissiah-vault/downloads
|
|
||||||
```
|
|
||||||
|
|
||||||
Containers often abstract or rewrite these, confusing ARR.
|
|
||||||
|
|
||||||
## 🚀 4. Performance is dramatically better on the host
|
|
||||||
|
|
||||||
Download speed, disk writes, and hashing are all faster without Docker.
|
|
||||||
|
|
||||||
### ✔ Therefore:
|
|
||||||
|
|
||||||
**qBittorrent belongs on the host system for maximum stability and speed.**
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 📦 Why qBittorrent Config Does NOT Go on the External HDD
|
## 📦 Why qBittorrent Configuration Does NOT Need External HDD
|
||||||
|
|
||||||
Unlike Plex—which can generate **tens of gigabytes** of metadata—qBittorrent stores only:
|
Unlike Plex’s large metadata, qBittorrent stores only minor config files such as:
|
||||||
|
|
||||||
* a few small configuration files
|
- Configuration settings
|
||||||
* a few `.fastresume` entries
|
- Small torrent resume files
|
||||||
* a small database of torrents
|
- A lightweight database
|
||||||
|
|
||||||
Typical qBit config directory size:
|
Typical config size: **2–20 MB** — negligible and stable.
|
||||||
|
|
||||||
* 2–20 MB
|
Keeping qBittorrent config on your system’s internal OS disk is safe and recommended.
|
||||||
|
|
||||||
It does **not** grow with your media library.
|
|
||||||
|
|
||||||
### ✔ Keeping qBit on the internal OS disk is safe and recommended.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# ⚙️ Installation Script (Systemd Service)
|
## ⚙️ Installation Script (Systemd Service)
|
||||||
|
|
||||||
|
## ⚙️ Installation Script
|
||||||
|
|
||||||
|
This tutorial uses an installation script that:
|
||||||
|
|
||||||
|
- Updates and upgrades system packages
|
||||||
|
- Installs qBittorrent-nox (the headless version)
|
||||||
|
- Creates a dedicated system user for qBittorrent
|
||||||
|
- Adds your normal user to the qBittorrent group for file access
|
||||||
|
- Creates a systemd service file to run qBittorrent as a background service
|
||||||
|
- Enables and starts the qBittorrent service to run at boot
|
||||||
|
|
||||||
|
After running the script, you can access qBittorrent’s Web UI and begin configuring your download settings.
|
||||||
|
|
||||||
|
### 📥 Download Script
|
||||||
|
|
||||||
|
👉 **[install-qbittorrent.sh](../scripts/shell/install-qbittorrent.sh)**
|
||||||
|
|
||||||
The script below installs qBittorrent‑nox and configures it to run as a background service.
|
|
||||||
* 📥 Download Script
|
|
||||||
👉 **[install-docker.sh](../scripts/shell/install-qbittorrent.sh)**
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🚀 After Installation
|
## 🚀 After Installation
|
||||||
|
|
||||||
Visit:
|
Access the Web UI at:
|
||||||
|
|
||||||
```
|
```
|
||||||
http://<your_pi_ip>:8080
|
http://<your_pi_ip>:8080
|
||||||
@@ -117,18 +111,23 @@ username: admin
|
|||||||
password: adminadmin
|
password: adminadmin
|
||||||
```
|
```
|
||||||
|
|
||||||
You *must* change the password on first login.
|
**Change your password on first login!**
|
||||||
|
|
||||||
Next steps:
|
Next steps:
|
||||||
|
|
||||||
* Configure download paths
|
- Configure download directories
|
||||||
* Add categories (`movies`, `tv`, etc.)
|
- Add categories such as `movies` and `tv`
|
||||||
* Disable torrenting features you don’t need
|
- Disable any unwanted torrenting features
|
||||||
|
|
||||||
ARR integration happens after the Docker portion is set up.
|
ARR integration will be configured after the Docker-based ARR stack is deployed.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# ➡️ Next Step
|
## ➡️ Next Step: Setup ARR Stack (Docker Compose)
|
||||||
|
|
||||||
Proceed to the **ARR Stack setup (Docker Compose)** to handle automation.
|
Now that host-based components (Plex and qBittorrent) are ready, proceed to deploy the ARR stack via Docker Compose to
|
||||||
|
automate searching, downloading, and organizing your media.
|
||||||
|
|
||||||
|
Go to 👉 **[Setup Media Manager](setup-media-manager.md)**
|
||||||
|
|
||||||
|
---
|
||||||
|
|||||||
@@ -1,101 +1,80 @@
|
|||||||
# Optional: Installing Samba for Windows Network Access
|
# Optional: Installing Samba for Windows Network Access
|
||||||
|
|
||||||
Samba is **optional** in this Media Manager setup, but highly recommended if:
|
While Samba setup is not mandatory for this Media Manager system, it’s highly recommended if you want easier access to your media files from Windows machines or other devices on your network.
|
||||||
|
|
||||||
* You use **Windows** and want to browse your media files easily
|
Here’s why you might want to consider Samba:
|
||||||
* You want to manually adjust or inspect downloaded files
|
|
||||||
* You want to drag-and-drop subtitles, rename files, or fix issues directly
|
|
||||||
* You want the flexibility of mounting your media as a network drive
|
|
||||||
|
|
||||||
If you only ever access files through Plex, ARR apps, or the Linux shell, then Samba is **not required**.
|
- You use **Windows** and want to browse your media files through File Explorer effortlessly.
|
||||||
|
- You prefer to manage downloaded files manually—like dragging subtitles into folders, renaming movies, or cleaning up files directly.
|
||||||
|
- You want to have the media storage appear as a network drive for quick access anytime.
|
||||||
|
|
||||||
|
If you mainly interact with your media through Plex, Radarr, Sonarr, or the Linux terminal, Samba is not essential.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🧩 Why Samba Might Be Needed
|
## Why Samba Can Be Useful
|
||||||
|
|
||||||
Although Radarr, Sonarr, and Bazarr automate nearly everything, there are situations where **manual file access** is useful:
|
Despite the automation provided by Radarr, Sonarr, and Bazarr, there are times when manual access is needed:
|
||||||
|
|
||||||
* Fixing incorrectly tagged files
|
- Fixing files that didn’t tag correctly
|
||||||
* Manual subtitle adjustments
|
- Adjusting subtitles
|
||||||
* Deleting or replacing corrupted media
|
- Removing or replacing problematic media
|
||||||
* Organizing large folders
|
- Organizing your library beyond automation
|
||||||
* Backing up media manually
|
- Taking backups of your media collection
|
||||||
|
|
||||||
On **Linux or macOS**, this can be done easily over SSH.
|
On Linux or macOS, SSH provides a way to do this. But Windows users benefit most from Samba shares, which map your server’s drive like a regular Windows network folder.
|
||||||
|
|
||||||
On **Windows**, the easiest way is via **Samba (SMB)** network shares.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 💠 What Samba Does
|
## What Samba Does
|
||||||
|
|
||||||
Samba exposes directories on your Raspberry Pi/Linux server as Windows-compatible network drives.
|
Samba turns your Raspberry Pi or Linux server’s storage into Windows-friendly network shares.
|
||||||
|
|
||||||
It allows you to access:
|
For example, the folder:
|
||||||
|
|
||||||
```
|
```
|
||||||
/mnt/omnissiah-vault
|
/mnt/omnissiah-vault
|
||||||
```
|
```
|
||||||
|
|
||||||
from Windows like:
|
Can be used from Windows like:
|
||||||
|
|
||||||
```
|
```
|
||||||
Z:\ → Omnissiah-Vault
|
Z:\ → Omnissiah-Vault
|
||||||
```
|
```
|
||||||
|
|
||||||
This behaves like a native Windows drive:
|
This means in Windows:
|
||||||
|
|
||||||
* You can open files
|
- You can open and play files
|
||||||
* Copy folders
|
- Copy and move folders as usual
|
||||||
* Delete/rename items
|
- Rename and delete files directly
|
||||||
* Perform maintenance tasks
|
- Manage your media easily without logging into the server
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 📦 Installation Script (Optional)
|
## Samba Installation Script (Optional)
|
||||||
|
|
||||||
If you want Samba on your server, use the following script:
|
If you want Samba, use the supplied installation script:
|
||||||
|
|
||||||
👉 **see script:** `scripts/install-samba.sh`
|
👉 **See script:** `scripts/install-samba.sh`
|
||||||
|
|
||||||
This script:
|
This script will:
|
||||||
|
|
||||||
* Installs Samba
|
- Install the Samba server software
|
||||||
* Shares your mounted directories
|
- Share your mounted media directories securely
|
||||||
* Secures access to your user only (no guest access)
|
- Set up user authentication (no open guest access)
|
||||||
* Creates Samba credentials
|
- Enable Samba system services (`smbd` and `nmbd`) for automatic startup
|
||||||
* Enables the smbd/nmbd daemons
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🖥️ Windows Setup — Mapping the Network Drive
|
## Accessing Samba Shares from Windows
|
||||||
|
|
||||||
Once Samba is active, you can connect from Windows.
|
Once Samba is set up and running on your server, you can connect from your Windows computer:
|
||||||
|
|
||||||
### 1. Open File Explorer
|
|
||||||
|
|
||||||
Press:
|
|
||||||
|
|
||||||
```
|
|
||||||
Win + E
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Click **This PC**
|
|
||||||
|
|
||||||
### 3. Click **Map network drive** in the top ribbon
|
|
||||||
|
|
||||||
(If hidden, click the three-dot menu.)
|
|
||||||
|
|
||||||
### 4. Choose a drive letter
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```
|
|
||||||
Z:
|
|
||||||
```
|
|
||||||
|
|
||||||
### 5. In the folder field, enter your Samba share
|
|
||||||
|
|
||||||
|
1. Press `Win + E` to open File Explorer.
|
||||||
|
2. Click on **This PC** on the left pane.
|
||||||
|
3. Click **Map network drive** from the ribbon menu (or use the three-dot menu if it’s hidden).
|
||||||
|
4. Choose a drive letter, such as `Z:`.
|
||||||
|
5. Enter the network folder path in this format:
|
||||||
```
|
```
|
||||||
\\<server-ip>\Omnissiah-Vault
|
\\<server-ip>\Omnissiah-Vault
|
||||||
```
|
```
|
||||||
@@ -105,60 +84,38 @@ Example:
|
|||||||
```
|
```
|
||||||
\\192.168.1.50\Omnissiah-Vault
|
\\192.168.1.50\Omnissiah-Vault
|
||||||
```
|
```
|
||||||
|
6. Check **Reconnect at sign-in** to automatically mount the drive each time you log in.
|
||||||
### 6. Check **Reconnect at sign-in**
|
7. Check **Connect using different credentials** and enter the Samba username/password created during setup. For example:
|
||||||
|
|
||||||
So Windows auto-remounts the drive.
|
|
||||||
|
|
||||||
### 7. Check **Connect using different credentials**
|
|
||||||
|
|
||||||
Enter the username and password created during Samba setup:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
Username: aetos
|
Username: aetos
|
||||||
Password: <your-samba-password>
|
Password: <your-samba-password>
|
||||||
```
|
```
|
||||||
|
8. Click **Finish**. Your media drive will appear in File Explorer like any normal disk.
|
||||||
|
|
||||||
Click **Finish**.
|
You can also map it via PowerShell:
|
||||||
|
|
||||||
You should now see the drive appear in Explorer like a normal disk.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# 🧰 You Can Also Map via Command Line
|
|
||||||
|
|
||||||
Open PowerShell and run:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
net use Z: \\<server-ip>\Omnissiah-Vault /user:aetos
|
net use Z: \\<server-ip>\Omnissiah-Vault /user:aetos
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🔐 Security Notes
|
## Security Tips
|
||||||
|
|
||||||
* Samba exposes your filesystem over the network → keep your password strong.
|
- Samba shares your files over the network. Use strong passwords and never enable guest (anonymous) access unless you want an open share.
|
||||||
* Never enable `guest ok = yes` unless you want an open share.
|
- Use firewall tools (UFW, firewall-cmd) to restrict access to trusted devices only.
|
||||||
* Use UFW or firewall-cmd to restrict access if needed.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 📝 Summary
|
## Summary
|
||||||
|
|
||||||
Samba is optional but extremely convenient, especially for Windows users.
|
Samba is a handy optional addition that makes your media drive easily accessible on Windows and other devices, allowing drag-and-drop ease and manual file management.
|
||||||
|
|
||||||
Use it if:
|
Choose Samba if you:
|
||||||
|
- Want direct, seamless Windows access to media files
|
||||||
|
- Regularly manage or adjust files manually
|
||||||
|
- Prefer using network shares over command-line or Plex only
|
||||||
|
|
||||||
* You manage files manually
|
Skip installing Samba if you:
|
||||||
* You want drag-and-drop access to media
|
- Do everything through Plex or media automation apps
|
||||||
* You want Windows Explorer to treat the server like a normal drive
|
- Manage the server via Linux or macOS only
|
||||||
|
- Don’t need manual file access on other devices
|
||||||
Skip it if:
|
|
||||||
|
|
||||||
* Everything happens via automation
|
|
||||||
* You only use Plex and ARR
|
|
||||||
* You manage your server exclusively from Linux/Mac
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Proceed to the next step when ready.
|
|
||||||
|
|||||||
@@ -1,130 +1,151 @@
|
|||||||
# Overview
|
# Overview
|
||||||
|
|
||||||
This page tells the story of what will happen during the Media Manager setup: a clear, step-by-step timeline of actions, goals, and outcomes. Think of it as the "mission plan" — what we do, why we do it, and what success looks like at each stage.
|
This page lays out the clear plan for your Media Manager setup—what actions you’ll take, why each step matters, and what
|
||||||
|
success looks like along the way. Think of it as your roadmap that guides you from start to finish.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## The goal
|
## The Goal
|
||||||
|
|
||||||
We'll transform a single Linux host (example: a Raspberry Pi) into a dependable, mostly-automated media management server that:
|
We’re turning a single Linux machine (like a Raspberry Pi) into a reliable, mostly hands-off media server that:
|
||||||
|
|
||||||
* Downloads TV shows and movies automatically via qBittorrent
|
- Automatically downloads TV shows and movies using qBittorrent
|
||||||
* Uses the ARR stack (Radarr, Sonarr, Prowlarr, Bazarr) to find and manage media
|
- Uses the powerful ARR stack (Radarr, Sonarr, Prowlarr, Bazarr) to find and manage your media
|
||||||
* Organizes and moves completed downloads into a structured media library
|
- Organizes and moves finished downloads into a tidy media library
|
||||||
* Serves your media using Plex Media Server
|
- Streams your media with Plex Media Server
|
||||||
* Runs ARR services in Docker for portability and ease of upgrades
|
- Runs ARR apps inside Docker for easy updates and portability
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## High-level architecture
|
## High-Level Setup Architecture
|
||||||
|
|
||||||
* **Host OS**: Linux (Raspberry Pi OS / Ubuntu Server)
|
- **Host operating system:** Linux (e.g., Raspberry Pi OS or Ubuntu Server)
|
||||||
* **Host services**: Docker (engine) + Plex + qBittorrent (native host installs)
|
- **Host services:** Docker engine, Plex Media Server, and qBittorrent installed directly on the host
|
||||||
* **Containerized services** (docker-compose): Radarr, Sonarr, Prowlarr, Bazarr, and any auxiliary containers (e.g., file indexers, notifications)
|
- **Containerized apps:** Radarr, Sonarr, Prowlarr, Bazarr, and any additional helpers via Docker Compose
|
||||||
* **Storage layout**: downloaded files land in `/mnt/downloads`; completed and organized media live in `/mnt/media`; service configurations in `/mnt/config`
|
- **Storage layout:**
|
||||||
|
- Downloaded files go to `/mnt/omnissiah-vault/data/media-manager/downloads`
|
||||||
|
- Finished media files live in `/mnt/omnissiah-vault/data/media-manager/media`
|
||||||
|
- App configuration files live under `/mnt/omnissiah-vault/configs/<service-name>`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Step-by-step timeline (what will happen)
|
## [1) Validate Your System](overview.md)
|
||||||
|
|
||||||
Each step below explains the action, the reason, and the expected result.
|
**What we do:**
|
||||||
|
Verify your operating system, update all critical packages, and set essential system settings like hostname, timezone,
|
||||||
|
and network configuration.
|
||||||
|
|
||||||
### 1) Validate base system
|
**What you achieve:**
|
||||||
|
A stable and predictable environment with SSH access and a consistent system identity, laying the foundation for
|
||||||
**Action:** Confirm OS, update packages, set hostname, timezone, and networking.
|
everything else.
|
||||||
**Why:** Ensures reproducible behavior, correct timestamps, and easier network access.
|
|
||||||
**Result:** A stable host with SSH enabled and a predictable IP/hostname.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 2) Prepare and mount storage
|
## [2) Prepare Storage and Mount Points](setup-mount-points.md)
|
||||||
|
|
||||||
**Action:** Attach external drives (HDD/SSD or network share), create filesystems if needed, and mount them persistently (e.g., `/etc/fstab`). Create top-level folders:
|
**What we do:**
|
||||||
|
Connect and mount your external drives permanently, create organized folders for media, downloads, and configurations.
|
||||||
|
|
||||||
```
|
**What you achieve:**
|
||||||
/mnt/media
|
Reliable, durable storage locations cleanly separated from your system disk, making management, backups, and expansions
|
||||||
/mnt/downloads
|
easier.
|
||||||
/mnt/config
|
|
||||||
```
|
|
||||||
|
|
||||||
**Why:** Separates volatile system disk from large media storage and config data; makes backups and maintenance easier.
|
|
||||||
**Result:** Durable storage locations that all services will reference.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 3) Install Docker on the host
|
## [3) Install Docker](install-docker.md)
|
||||||
|
|
||||||
**Action:** Install Docker Engine and docker-compose (or use `docker compose` plugin).
|
**What we do:**
|
||||||
**Why:** ARR services are containerized for isolation, portability, and simplified updates.
|
Install Docker Engine and Docker Compose on your host system.
|
||||||
**Result:** Host ready to run docker-compose stacks.
|
|
||||||
|
**What you achieve:**
|
||||||
|
A containerized environment ready to host ARR services, optimizing portability, isolation, and simplified updates.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 4) Install Plex on the host
|
## [4) Install Plex on the Host](install-plex.md)
|
||||||
|
|
||||||
**Action:** Install Plex Media Server as a host service (native install or package). Configure initial library paths and remote access as needed.
|
**What we do:**
|
||||||
**Why:** Plex performs heavy I/O and benefits from being on the host where hardware acceleration and direct disk access are easier to configure.
|
Install Plex Media Server natively, set up initial libraries pointing to your media folders, and configure remote access
|
||||||
**Result:** Plex server visible on the network and ready to index `/mnt/media`.
|
as needed.
|
||||||
|
|
||||||
|
**What you achieve:**
|
||||||
|
A powerful media streaming service that efficiently accesses and serves your organized media.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 5) Install qBittorrent on the host
|
## [5) Install qBittorrent on the Host](install-qbittorrent.md)
|
||||||
|
|
||||||
**Action:** Install and configure qBittorrent (preferably `qbittorrent-nox` for headless use). Set download paths to `/mnt/downloads`. Configure a web UI and credentials.
|
**What we do:**
|
||||||
**Why:** Torrent client handles downloads; being on the host simplifies mounting and permissions.
|
Install the headless qBittorrent torrent client, configure it with stable download paths, and set up its web UI for easy
|
||||||
**Result:** qBittorrent runs as a service, accepting search/download requests from ARR services.
|
control.
|
||||||
|
|
||||||
|
**What you achieve:**
|
||||||
|
A fast, stable, and reliable download engine integrated with the rest of your media automation pipeline.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 6) Deploy ARR Stack via docker-compose
|
## [6) Deploy the ARR Stack via Docker Compose](setup-media-manager.md)
|
||||||
|
|
||||||
**Action:** Create a `docker-compose.yml` to run Radarr, Sonarr, Prowlarr, Bazarr (and optional services like bazarr, jackett if needed). Mount config and media/downloads into containers.
|
**What we do:**
|
||||||
**Why:** Containers give predictable runtime environments and make upgrades simple.
|
Start Radarr, Sonarr, Prowlarr, Bazarr, and any optional services in Docker containers, mounting media and config
|
||||||
**Result:** ARR services running and reachable on defined ports (e.g., `:7878` for Radarr, `:8989` for Sonarr).
|
volumes properly.
|
||||||
|
|
||||||
|
**What you achieve:**
|
||||||
|
All core media automation services running in isolated but connected containers, ready to manage your media
|
||||||
|
intelligently.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 7) Integrate ARR with qBittorrent and Plex
|
## 7) Integrate ARR with qBittorrent and Plex
|
||||||
|
|
||||||
**Action:** In Radarr/Sonarr, add qBittorrent as the download client and Plex for library updates. Configure Prowlarr as the indexer aggregator and link it to Sonarr/Radarr.
|
**What we do:**
|
||||||
**Why:** This creates an automated chain: indexers → ARR → torrent client → completed move → Plex scan.
|
Configure Radarr and Sonarr to use qBittorrent as their downloader and Plex as the media library refresher. Link
|
||||||
**Result:** A working automation pipeline where new media requests result in downloaded, organized, and indexed media.
|
Prowlarr as the indexer for search results.
|
||||||
|
|
||||||
|
**What you achieve:**
|
||||||
|
A seamless automated loop where new media gets found, downloaded, organized, and made available with minimal effort.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 8) Configure media organization and quality profiles
|
## 8) Configure Media Libraries and Quality Profiles
|
||||||
|
|
||||||
**Action:** Create library structures (Movies, TV), set naming formats, define quality profiles and root folders in Radarr and Sonarr.
|
**What we do:**
|
||||||
**Why:** Ensures consistent file naming, reduces duplicates, and keeps libraries tidy for Plex.
|
Set up consistent folder structures, naming schemes, and quality preferences in Radarr and Sonarr for Movies and TV
|
||||||
**Result:** Downloads are renamed and moved automatically into `/mnt/media/Movies` and `/mnt/media/TV`.
|
shows.
|
||||||
|
|
||||||
|
**What you achieve:**
|
||||||
|
Neatly named and organized media that Plex can easily scan and serve, improving overall media management quality.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 9) Verify and test end-to-end flow
|
## 9) Test Your Full Setup
|
||||||
|
|
||||||
**Action:** Manually request a test show or movie in Sonarr/Radarr, verify it appears in qBittorrent, completes, is moved, and shows up in Plex.
|
**What we do:**
|
||||||
**Why:** Confirms the full automation loop works and surfaces permission or path issues.
|
Manually add a test movie or episode, verify it downloads through qBittorrent, is organized by Radarr/Sonarr, and
|
||||||
**Result:** Confirmed working pipeline.
|
appears in Plex.
|
||||||
|
|
||||||
|
**What you achieve:**
|
||||||
|
Confidence that every part of your automation workflow works smoothly without permission or path issues.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 10) Backup, maintenance, and monitoring
|
## 10) Backup and Maintain
|
||||||
|
|
||||||
**Action:** Implement config backups (snapshot `/mnt/config`), schedule regular system updates, and optionally add monitoring (Prometheus/Grafana or simple scripts).
|
**What we do:**
|
||||||
**Why:** Protects against data loss and keeps services healthy.
|
Implement regular backups of configuration data, keep the system and Docker updated, and optionally add monitoring tools
|
||||||
**Result:** Resilient installation with a recovery plan.
|
to keep watch on your media server.
|
||||||
|
|
||||||
|
**What you achieve:**
|
||||||
|
A reliable and maintainable Media Manager system that withstands unforeseen issues and keeps running smoothly.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Success Criteria — How you’ll know it’s working
|
Feel free to follow the linked steps for detailed, easy-to-understand guides. Each part builds on the previous to get
|
||||||
|
you from a fresh Linux install to a fully automated media powerhouse.
|
||||||
|
|
||||||
* You can add a movie/show to Radarr/Sonarr and see it downloaded automatically.
|
## Ready to begin?
|
||||||
* Downloaded files are renamed and relocated to `/mnt/media`.
|
|
||||||
* Plex detects new content and makes it available for streaming.
|
Move on to the **Setup Mount Points** step to prepare your storage structure and permissions
|
||||||
* Services restart correctly after a reboot and maintain configuration.
|
Go to 👉 **[Setup Mount Points](setup-mount-points.md)**
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Next steps
|
|
||||||
|
|
||||||
Proceed to the **Setup Mount Points** step to prepare storage paths and permissions: `steps/setup-mount-points.md`.
|
|
||||||
|
|||||||
@@ -1,268 +1,160 @@
|
|||||||
# ARR Stack Overview and Service Architecture
|
# ARR Stack Overview and Service Architecture
|
||||||
|
|
||||||
This section explains all the applications included in your Media Manager stack, what each one does, how they interact with each other, and how the storage mount points are shared across services.
|
This section walks you through all the key applications in your Media Manager stack, explaining what each one does, how
|
||||||
|
they work together, and how they share storage space.
|
||||||
|
|
||||||
The stack is deployed using a **Docker Compose file**. Instead of pasting the compose inline here, it is referenced directly:
|
Your entire media automation system is deployed with Docker Compose, a tool that manages multiple containers at once.
|
||||||
|
Instead of pasting the configuration here, just know it's referenced in the main `docker-compose.yml` file.
|
||||||
👉 **See the Docker Compose configuration:** `docker-compose.yml`
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🌐 The ARR Ecosystem — What Each App Does
|
## 🌐 The ARR Ecosystem — What Each App Does
|
||||||
|
|
||||||
Your media automation pipeline consists of several specialized services. Each one has a dedicated role, and together they form a complete end‑to‑end system.
|
Think of your media setup as a team of specialists, each with a clear role. Together, they automate finding,
|
||||||
|
downloading, organizing, and streaming your media smoothly.
|
||||||
Below is a clear breakdown.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🧭 Prowlarr — The Indexer Aggregator
|
### 🧭 Prowlarr — The Indexer Aggregator
|
||||||
|
|
||||||
Prowlarr acts as the central hub for all indexers (public, private, torrent, NZB).
|
Prowlarr is the brain behind finding new media. It connects to many torrent and NZB indexers (sites listing available
|
||||||
|
movies and shows) and collects results from them.
|
||||||
|
|
||||||
**Responsibilities:**
|
- It sends these results to Radarr and Sonarr so they know about new movies or episodes.
|
||||||
|
- It keeps all your indexers synced in one place, saving you from having to set them up repeatedly.
|
||||||
* Connects to multiple indexers
|
|
||||||
* Provides unified indexer results to Radarr & Sonarr
|
|
||||||
* Manages API keys, categories, indexer syncing
|
|
||||||
|
|
||||||
**Why it’s important:**
|
|
||||||
Without Prowlarr, you would configure indexers separately in each application — a massive duplication of work.
|
|
||||||
|
|
||||||
**How it talks to others:**
|
|
||||||
|
|
||||||
* Sends torrent results → Radarr/Sonarr
|
|
||||||
* Receives indexer categories from them
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🎬 Radarr — Automated Movie Management
|
### 🎬 Radarr — Automated Movie Management
|
||||||
|
|
||||||
Radarr handles **movie** automation.
|
Radarr handles your movie collection.
|
||||||
|
|
||||||
**Responsibilities:**
|
- It tracks movie releases and tells qBittorrent what to download.
|
||||||
|
- After the download finishes, Radarr renames, organizes, and moves the movie files to your library folder.
|
||||||
* Monitor movie requests
|
- It also notifies Plex so your library stays updated.
|
||||||
* Fetch releases from indexers via Prowlarr
|
|
||||||
* Trigger downloads via qBittorrent
|
|
||||||
* Rename, sort, and move completed files into the Movies directory
|
|
||||||
* Update Plex libraries
|
|
||||||
|
|
||||||
**How it talks to others:**
|
|
||||||
|
|
||||||
* Index results from Prowlarr
|
|
||||||
* Sends download requests to qBittorrent
|
|
||||||
* Notifies Plex to refresh libraries
|
|
||||||
* Provides subtitles to Bazarr (optional)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📺 Sonarr — Automated TV Show Management
|
### 📺 Sonarr — Automated TV Show Management
|
||||||
|
|
||||||
Sonarr is the TV equivalent of Radarr.
|
Sonarr does essentially the same job as Radarr, but for TV shows.
|
||||||
|
|
||||||
**Responsibilities:**
|
- Monitors episodes (current and upcoming) and fetches via qBittorrent.
|
||||||
|
- Handles organizing episodes and renaming files consistently.
|
||||||
* Track TV episodes (past and future)
|
- Updates Plex similar to Radarr.
|
||||||
* Upgrade quality automatically
|
|
||||||
* Send downloads to qBittorrent
|
|
||||||
* Rename and organize episodes
|
|
||||||
|
|
||||||
**How it talks to others:**
|
|
||||||
|
|
||||||
* Index results from Prowlarr
|
|
||||||
* Send downloads to qBittorrent
|
|
||||||
* Sync subtitle requests with Bazarr
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 💬 Bazarr — Subtitle Management Service
|
### 💬 Bazarr — Subtitle Management Service
|
||||||
|
|
||||||
Bazarr automatically finds and downloads subtitles.
|
Bazarr works alongside Radarr and Sonarr to handle subtitles.
|
||||||
|
|
||||||
**Responsibilities:**
|
- Automatically searches for subtitles in the languages you want.
|
||||||
|
- Saves these subtitle files right next to your media, so Plex and your devices can use them seamlessly.
|
||||||
* Sync with Radarr and Sonarr
|
|
||||||
* Fetch subtitles in desired languages
|
|
||||||
* Store subtitles next to their respective media files
|
|
||||||
|
|
||||||
**How it talks to others:**
|
|
||||||
|
|
||||||
* Reads Radarr/Sonarr libraries
|
|
||||||
* Writes subtitle files directly inside `/data/media/...`
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🎟️ Jellyseerr — Request Management Portal
|
### 🎟️ Jellyseerr — User Request Portal
|
||||||
|
|
||||||
Jellyseerr is the user-facing request dashboard.
|
Jellyseerr provides a friendly interface where users can request movies or TV shows.
|
||||||
|
|
||||||
**Responsibilities:**
|
- Requests get automatically passed to Radarr or Sonarr.
|
||||||
|
- Useful if multiple people want to manage requests easily.
|
||||||
* Users request movies or shows
|
- Integrates with Plex to show what’s available.
|
||||||
* Requests are forwarded automatically to Radarr/Sonarr
|
|
||||||
* Designed for multi-user setups
|
|
||||||
|
|
||||||
**How it talks to others:**
|
|
||||||
|
|
||||||
* Communicates with Radarr/Sonarr via API
|
|
||||||
* Shows availability status using Plex integration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📨 Ombi — Alternative Request Management
|
### 📨 Ombi — Alternative Request Management
|
||||||
|
|
||||||
Ombi is similar to Jellyseerr, with some different UI and features.
|
Ombi offers similar features to Jellyseerr but with a different look and some unique options.
|
||||||
|
|
||||||
**Responsibilities:**
|
- You can choose either or even run both if you want.
|
||||||
|
|
||||||
* Allows users to request media
|
|
||||||
* Integrates with Radarr and Sonarr
|
|
||||||
* Sends notifications
|
|
||||||
|
|
||||||
Some prefer Jellyseerr, others prefer Ombi — you can run both.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🧱 How These Services Are Connected
|
## 🧱 How These Services Connect
|
||||||
|
|
||||||
### Central Flow Diagram (conceptual)
|
Here’s a simple flow to understand their interaction:
|
||||||
|
|
||||||
```
|
User Requests (via Jellyseerr/Ombi)
|
||||||
Jellyseerr/Ombi → Radarr/Sonarr ← Prowlarr
|
|
||||||
↓
|
↓
|
||||||
qBittorrent (host)
|
Radarr & Sonarr
|
||||||
↓
|
↓
|
||||||
Organized media library
|
Prowlarr provides index results
|
||||||
↓
|
↓
|
||||||
Plex
|
qBittorrent (host) downloads files
|
||||||
↓
|
↓
|
||||||
Clients
|
Organized media library (on shared storage)
|
||||||
```
|
↓
|
||||||
|
Plex streams content
|
||||||
|
↓
|
||||||
|
Clients (your devices)
|
||||||
|
|
||||||
### Key Points:
|
- Prowlarr feeds torrent information to Radarr and Sonarr.
|
||||||
|
- Radarr and Sonarr initiate downloads in qBittorrent running on your host.
|
||||||
* **Prowlarr provides indexer data** to both Radarr and Sonarr
|
- qBittorrent saves the media to storage mounted by all services.
|
||||||
* **Radarr/Sonarr send download requests** to qBittorrent (host)
|
- Radarr and Sonarr rename and organize media as it completes.
|
||||||
* **qBittorrent stores downloads** into the shared mounted folders
|
- Plex scans the media folders to show up-to-date content.
|
||||||
* **Radarr/Sonarr import, rename, and move** completed media into `/data/media/...`
|
- Bazarr adds subtitles automatically to the media files.
|
||||||
* **Plex sees updated libraries** and refreshes
|
|
||||||
* **Bazarr fetches subtitles** and writes them next to the media
|
|
||||||
|
|
||||||
All Docker apps talk to host apps using:
|
|
||||||
|
|
||||||
```
|
|
||||||
host.docker.internal:host-gateway
|
|
||||||
```
|
|
||||||
|
|
||||||
This ensures containers can reach qBittorrent and Plex.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🗄️ Volume Mount Strategy
|
## 🗄️ Shared Storage and Docker Volumes
|
||||||
|
|
||||||
All apps share a **standardized mount point** inside containers:
|
To keep things tidy and avoid confusion, all Docker services use the same folder structure inside their containers under
|
||||||
|
`/data`. This path points to your real media folders on the host, typically `/mnt/omnissiah-vault/data/media-manager`.
|
||||||
|
|
||||||
```
|
Each service also stores its settings (config files) in their own dedicated folders on the external drive, persisting
|
||||||
/data
|
beyond container restarts:
|
||||||
```
|
|
||||||
|
|
||||||
Outside the container, this maps to:
|
| Service | Config Path on Host | Mounted To in Container |
|
||||||
|
|------------|-------------------------------------------|-------------------------|
|
||||||
|
| Radarr | `/mnt/omnissiah-vault/configs/radarr` | `/config` |
|
||||||
|
| Sonarr | `/mnt/omnissiah-vault/configs/sonarr` | `/config` |
|
||||||
|
| Prowlarr | `/mnt/omnissiah-vault/configs/prowlarr` | `/config` |
|
||||||
|
| Bazarr | `/mnt/omnissiah-vault/configs/bazarr` | `/config` |
|
||||||
|
| Jellyseerr | `/mnt/omnissiah-vault/configs/jellyseerr` | `/app/config` |
|
||||||
|
| Ombi | `/mnt/omnissiah-vault/configs/ombi` | `/config` |
|
||||||
|
|
||||||
```
|
This organization keeps your media and service configurations cleanly separated and easy to backup or migrate.
|
||||||
/mnt/omnissiah-vault/data/media-manager
|
|
||||||
```
|
|
||||||
|
|
||||||
This ensures:
|
|
||||||
|
|
||||||
* Radarr, Sonarr, Bazarr all see the **same folder structure**
|
|
||||||
* No path translation issues between apps
|
|
||||||
* Clean docker-compose configuration
|
|
||||||
|
|
||||||
### Example Inside Containers
|
|
||||||
|
|
||||||
```
|
|
||||||
/data/media/movies
|
|
||||||
/data/media/tv
|
|
||||||
/data/downloads
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🗂️ Config Directory Mounts
|
## 🔧 Docker Networking
|
||||||
|
|
||||||
Each service stores its settings inside Docker volumes mapped to persistent directories.
|
All ARR stack containers are connected on a private Docker network called `media-net`. This network allows them to talk
|
||||||
|
to each other internally, without exposing all services to your regular home network. For host-based services like
|
||||||
### Radarr
|
qBittorrent and Plex, container apps reach them via special host addresses.
|
||||||
|
|
||||||
```
|
|
||||||
/mnt/omnissiah-vault/configs/radarr → /config
|
|
||||||
```
|
|
||||||
|
|
||||||
### Sonarr
|
|
||||||
|
|
||||||
```
|
|
||||||
/mnt/omnissiah-vault/configs/sonarr → /config
|
|
||||||
```
|
|
||||||
|
|
||||||
### Prowlarr
|
|
||||||
|
|
||||||
```
|
|
||||||
/mnt/omnissiah-vault/configs/prowlarr → /config
|
|
||||||
```
|
|
||||||
|
|
||||||
### Bazarr
|
|
||||||
|
|
||||||
```
|
|
||||||
/mnt/omnissiah-vault/configs/bazarr → /config
|
|
||||||
```
|
|
||||||
|
|
||||||
### Jellyseerr
|
|
||||||
|
|
||||||
```
|
|
||||||
/mnt/omnissiah-vault/configs/jellyseerr → /app/config
|
|
||||||
```
|
|
||||||
|
|
||||||
### Ombi
|
|
||||||
|
|
||||||
```
|
|
||||||
/mnt/omnissiah-vault/configs/ombi → /config
|
|
||||||
```
|
|
||||||
|
|
||||||
All containers get persistent configuration that survives updates.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🔧 Docker Networking
|
## 🚀 Summary
|
||||||
|
|
||||||
All ARR services join the same Docker network:
|
Your Media Manager ARR stack is a carefully connected set of services:
|
||||||
|
|
||||||
```
|
- **Prowlarr** centralizes media indexers.
|
||||||
media-net
|
- **Radarr and Sonarr** manage movies and TV shows, respectively.
|
||||||
```
|
- **qBittorrent** on your host downloads the media files.
|
||||||
|
- **Bazarr** provides subtitles automatically.
|
||||||
|
- **Jellyseerr or Ombi** lets users request new content.
|
||||||
|
- **Plex** streams your organized media to your devices.
|
||||||
|
|
||||||
This provides:
|
They share data neatly through a standardized storage path and communicate over a private Docker network for smooth
|
||||||
|
operation.
|
||||||
* Internal communication
|
|
||||||
* Isolated service space
|
|
||||||
* Avoids exposing containers unintentionally
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🚀 Summary
|
## Optional: Accessing Your Media via Samba Network Share
|
||||||
|
|
||||||
Your ARR stack consists of:
|
If you want to access your external HDD directly from other devices on your network—like Windows PCs, Macs, or mobile
|
||||||
|
devices—you can set up Samba. Samba allows you to share your media folders as network drives, making it easy to browse,
|
||||||
|
add, or manage files without logging into your server.
|
||||||
|
|
||||||
* **Prowlarr** for indexers
|
This is especially useful if you prefer managing files directly or want seamless integration with devices that don’t
|
||||||
* **Sonarr** for TV
|
support network streaming apps.
|
||||||
* **Radarr** for movies
|
|
||||||
* **Bazarr** for subtitles
|
|
||||||
* **Jellyseerr or Ombi** for request management
|
|
||||||
|
|
||||||
They connect using APIs, communicate through a private Docker network, and share a unified `/data` folder that maps to your mounted storage.
|
You can find the step-by-step Samba installation and configuration instructions here:
|
||||||
|
Go to👉 **[Install Samba](install-samba.md)**
|
||||||
This architecture keeps everything predictable, reproducible, and easy to maintain.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Next: Proceed to configure each service inside their Web UIs.
|
|
||||||
|
|||||||
@@ -1,19 +1,21 @@
|
|||||||
# Understanding Mounting, File Systems, and Choosing Between EXT4 vs NTFS
|
# Understanding Mounting, File Systems, and Choosing Between EXT4 vs NTFS
|
||||||
|
|
||||||
Before we bind our drives and awaken the Machine Spirits, it’s important to understand **what mounting is**, **what file systems are**, and **why we choose EXT4 or NTFS** depending on how the drive will be used.
|
Before we connect our drives and get everything ready, it’s important to understand **what mounting is**, **what a file
|
||||||
|
system is**, and **why we choose either EXT4 or NTFS** depending on how you'll use your storage.
|
||||||
|
|
||||||
This page explains everything in simple terms so beginners can follow confidently.
|
This page explains these concepts in simple terms so beginners can follow with confidence.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🧩 What Does “Mounting” Mean?
|
## 🧩 What Does “Mounting” Mean?
|
||||||
|
|
||||||
On Linux, storage devices like HDDs, SSDs, or USB drives **do not automatically appear as folders**.
|
On Linux, storage devices like HDDs, SSDs, or USB drives **don’t automatically appear as folders** when plugged in.
|
||||||
Instead, the operating system must *mount* them — meaning:
|
Instead, the operating system *attaches* or *mounts* them to a folder—meaning:
|
||||||
|
|
||||||
### **Mounting = attaching a physical drive to a folder on the filesystem.**
|
### **Mounting = attaching a drive to a folder in the filesystem**
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
```
|
```
|
||||||
Device: /dev/sda1
|
Device: /dev/sda1
|
||||||
Mounted at: /mnt/omnissiah-vault
|
Mounted at: /mnt/omnissiah-vault
|
||||||
@@ -21,31 +23,31 @@ Mounted at: /mnt/omnissiah-vault
|
|||||||
|
|
||||||
Once mounted:
|
Once mounted:
|
||||||
|
|
||||||
- The drive becomes accessible through that folder
|
- The drive is accessible through that folder path
|
||||||
- Applications can read/write files there
|
- Applications can read/write files there
|
||||||
- You can organize media, downloads, and configuration data
|
- You can organize your media, downloads, and settings
|
||||||
|
|
||||||
If the drive is *not mounted*, nothing can access it—even if Linux sees the hardware.
|
If the drive isn’t mounted, Linux can see the hardware but won’t be able to access the data stored on it.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📘 Why We Use `/mnt/…`
|
## 📘 Why We Use `/mnt/…`
|
||||||
|
|
||||||
Linux keeps the system organized using conventions:
|
Linux organizes storage under specific folders:
|
||||||
|
|
||||||
| Path | Purpose |
|
| Path | Purpose |
|
||||||
|------|---------|
|
|---------|-------------------------------------|
|
||||||
| `/home` | User home folders |
|
| `/home` | User’s personal files |
|
||||||
| `/root` | Root account home |
|
| `/root` | Root user’s files |
|
||||||
| `/etc` | System configuration |
|
| `/etc` | System configuration files |
|
||||||
| `/mnt` | Drives mounted by the user/admin |
|
| `/mnt` | External drives mounted by the user |
|
||||||
|
|
||||||
|
We typically mount drives in `/mnt` to keep things organized, for example:
|
||||||
|
|
||||||
We follow the Linux standard by mounting drives under:
|
|
||||||
```
|
```
|
||||||
/mnt/omnissiah-vault
|
/mnt/omnissiah-vault
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
This makes it clear that the drive is external storage, not part of the system root.
|
This makes it clear that the drive is external storage, not part of the system root.
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -70,7 +72,7 @@ Two major file systems matter for media management:
|
|||||||
Below is a simple, clear comparison.
|
Below is a simple, clear comparison.
|
||||||
|
|
||||||
| Feature | EXT4 (Linux Native) | NTFS (Windows Native) |
|
| Feature | EXT4 (Linux Native) | NTFS (Windows Native) |
|
||||||
|--------|----------------------|------------------------|
|
|-------------------------------------------|-------------------------|------------------------------------|
|
||||||
| Best OS support | Linux | Windows |
|
| Best OS support | Linux | Windows |
|
||||||
| Performance on Linux | ⭐⭐⭐⭐ Fast | ⭐ Slow (requires NTFS-3G driver) |
|
| Performance on Linux | ⭐⭐⭐⭐ Fast | ⭐ Slow (requires NTFS-3G driver) |
|
||||||
| Supports Linux permissions (chmod, chown) | ✔ Yes | ❌ No (emulated) |
|
| Supports Linux permissions (chmod, chown) | ✔ Yes | ❌ No (emulated) |
|
||||||
@@ -81,6 +83,7 @@ Below is a simple, clear comparison.
|
|||||||
| Ideal use case | Permanent Linux storage | External drive shared with Windows |
|
| Ideal use case | Permanent Linux storage | External drive shared with Windows |
|
||||||
|
|
||||||
### ✔ **Choose EXT4 if the drive stays connected to your Raspberry Pi/Linux system.**
|
### ✔ **Choose EXT4 if the drive stays connected to your Raspberry Pi/Linux system.**
|
||||||
|
|
||||||
This is the recommended choice for **media servers**, **Plex**, and **qBittorrent** because:
|
This is the recommended choice for **media servers**, **Plex**, and **qBittorrent** because:
|
||||||
|
|
||||||
- It’s faster
|
- It’s faster
|
||||||
@@ -99,6 +102,7 @@ For example:
|
|||||||
---
|
---
|
||||||
|
|
||||||
## 🪟 Accessing an EXT4 Drive on Windows?
|
## 🪟 Accessing an EXT4 Drive on Windows?
|
||||||
|
|
||||||
EXT4 cannot be read by Windows *natively*.
|
EXT4 cannot be read by Windows *natively*.
|
||||||
|
|
||||||
However, **this is not a problem**, because:
|
However, **this is not a problem**, because:
|
||||||
@@ -117,6 +121,7 @@ We will configure Samba later in an optional section:
|
|||||||
---
|
---
|
||||||
|
|
||||||
## 📥 Choose Your Mounting Ritual
|
## 📥 Choose Your Mounting Ritual
|
||||||
|
|
||||||
Below are two scripts — pick one based on your file system choice.
|
Below are two scripts — pick one based on your file system choice.
|
||||||
|
|
||||||
### 🟦 EXT4 Mounting Ritual (Recommended)
|
### 🟦 EXT4 Mounting Ritual (Recommended)
|
||||||
@@ -148,9 +153,7 @@ Once you choose your file system and run the ritual script:
|
|||||||
|
|
||||||
## Next steps
|
## Next steps
|
||||||
|
|
||||||
Proceed to the **Setup Mount Points** step to prepare storage paths and permissions: `steps/setup-mount-points.md`.
|
Proceed to the **Install Docker** step to prepare docker for media management.
|
||||||
|
Go to 👉 **[Install Docker](install-docker.md)**
|
||||||
👉 **Install Docker**
|
|
||||||
with all your directory paths standardized and ready for the media automation pipeline.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
Reference in New Issue
Block a user