Plundarr
Plunder your favorite shows and movies 🎬🏴☠️ — Docker Compose + PIA WireGuard VPN to keep the Royal Navy off yer tail! 🚢🔒
Install / Use
/learn @scottgigawatt/PlundarrREADME
Plundarr 🏴☠️
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. ⚓️
Captain's Log 📜
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 safe from pryin' eyes—tucked away like treasure on a deserted isle! 🏝️
⚡️ Quick Start
In a rush to set sail? Here's all ye need:
git clone --recurse-submodules git@github.com:scottgigawatt/plundarr.git
cd plundarr
cp example.env .env
vim .env # Adjust yer settings
make up # Hoist the stack!
[!TIP] Run
make helpto spy 🔎 all the commands at yer disposal.
Treasure Map 🗺️
| 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~~ | ❌ Scuttled, matey—she sails no more. Hoist 📚 Calibre Web Automated fer smooth e-book plunderin'. | Set Sail ⚓ | | Overseerr | ⚓️ The quartermaster fer handlin' all yer crew's media requests, keepin' the ship runnin' smooth and the crew satisfied. | More info | | Cleanuparr | 🧹 The swabbie keepin' yer ship clean by removin' blocked or unwanted downloads from Sonarr, Radarr, and yer download mates like qBittorrent. | 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 |
Hoist the Sails ⚓️
[!IMPORTANT] 🏴☠️ Before settin' sail, copy
example.envto.envand tweak it to yer own pirate code.
Manage Docker configuration environment variables in the .env file. Override these variables easily on the command line when startin' the Docker Compose stack:
# 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 requirements
vim .env
For more details, see the example environment configuration here:
📜 Important Setup Scroll! ☠️
[!WARNING] ⚓️ Before hoistin' the sails, make sure to scour the Docker Project Setup scroll! It charts the course fer proper Docker networkin', Synology tweaks, firewall rules, and launchin' with Container Manager. Missin' these steps might leave yer ship dead in the water!
The Docker Project Setup parchment covers:
Mind these steps, lest ye be marooned on a deserted isle! 🏝️
Prep the Ship at Boot: Tunnels & Containers 🏴☠️⚙️
[!CAUTION] ⚓️ Without the
/dev/net/tundevice, yer VPN ship be sinkin' at the docks! Make sure it be ready at boot, or face the kraken.
🏴☠️ Fer makin' sure /dev/net/tun be ready when yer Synology be wakin' from slumber, chart a course to the tun.sh scroll in the scripts hold an' follow the setup guide thar.
[!TIP] 🧰 And if ye run into mutiny where yer containers don't hoist in proper order on reboot, call upon the
compose_restart.shscroll! This script tears down an' rebuilds yer Docker fleet clean and proper, ensurin' each ship sets sail in the right sequence after a stormy system reboot.
To keep yer containers from stumblin' outta their hammocks in the wrong order 🛏️➡️🪝, study the scrolls below like a map to buried booty 🗺️💰☠️, yarrr!
🔎 Spyglass Check
To confirm yer VPN sails be catchin' wind:
❯ make test-vpn
sh scripts/test_vpn.sh
Running VPN container test...
Step 1: Running Docker container with VPN network:
docker run --rm --network=container:gluetun-latest alpine:latest sh -c 'apk add --no-cache wget >/dev/null 2>&1 && wget -qO- https://ipinfo.io'
Step 2: Received container response:
{
"ip": "172.16.88.88",
"city": "Tortuga",
"region": "Rum Islands",
"country": "XP",
"loc": "21.4200,-71.1419",
"org": "AS7777 The Jolly Rogers",
"postal": "00000",
"timezone": "Ocean/HighSeas",
"readme": "https://ipinfo.io/missingauth"
}
Step 3: Getting host IP info from ipinfo.io...
Step 4: Received host response:
{
"ip": "10.42.42.42",
"hostname": "flagship.plundarr.local",
"city": "Port Royal",
"region": "Skull Coast",
"country": "XP",
"loc": "17.9355,-76.8419",
"org": "AS1492 Blackbeard’s Backbone Ltd.",
"postal": "99999",
"timezone": "Ocean/SkullBay",
"readme": "https://ipinfo.io/missingauth"
}
Step 5: Comparing container and
