Skip to content

Commit b638428

Browse files
scottgigawattscottgigawatt
committed
🏴‍☠️ Updated the treasure maps: adjusted SETUP.md links and polished the pirate lingo across the docs! ⚓️🗺️
1 parent a719469 commit b638428

File tree

2 files changed

+95
-48
lines changed

2 files changed

+95
-48
lines changed

‎README.md‎

Lines changed: 19 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Ahoy, mateys! Welcome to Plundarr, the ultimate Docker Compose setup for all ye
88

99
## Captain's Log 📜
1010

11-
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! 🏴‍☠️
11+
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 med on a deserted isle! 🏝️
1212

1313
## ⚡️ Quick Start
1414

@@ -67,48 +67,19 @@ For more details, see the example env configuration here:
6767

6868
- 🏴‍☠️ [Peek at the Pirate's Env Code](./example.env)
6969

70-
### Setting Sail on the Docker Seas 🌊🐋
70+
### 📜 Important Setup Scroll! ☠️
7171

72-
See the Docker Compose [IPAM](https://docs.docker.com/compose/compose-file/06-networks/#ipam) documentation fer more information on configurin' the followin' [IP address information](https://github.com/scottgigawatt/plundarr/blob/main/example.env#L9-L11) fer the compose stack. Ye can plunder the example config straight from the Docker Compose scrolls!
73-
74-
```bash
75-
#
76-
# Chart the usable IP waters for this here subnet: 172.28.0.1 - 172.28.255.254
77-
# Total number of scallywag hosts: 65,536
78-
# Number of seaworthy hosts: 65,534
79-
# Subnet mask (or should I say, pirate's mask): 255.255.0.0
80-
#
81-
COMPOSE_NETWORK_SUBNET="${COMPOSE_NETWORK_SUBNET:-172.28.0.0/16}"
82-
83-
#
84-
# Plot the IP course for the containers: 172.28.5.1 - 172.28.5.254
85-
# Total number of seadogs: 256
86-
# Number of usable scurvy dogs: 254
87-
# Subnet mask: 255.255.255.0 (aye, the smallest o' the masks)
88-
#
89-
COMPOSE_NETWORK_IP_RANGE="${COMPOSE_NETWORK_IP_RANGE:-172.28.5.0/24}"
90-
91-
#
92-
# Set sail with the network gateway at the last IP address, the final port o' call
93-
#
94-
COMPOSE_NETWORK_GATEWAY="${COMPOSE_NETWORK_GATEWAY:-172.28.5.254}"
95-
```
96-
97-
### ️Commandin' the Fleet with DSM Container Manager 🏴‍☠️
98-
99-
> [!TIP]
100-
> 🦜 If ye be usin' Synology DSM 7.2, Container Manager Projects be yer secret map to quicker plunderin'.
72+
> [!IMPORTANT]
73+
> ⚓️ Before hoistin' the sails, make sure to scour the [Docker Project Setup](./SETUP.md) 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!
10174
102-
To bring this booty into DSM 7.2 Container Manager's Project feature, follow these steps, ye sea dogs:
75+
The [Docker Project Setup](./SETUP.md) parchment covers:
10376

104-
1. SSH into yer Synology system.
105-
2. Recursively clone this repository with submodules, e.g., to `/volume1/docker/plundarr`.
106-
3. In Container Manager, click **Project** then **Create**.
107-
4. Provide a title, e.g., **plundarr**.
108-
5. Set the path to the cloned repository.
109-
6. Navigate through the UI prompts t' finish creatin' the project.
77+
- 🌍🔧 [Configuring Docker Networking](./SETUP.md#chartin-the-docker-network-waters-)
78+
- 🖥️🔧 [Synology Configuration](./SETUP.md#batten-down-the-hatches-️)
79+
- 🔥🛡️ [Updating Firewall Settings](./SETUP.md#guardin-the-ship-️)
80+
- 📦🚀 [Deploying With Container Manager](./SETUP.md#launchin-yer-fleet-)
11081

111-
Check out the official Synology documentation [here](https://kb.synology.com/en-id/DSM/help/ContainerManager/docker_project?version=7) fer more on Container Manager Projects. Yo ho ho!
82+
Mind these steps, lest ye be marooned on a deserted isle! 🏝️
11283

11384
### Ensure Yer Tunnels Be Ready at Boot 🏴‍☠️⛏️
11485

@@ -128,15 +99,15 @@ To confirm yer VPN sails be catchin' wind:
12899
❯ make test-vpn
129100
docker run --rm --network=container:gluetun-latest alpine:3.18 sh -c "apk add wget && wget -qO- https://ipinfo.io"
130101
{
131-
"ip": "xxx.xxx.xxx.xxx",
132-
"city": "City",
133-
"region": "Region",
134-
"country": "Country",
135-
"loc": "xx.xxxx,yy.yyyy",
136-
"org": "Organization",
137-
"postal": "ABC",
138-
"timezone": "Time/Zone",
139-
"readme": "https://ipinfo.io/missingauth"
102+
"ip": "172.16.0.42",
103+
"city": "Tortuga",
104+
"region": "Caribbean",
105+
"country": "High Seas",
106+
"loc": "13.4443,-144.7937",
107+
"org": "Black Pearl Privateers",
108+
"postal": "ARR123",
109+
"timezone": "Rum/Somewhere",
110+
"readme": "https://ipinfo.io/blackpearl"
140111
}
141112
```
142113

‎SETUP.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Plundarr Docker Setup Guide ⚓🐳🏴‍☠️
2+
3+
Avast ye! This here be the guide for riggin' up yer Docker Compose fleet. It covers the treacherous waters of Synology DiskStations with DSM 7.2 or later, but landlubbers usin' Linux and macOS can sail by these charts too! 🏴‍☠️
4+
5+
## Chartin' the Docker Network Waters 🌍🧭
6+
7+
> [!IMPORTANT]
8+
> ⚓️ Set yer IPAM settings right in yer `.env` before settin' sail, or ye'll find yerself adrift in a sea of network woes!
9+
10+
Docker IPAM (IP Address Management) lets ye carve out yer own slice of the subnet seas, makin' yer fleet easier to command and troubleshoot 🛠️.
11+
12+
Update these settings in your `.env` file:
13+
14+
```bash
15+
#
16+
# Broad waters fer the subnet (Subnet range: 172.28.0.1 - 172.28.255.254)
17+
# Chart mask: 255.255.0.0
18+
#
19+
COMPOSE_NETWORK_SUBNET="${COMPOSE_NETWORK_SUBNET:-172.28.0.0/16}"
20+
21+
#
22+
# Where the crew drops anchor (IP range fer containers: 172.28.5.1 - 172.28.5.254)
23+
# Chart mask: 255.255.255.0
24+
#
25+
COMPOSE_NETWORK_IP_RANGE="${COMPOSE_NETWORK_IP_RANGE:-172.28.5.0/24}"
26+
27+
#
28+
# Gateway to the open seas (Network gateway IP address)
29+
#
30+
COMPOSE_NETWORK_GATEWAY="${COMPOSE_NETWORK_GATEWAY:-172.28.5.254}"
31+
```
32+
33+
For detailed documentation, refer to the [Docker Compose IPAM documentation](https://docs.docker.com/compose/compose-file/06-networks/#ipam).
34+
35+
## Batten Down the Hatches 🖥️⚓
36+
37+
Fer them sailin' with Synology DiskStations, here be the riggin' details ye need!
38+
39+
### Guardin' the Ship 🔥🛡️
40+
41+
> [!WARNING]
42+
> 🏴‍☠️ Misfirin' yer firewall could leave yer crew stranded! Double-check them source IPs and subnet details before ye weigh anchor.
43+
44+
If your Synology DiskStation firewall is enabled, allow traffic for the custom Docker network:
45+
46+
1. 🛠️ Open **Control Panel** → **Security** (under Connectivity).
47+
2. 🛡️ Go to the **Firewall** tab → Click **Edit Rules**.
48+
3. ➕ Click **Create** to add a rule:
49+
- 🎯 **Ports**: Select `All`
50+
- 🌐 **Source IP**: Select `Specific IP`
51+
- 🧩 Click `Select` → Choose `Subnet`
52+
- 📝 Enter `172.28.0.0` for **IP Address** and `255.255.0.0` for **Subnet mask/Prefix length**
53+
- ✅ **Action**: Select `Allow`
54+
4. 💾 Click **OK** to apply.
55+
56+
This allows containers to communicate internally within the defined Docker network.
57+
58+
### Launchin' Yer Fleet 📦🚀
59+
60+
> [!NOTE]
61+
> 📜 If yer on DSM 7.2 or later, Synology's Container Manager Project be the swiftest way to get yer fleet underway. Make sure yer vessel's firmware be up-to-date!
62+
63+
To deploy a project using Synology Container Manager:
64+
65+
1. 🔑 Log in to the Synology DSM web interface.
66+
2. 📦 Open **Container Manager** and navigate to the **Project** tab 📂.
67+
3. 🆕 Click **Create** and configure:
68+
- 🏷️ **Project Name**: (e.g., `plundarr`)
69+
- 📂 **Project Path**: Path to the cloned repository.
70+
4. 🚀 Review and confirm the settings to deploy the project.
71+
72+
Refer to the [official Synology documentation](https://kb.synology.com/en-id/DSM/help/ContainerManager/docker_project?version=7) for further details.
73+
74+
---
75+
76+
These secrets should have ye sailin' smooth seas 🚢 — may yer containers stay hearty 🏴‍☠️ and yer logs whisper like the calm before a storm 🌊. Fair winds and followin' seas, matey! 🐳🏴‍☠️

0 commit comments

Comments
 (0)