💀 Let the crew know: build yer own privateerr if GHCR be sunk

Author: scottgigawatt

.github/workflows/main.yml

@@ -0,0 +1,25 @@
+name: Validate Docker Compose
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docker-compose.yml'
+      - '.github/workflows/validate-compose.yml'
+
+jobs:
+  validate-docker-compose:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Docker Compose
+        uses: ndeloof/install-compose-action@v0.0.1
+
+      - name: Validate Docker Compose configuration
+        run: docker-compose config --no-interpolate

.github/workflows/validate-compose.yml

@@ -125,9 +125,22 @@ docker run --rm --network=container:gluetun-latest alpine:3.18 sh -c "apk add wg
 }
 ```
 
-> [!CAUTION]
+> [!WARNING]
 > ⚠️☠️ Ye should see an IP that ain't from yer home port. If not, batten down and check yer `.env` scroll.
 
+> [!NOTE]
+> 🏴‍☠️ The `privateerr` image be used to generate the sacred PIA WireGuard config scroll that powers yer Gluetun VPN sails. By default, Plundarr pulls this image straight from GitHub Container Registry (GHCR), no buildin' required.
+>
+> But if the winds be against ye—or ye fancy testin' custom changes—ye can chart a local build instead using the `docker-compose.build.yml` override scroll.
+>
+> To build `privateerr` locally:
+>
+> ```bash
+> docker-compose -f docker-compose.yml -f docker-compose.build.yml up --build
+> ```
+>
+> This override be swappin' the pull fer a local build usin' yer own Dockerfile and variables from the `.env` scroll. Use it when the registry be unreachable or ye need to tinker with the hull below deck.
+
 ## Navigatin' Troubled Waters ☠️🌊
 
 > [!TIP]
@@ -173,7 +186,7 @@ Plundarr has been tested on Synology DS1522+ and DS916+ runnin' DSM 7.2. But fea
 
 ## Articles of Agreement ⚖️
 
-> [!WARNING]
+> [!CAUTION]
 > 🏴‍☠️⚖️ Mind the legal seas! Ye must honor both the Apache 2 License and the MIT License, or be prepared to walk the plank.
 
 This project be licensed under the Apache 2 License—see the [LICENSE](LICENSE) scroll for details.

README.md

@@ -0,0 +1,34 @@
+---
+#
+# docker-compose.build.yml: Optional override Compose file for local builds.
+#
+# This file defines an alternate configuration for the `privateerr` service.
+# Instead of pulling the pre-built image from GitHub Container Registry,
+# this configuration builds the container locally from source using the
+# provided Dockerfile and build arguments.
+#
+# Use this file when testing local changes or if the image is unavailable from GHCR.
+#
+# To activate:
+#   docker-compose -f docker-compose.yml -f docker-compose.build.yml up --build
+#
+# Service included:
+# - privateerr: https://github.com/scottgigawatt/privateerr
+#
+
+#
+# Define the services section
+#
+services:
+  #
+  # Define the 'privateerr' service as a local build override for use when image cannot be pulled from GHCR
+  #
+  privateerr:
+    build:                                               # Build to install required packages
+      context: config/privateerr/docker                  # Docker build context
+      dockerfile: Dockerfile                             # Dockerfile to use for the build
+      args:                                              # Build arguments passed to Dockerfile
+        PRIVATEERR_BASE_IMAGE: ${PRIVATEERR_BASE_IMAGE}  # Specify build argument for FROM base image
+        PRIVATEERR_BASE_TAG: ${PRIVATEERR_BASE_TAG}      # Specify build argument for FROM base image tag
+        TZ: ${TZ}                                        # Specify build argument for time zone
+        PIA_APP_HOME: ${PIA_APP_HOME}                    # Specify build argument for PIA scripts path

docker-compose.build.yml

@@ -75,23 +75,15 @@ services:
   #
   privateerr:
     # Docker image build and container information
-    image: ${PRIVATEERR_IMAGE}:${PRIVATEERR_TAG}         # Set build image name and tag
-    build:                                               # Build to install required packages
-      context: config/privateerr/docker                  # Docker build context
-      dockerfile: Dockerfile                             # Dockerfile to use for the build
-      args:                                              # Build arguments passed to Dockerfile
-        PRIVATEERR_BASE_IMAGE: ${PRIVATEERR_BASE_IMAGE}  # Specify build argument for FROM base image
-        PRIVATEERR_BASE_TAG: ${PRIVATEERR_BASE_TAG}      # Specify build argument for FROM base image tag
-        TZ: ${TZ}                                        # Specify build argument for time zone
-        PIA_APP_HOME: ${PIA_APP_HOME}                    # Specify build argument for PIA scripts path
-    container_name: privateerr-${PRIVATEERR_TAG}         # Append Docker image tag to container name
-    restart: "no"                                        # Do not restart the container once it exits
-    hostname: privateerr                                 # Set the container hostname
-    privileged: true                                     # Run with full host privileges
+    image: ${PRIVATEERR_IMAGE}:${PRIVATEERR_TAG}  # Pull image (use docker-compose.build.yml for local build override)
+    container_name: privateerr-${PRIVATEERR_TAG}  # Append Docker image tag to container name
+    restart: "no"                                 # Do not restart the container once it exits
+    hostname: privateerr                          # Set the container hostname
+    privileged: true                              # Run with full host privileges
 
     # Add container labels
     labels:
-      - "com.centurylinklabs.watchtower.enable=false"  # Exclude local init container from Watchtower
+      - "com.centurylinklabs.watchtower.enable=false"  # Exclude init container from Watchtower
 
     # Define the container environment
     environment:

docker-compose.yml

@@ -45,7 +45,7 @@ TZ="${TZ:-America/New_York}"
 #
 PRIVATEERR_BASE_IMAGE="${PRIVATEERR_BASE_IMAGE:-ubuntu}"
 PRIVATEERR_BASE_TAG="${PRIVATEERR_BASE_TAG:-20.04}"
-PRIVATEERR_IMAGE="${PRIVATEERR_IMAGE:-scottgigawatt/privateerr}"
+PRIVATEERR_IMAGE="${PRIVATEERR_IMAGE:-ghcr.io/scottgigawatt/privateerr}"
 PRIVATEERR_TAG="${PRIVATEERR_TAG:-latest}"
 PRIVATEERR_WIREGUARD_CONFIG="${PRIVATEERR_WIREGUARD_CONFIG:-./config/gluetun/wireguard/wg0.conf}"