Update project name

.env

@@ -1,22 +1,22 @@
 #
-# .env file: Environment variables for Privataarr configuration.
+# .env file: Environment variables for Privateerr configuration.
 #
 
 #
 # Name of the project which adds namespace for all services and volumes
 #
-COMPOSE_PROJECT_NAME=${COMPOSE_PROJECT_NAME:-privataarr}
+COMPOSE_PROJECT_NAME=${COMPOSE_PROJECT_NAME:-privateerr}
 
 #
 # Host path of wireguard configuration file to be written
 #
 HOST_CONF_PATH="${HOST_CONF_PATH:-./config/wg0.conf}"
 
 #
-# Privataarr environment variables
+# Privateerr environment variables
 #
-PRIVATAARR_IMAGE="${PRIVATAARR_IMAGE:-scottgigawatt/privataarr}"
-PRIVATAARR_TAG="${PRIVATAARR_TAG:-latest}"
+PRIVATEERR_IMAGE="${PRIVATEERR_IMAGE:-scottgigawatt/privateerr}"
+PRIVATEERR_TAG="${PRIVATEERR_TAG:-latest}"
 
 #
 # Ubuntu environment variables

.secrets.baseline

@@ -138,5 +138,5 @@
       }
     ]
   },
-  "generated_at": "2024-06-07T21:26:33Z"
+  "generated_at": "2024-06-09T03:10:58Z"
 }

.vscode/settings.json

