🏴‍☠️ Enjoyin' the spoils? Drop us a ⭐️ an' let the whole crew know about this fine treasure!

─── ⛧ ───

☠️ Questions or cursed code? Cross the Styx — Enter 🔥HADES🔥.

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 safe from pryin' eyes—tucked away like treasure on a deserted isle! 🏝️

In a rush to set sail? Here's all ye need:

git clone --recurse-submodules [email protected]:scottgigawatt/plundarr.git
cd plundarr
cp example.env .env
vim .env  # Adjust yer settings
make up   # Hoist the stack!

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 [email protected]: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:

• 🏴‍☠️ Peek at the Pirate's Env Code

The Docker Project Setup parchment covers:

• 🌍🔧 Configuring Docker Networking
• 🖥️🔧 Synology Configuration
  • 🔥🛡️ Updating Firewall Settings
  • 📦🚀 Deploying With Container Manager

Mind these steps, lest ye be marooned on a deserted isle! 🏝️

🏴‍☠️ 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.

• 🦜 Peruse the tun.sh Parchment
• 🗺️ Chart the Boot-Up Course

To keep yer containers from stumblin' outta their hammocks in the wrong order 🛏️➡️🪝, study the scrolls below like a map to buried booty 🗺️💰☠️, yarrr!

• ⚙️ Inspect the compose_restart.sh Scroll
• ⏱️ Schedule the Crew with Task Scheduler

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 host IPs...
VPN is active. Container IP: 172.16.88.88 (Tortuga, Rum Islands XP), Host IP: 10.42.42.42 (Port Royal, Skull Coast XP).

make build

The Makefile be yer trusty first mate fer handlin' this project with ease. It's packed with handy commands to hoist the stack, drop anchor, chart logs, test yer VPN tunnels, and swab the decks.

Run make help to spy the full treasure map of commands. Let automation be the wind in yer sails—don't get marooned in manual seas.

❯ 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 a local image of the privateerr service for use when it cannot be pulled from GHCR.
  up              - (Re)creates and starts containers for services.
  build-up        - Alias for build, up.
  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.

Dig deeper in the Cap'n's Makefile:

• 🔎 Scour the Buildin' Blueprint

Plundarr has been tested on Synology DS1522+ and DS916+ runnin' DSM 7.2. But fear not, me hearties—this treasure ain't just fer Synology! She oughta run smooth on other shores like macOS, Linux, an' any land where Docker sails free.

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.

               |    |    |
              )_)  )_)  )_)
             )___))___))___)\
            )____)____)_____)\\
         _____|____|____|____\\\__
  ~~ ~~  \_______________________/  ~~ ~~
  ~  ~   ~~~ ~~~~~ ~~~~~ ~~~ ~~~   ~  ~~
      ~   ~   ~  ~~~  ~~~~ ~  ~~   ~ ~

       🏴‍☠️  The Plunderer's Docker Fleet ☠️⚓️
       "Code ho! Containers below deck!"

Contribute or provide feedback to improve Plundarr. Arrr, happy sailing! 🏴‍☠️