Ahoy, mateys! Welcome to Plundarr, the ultimate Docker Compose setup for all ye media needs. Manage yer favorite 'arr' apps and PIA VPN connections with ease, all while sailin' the high seas of secure and automated media management. ⚓️
Plundarr be a collection of Docker Compose configurations to run a shipshape array of 'arr' tools like Sonarr, Radarr, and more, all securely navigated through Private Internet Access with WireGuard, managed by Gluetun. Avast, set sail on the digital seas with yer media ship well-equipped! 🏴☠️
| Shipmate | What It Be | Yo Ho Ho and More Info |
|---|---|---|
| Privateerr | 🏴☠️ Arrr, generate yer WireGuard config files fer PIA VPN connections! Protect yer precious booty with the finest VPN on the seven seas. | More info |
| Gluetun | 🌊 Batten down the hatches! Secure yer VPN route with WireGuard or OpenVPN, keepin' yer online doin's hidden from pryin' landlubber eyes. | More info |
| FlareSolverr | 🔥 Outsmart them scurvy web defenses and keep yer plunderin' smooth as a fine barrel o' rum. | More info |
| Prowlarr | 🐾 The savvy first mate fer wranglin' all yer indexers, keepin' yer treasure map up-to-date with the latest and greatest booty. | More info |
| qBittorrent | 🌊 Yer trusty first mate fer torrentin', hoist the colors and download with the might of a thousand cannons. | More info |
| Radarr | 🎥 Chart yer course fer cinematic riches! Automatically plunder new films and keep yer ship's library filled to the brim. | More info |
| Sonarr | 📺 Set sail on the seas of TV shows! Fetch new episodes and keep yer watchlist shipshape and Bristol fashion. | More info |
| Bazarr | 🦜 The parrot on yer shoulder squawkin' subtitles in many tongues fer all yer movies and TV shows. | More info |
| Readarr | 📚 The captain's log fer yer ebooks. Keep yer digital library well-organized and as neat as a pin. | More info |
| Overseerr | ⚓️ The quartermaster fer handlin' all yer crew's media requests, keepin' the ship runnin' smooth and the crew satisfied. | More info |
| Speedtest Tracker | ⚡️ Keep a log of yer internet speed to make sure yer ISP ain't sellin' ye snake oil. Monitor yer connection and track yer speeds over time. | More info |
| Duplicati | 💣 Guard yer precious booty with backups, lest the kraken strike and sink yer ship. | More info |
| Homepage | 🏠 The captain's command deck fer all yer apps! A fully customizable, static dashboard fer keepin' tabs on all yer ship's systems. | More info |
Manage Docker configuration environment variables in the .env file. Override these variables easily on the command line when startin' the Docker Compose stack. Before ye begin, copy the example environment configuration file and update it to suit yer needs:
# Hoist the Jolly Roger and clone the repository with submodules
git clone --recurse-submodules git@github.com:scottgigawatt/plundarr.git
cd plundarr
# Copy the example environment file
cp example.env .env
# Open .env file and adjust the values to yer requirementsSee the Docker Compose IPAM documentation fer more information on configurin' the followin' IP address information fer the compose stack. Ye can plunder the example config straight from the Docker Compose scrolls!
#
# Chart the usable IP waters for this here subnet: 172.28.0.1 - 172.28.255.254
# Total number of scallywag hosts: 65,536
# Number of seaworthy hosts: 65,534
# Subnet mask (or should I say, pirate's mask): 255.255.0.0
#
COMPOSE_NETWORK_SUBNET="${COMPOSE_NETWORK_SUBNET:-172.28.0.0/16}"
#
# Plot the IP course for the containers: 172.28.5.1 - 172.28.5.254
# Total number of seadogs: 256
# Number of usable scurvy dogs: 254
# Subnet mask: 255.255.255.0 (aye, the smallest o' the masks)
#
COMPOSE_NETWORK_IP_RANGE="${COMPOSE_NETWORK_IP_RANGE:-172.28.5.0/24}"
#
# Set sail with the network gateway at the last IP address, the final port o' call
#
COMPOSE_NETWORK_GATEWAY="${COMPOSE_NETWORK_GATEWAY:-172.28.5.254}"To bring this booty into DSM 7.2 Container Manager's Project feature, follow these steps, ye sea dogs:
- SSH into yer Synology system.
- Recursively clone this repository with submodules, e.g., to
/volume1/docker/plundarr. - In Container Manager, click Project then Create.
- Provide a title, e.g., plundarr.
- Set the path to the cloned repository.
- Navigate through the UI prompts t' finish creatin' the project.
Check out the official Synology documentation here fer more on Container Manager Projects. Yo ho ho!
To make sure the /dev/net/tun device be present on Synology Disk Station for use with VPN applications like Gluetun, follow these steps, me hearties:
-
Setup Task Scheduler on Synology NAS:
Open Synology's Control Panel and follow these steps to run the script on boot:
-
Go to Task Scheduler 🗓️.
-
Click Create -> Triggered Task -> User-defined script ✍️.
-
Give the task a name, e.g., 'Create Tunnel' 🌉.
-
Set the user to
root🧙. -
Set the event to Boot-up 🚀.
-
Check Enabled ✅.
-
Under Task Settings, enter the following command under Run command 💻:
bash /volume1/docker/plundarr/scripts/tun.sh
-
Click OK to save the task 💾.
-
This ensures that the /dev/net/tun device be available whenever yer Synology NAS boots up, so ye can sail the seas with yer VPN secure and sound. Arrr! 🏴☠️
For more details, see the script here 📜.
The plundarr repo be providin' ye with tools t' view an' manage the environment an' Docker Compose configuration details. While the configuration files be heavily documented t' assist with understandin' an' customization, some o' ye may prefer t' see the uncommented versions fer simplicity.
The included Makefile contains targets t' help ye navigate these treacherous waters. Usin' these commands will provide ye with a clearer view o' the environment an' configuration details without the additional comments. Set sail with confidence, ye scurvy dogs! 🏴☠️
❯ make help
Usage: make [TARGET]
Targets:
all - Builds and starts the service stack.
build-depends - Ensures build dependencies are installed.
stop - Stops running containers without removing them.
down - Stops and removes containers.
clean - Stops and removes containers, networks, volumes, and images.
build - Builds the service stack.
up - Builds, (re)creates, and starts containers for services.
start - Starts existing containers for a service.
test-vpn - Obtain the VPN IP address and ensure the connection is working.
config - Renders the actual data model to be applied on the Docker Engine.
env - Prints the evaluated docker compose default env configuration.
print-config - Print the raw uncommented docker compose yaml configuration.
print-env - Print the raw uncommented docker compose env configuration.
logs - Shows logs for the service.
open - Opens the service site in the default web browser.
run - Alias for up, open, logs.
help - Displays this help message.Plundarr has been tested on Synology DS916+ running DSM 7.2.1-69057 Update 5. But fear not, me hearties! It should work on other lands as well.
This project be licensed under the Apache 2 License - see the LICENSE scroll for details.
The PIA manual connection scripts used in this repository be licensed under the MIT license, buried here.
Contribute or provide feedback to improve Plundarr. Arrr, happy sailing! 🏴☠️