@@ -1,7 +1,7 @@
 {
     "cSpell.words": [
         "Gluetun",
-        "Privataarr",
+        "Privateerr",
         "scottgigawatt",
         "Sonoma"
     ]

Makefile

@@ -21,7 +21,7 @@ RUN=run
 #
 # Docker Compose options
 #
-COMPOSE_SERVICE_NAME  ?= privataarr
+COMPOSE_SERVICE_NAME  ?= privateerr
 COMPOSE_DOWN_TIMEOUT  ?= 30
 COMPOSE_DOWN_OPTIONS  ?= --timeout $(COMPOSE_DOWN_TIMEOUT) --rmi all --volumes
 COMPOSE_BUILD_OPTIONS ?= --pull --no-cache

README.md

@@ -1,10 +1,10 @@
-# Privataarr ☠️🏴‍☠️
+# Privateerr ☠️🏴‍☠️
 
-Ahoy, matey! Welcome to Privataarr, where we sail the digital seas with Private Internet Access and WireGuard!
+Ahoy, matey! Welcome to Privateerr, where we sail the digital seas with Private Internet Access and WireGuard!
 
 ## Overview 🦜⚓️
 
-Ahoy there! Privataarr be a Docker Compose configuration for buildin' Private Internet Access manual connection scripts into a Docker image with the required WireGuard tools. It also be generatin' a configuration file for native WireGuard connections. Hoist the sails and set yer course for secure VPN connections, me hearties!
+Ahoy there! Privateerr be a Docker Compose configuration for buildin' Private Internet Access manual connection scripts into a Docker image with the required WireGuard tools. It also be generatin' a configuration file for native WireGuard connections. Hoist the sails and set yer course for secure VPN connections, me hearties!
 
 This repo includes the [PIA manual-connections](https://github.com/pia-foss/manual-connections) repository as a submodule at [`docker/pia`](./docker/pia), so it be included in the image build.
 
@@ -16,23 +16,23 @@ To set sail and embark on yer VPN journey, follow these steps:
 
 ```bash
 # Hoist the Jolly Roger and clone the repository with submodules
-git clone --recurse-submodules git@github.com:scottgigawatt/privataarr.git
-cd privataarr
+git clone --recurse-submodules git@github.com:scottgigawatt/privateerr.git
+cd privateerr
 
 # Weigh anchor and start the container
 PIA_USER=<pia_username> PIA_PASS=<pia_password> make
 ```
 
-The treasure map to yer WireGuard configuration file will be buried in the [`config`](./config/) directory. This directory contains a default configuration file, [`wg0.conf`](./config/wg0.conf). When ye run Privataarr, this file will be updated with the PIA WireGuard configuration. Ye can then use this configuration file to configure a VPN client like Gluetun for secure connections.
+The treasure map to yer WireGuard configuration file will be buried in the [`config`](./config/) directory. This directory contains a default configuration file, [`wg0.conf`](./config/wg0.conf). When ye run Privateerr, this file will be updated with the PIA WireGuard configuration. Ye can then use this configuration file to configure a VPN client like Gluetun for secure connections.
 
 ## Environment Details 🏝️🔍
 
-Privataarr has been tested on macOS Sonoma 14.5. But fear not, me hearties! It should work on other lands as well.
+Privateerr has been tested on macOS Sonoma 14.5. But fear not, me hearties! It should work on other lands as well.
 
 ## License ⚖️📜
 
 This project be licensed under the Apache 2 License - see the [LICENSE](LICENSE) scroll for details.
 
 ---
 
-Ye scurvy dogs be welcome to join the crew and improve Privataarr. Feel free to submit pull requests or share yer thoughts. Fair winds and following seas, me mateys! 🌊🏴‍☠️
+Ye scurvy dogs be welcome to join the crew and improve Privateerr. Feel free to submit pull requests or share yer thoughts. Fair winds and following seas, me mateys! 🌊🏴‍☠️

config/README.md

@@ -1,16 +1,16 @@
 # Config Directory
 
-Ahoy, matey! This be the config directory for Privataarr, yer trusty Docker Compose setup for Private Internet Access VPN connections with WireGuard.
+Ahoy, matey! This be the config directory for Privateerr, yer trusty Docker Compose setup for Private Internet Access VPN connections with WireGuard.
 
 ## Purpose
 
-This directory contains a default configuration file, [`wg0.conf`](./wg0.conf). When ye run Privataarr and weigh anchor, this file will be updated with the PIA WireGuard configuration.
+This directory contains a default configuration file, [`wg0.conf`](./wg0.conf). When ye run Privateerr and weigh anchor, this file will be updated with the PIA WireGuard configuration.
 
 ## Instructions
 
 To use this directory:
 
-1. Run Privataarr and start the container.
+1. Run Privateerr and start the container.
 2. Wait for the setup to complete and the [`wg0.conf`](./wg0.conf) file to be updated with the new configuration.
 3. Find yer treasure map in this directory.
 

docker-compose.yml

@@ -13,22 +13,22 @@
 #
 services:
   #
-  # Define the 'privataarr' service
+  # Define the 'privateerr' service
   #
-  privataarr:
+  privateerr:
     # Docker image build and container information
-    image: ${PRIVATAARR_IMAGE}:${PRIVATAARR_TAG}      # Set build image name and tag
+    image: ${PRIVATEERR_IMAGE}:${PRIVATEERR_TAG}      # Set build image name and tag
     build:                                            # Build to install required packages
       context: docker                                 # Docker build context
       dockerfile: Dockerfile                          # Dockerfile to use for the build
       args:                                           # Build arguments passed to Dockerfile
         UBUNTU_TAG: ${UBUNTU_TAG}                     # Specify build argument for FROM base image tag
         TZ: ${TZ}                                     # Specify build arguement for time zone
         PIA_APP_HOME: ${PIA_APP_HOME}                 # Specify build arguement for PIA scripts path
-    container_name: privataarr-${PRIVATAARR_TAG}      # Append Docker image tag to container name
+    container_name: privateerr-${PRIVATEERR_TAG}      # Append Docker image tag to container name
     restart: no                                       # Do not restart the container once it exits
     network_mode: bridge                              # Use the default bridge network
-    hostname: privataarr                              # Set the container hostname
+    hostname: privateerr                              # Set the container hostname
     privileged: true                                  # Run in privileged mode
     labels:                                           # Add container labels
       - "com.centurylinklabs.watchtower.enable=false" # Exclude from Watchtower as this image is local