fix(version): log last release by tag name alphabetically instead of date

- Merge same links in the same line
- Add `/choose` suffix to github links

.devcontainer/README.md

@@ -9,17 +9,21 @@ It works on Linux, Windows and OSX.
 - [VS code](https://code.visualstudio.com/download) installed
 - [VS code remote containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) installed
 - [Docker](https://www.docker.com/products/docker-desktop) installed and running
-    - If you don't use Linux or WSL 2, share your home directory `~/` and the directory of your project with Docker Desktop
 - [Docker Compose](https://docs.docker.com/compose/install/) installed
-- Ensure your host has the following and that they are accessible by Docker:
-    - `~/.ssh` directory
-    - `~/.gitconfig` file (can be empty)
 
 ## Setup
 
+1. Create the following files on your host if you don't have them:
+
+    ```sh
+    touch ~/.gitconfig ~/.zsh_history
+    ```
+
+    Note that the development container will create the empty directories `~/.docker`, `~/.ssh` and `~/.kube` if you don't have them.
+
+1. **For Docker on OSX or Windows without WSL**: ensure your home directory `~` is accessible by Docker.
 1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P).
 1. Select `Remote-Containers: Open Folder in Container...` and choose the project directory.
-1. For Docker running on Windows HyperV, if you want to use SSH keys, bind mount them at `/tmp/.ssh` by changing the `volumes` section in the [docker-compose.yml](docker-compose.yml).
 
 ## Customization
 
@@ -29,13 +33,9 @@ You can make changes to the [Dockerfile](Dockerfile) and then rebuild the image.
 
 ```Dockerfile
 FROM qmcgaw/godevcontainer
-USER root
 RUN apk add curl
-USER vscode
 ```
 
-Note that you may need to use `USER root` to build as root, and then change back to `USER vscode`.
-
 To rebuild the image, either:
 
 - With VSCode through the command palette, select `Remote-Containers: Rebuild and reopen in container`
@@ -47,11 +47,11 @@ You can customize **settings** and **extensions** in the [devcontainer.json](dev
 
 ### Entrypoint script
 
-You can bind mount a shell script to `/home/vscode/.welcome.sh` to replace the [current welcome script](shell/.welcome.sh).
+You can bind mount a shell script to `/root/.welcome.sh` to replace the [current welcome script](https://github.com/qdm12/godevcontainer/blob/master/shell/.welcome.sh).
 
 ### Publish a port
 
-To access a port from your host to your development container, publish a port in [docker-compose.yml](docker-compose.yml).
+To access a port from your host to your development container, publish a port in [docker-compose.yml](docker-compose.yml). You can also now do it directly with VSCode without restarting the container.
 
 ### Run other services
 

.devcontainer/devcontainer.json

@@ -1,82 +1,73 @@
-{
+{
-    "name": "gluetun-dev",
+    "name": "gluetun-dev",
-    "dockerComposeFile": [
+    "dockerComposeFile": [
-        "docker-compose.yml"
+        "docker-compose.yml"
-    ],
+    ],
-    "service": "vscode",
+    "service": "vscode",
-    "runServices": [
+    "runServices": [
-        "vscode"
+        "vscode"
-    ],
+    ],
-    "shutdownAction": "stopCompose",
+    "shutdownAction": "stopCompose",
-    "postCreateCommand": "source ~/.windows.sh && go mod download && go mod tidy",
+    "postCreateCommand": "~/.windows.sh && go mod download && go mod tidy",
-    "workspaceFolder": "/workspace",
+    "workspaceFolder": "/workspace",
-    "extensions": [
+    // "overrideCommand": "",
-        "golang.go",
+    "customizations": {
-        "eamodio.gitlens", // IDE Git information
+        "vscode": {
-        "davidanson.vscode-markdownlint",
+            "extensions": [
-        "ms-azuretools.vscode-docker", // Docker integration and linting
+                "golang.go",
-        "shardulm94.trailing-spaces", // Show trailing spaces
+                "eamodio.gitlens", // IDE Git information
-        "Gruntfuggly.todo-tree", // Highlights TODO comments
+                "davidanson.vscode-markdownlint",
-        "bierner.emojisense", // Emoji sense for markdown
+                "ms-azuretools.vscode-docker", // Docker integration and linting
-        "stkb.rewrap", // rewrap comments after n characters on one line
+                "shardulm94.trailing-spaces", // Show trailing spaces
-        "vscode-icons-team.vscode-icons", // Better file extension icons
+                "Gruntfuggly.todo-tree", // Highlights TODO comments
-        "github.vscode-pull-request-github", // Github interaction
+                "bierner.emojisense", // Emoji sense for markdown
-        "redhat.vscode-yaml", // Kubernetes, Drone syntax highlighting
+                "stkb.rewrap", // rewrap comments after n characters on one line
-        "bajdzis.vscode-database", // Supports connections to mysql or postgres, over SSL, socked
+                "vscode-icons-team.vscode-icons", // Better file extension icons
-        "IBM.output-colorizer", // Colorize your output/test logs
+                "github.vscode-pull-request-github", // Github interaction
-        "mohsen1.prettify-json", // Prettify JSON data
+                "redhat.vscode-yaml", // Kubernetes, Drone syntax highlighting
-        "github.copilot",
+                "bajdzis.vscode-database", // Supports connections to mysql or postgres, over SSL, socked
-    ],
+                "IBM.output-colorizer", // Colorize your output/test logs
-    "settings": {
+                "github.copilot" // AI code completion
-        "files.eol": "\n",
+            ],
-        "remote.extensionKind": {
+            "settings": {
-            "ms-azuretools.vscode-docker": "workspace"
+                "files.eol": "\n",
-        },
+                "remote.extensionKind": {
-        "editor.codeActionsOnSaveTimeout": 3000,
+                    "ms-azuretools.vscode-docker": "workspace"
-        "go.useLanguageServer": true,
+                },
-        "[go]": {
+                "go.useLanguageServer": true,
-            "editor.formatOnSave": true,
+                "[go]": {
-            "editor.codeActionsOnSave": {
+                    "editor.codeActionsOnSave": {
-                "source.organizeImports": true,
+                        "source.organizeImports": "explicit"
-            },
+                    }
-            // Optional: Disable snippets, as they conflict with completion ranking.
+                },
-            "editor.snippetSuggestions": "none"
+                "[go.mod]": {
-        },
+                    "editor.codeActionsOnSave": {
-        "[go.mod]": {
+                        "source.organizeImports": "explicit"
-            "editor.formatOnSave": true,
+                    }
-            "editor.codeActionsOnSave": {
+                },
-                "source.organizeImports": true,
+                "gopls": {
-            },
+                    "usePlaceholders": false,
-        },
+                    "staticcheck": true
-        "gopls": {
+                },
-            "usePlaceholders": false,
+                "go.lintTool": "golangci-lint",
-            "staticcheck": true
+                "go.lintOnSave": "package",
-        },
+                "editor.formatOnSave": true,
-        "go.autocompleteUnimportedPackages": true,
+                "go.buildTags": "linux",
-        "go.gotoSymbol.includeImports": true,
+                "go.toolsEnvVars": {
-        "go.gotoSymbol.includeGoroot": true,
+                    "CGO_ENABLED": "0"
-        "go.lintTool": "golangci-lint",
+                },
-        "go.buildOnSave": "workspace",
+                "go.testEnvVars": {
-        "go.lintOnSave": "workspace",
+                    "CGO_ENABLED": "1"
-        "go.vetOnSave": "workspace",
+                },
-        "editor.formatOnSave": true,
+                "go.testFlags": [
-        "go.toolsEnvVars": {
+                    "-v",
-            "GOFLAGS": "-tags=",
+                    "-race"
-            // "CGO_ENABLED": 1 // for the race detector
+                ],
-        },
+                "go.testTimeout": "10s",
-        "gopls.env": {
+                "go.coverOnSingleTest": true,
-            "GOFLAGS": "-tags="
+                "go.coverOnSingleTestFile": true,
-        },
+                "go.coverOnTestPackage": true
-        "go.testEnvVars": {
+            }
-            "": ""
+        }
-        },
+    }
-        "go.testFlags": [
-            "-v",
-            // "-race"
-        ],
-        "go.testTimeout": "10s",
-        "go.coverOnSingleTest": true,
-        "go.coverOnSingleTestFile": true,
-        "go.coverOnTestPackage": true
-    }
 }

.devcontainer/docker-compose.yml

@@ -1,30 +1,28 @@
-version: "3.7"
+version: "3.7"
-
+
-services:
+services:
-  vscode:
+  vscode:
-    build: .
+    build: .
-    devices:
+    volumes:
-      - /dev/net/tun:/dev/net/tun
+      - ../:/workspace
-    volumes:
+      # Docker socket to access Docker server
-      - ../:/workspace
+      - /var/run/docker.sock:/var/run/docker.sock
-      # Docker socket to access Docker server
+      # SSH directory for Linux, OSX and WSL
-      - /var/run/docker.sock:/var/run/docker.sock
+      # On Linux and OSX, a symlink /mnt/ssh <-> ~/.ssh is
-      # Docker configuration
+      # created in the container. On Windows, files are copied
-      - ~/.docker:/root/.docker
+      # from /mnt/ssh to ~/.ssh to fix permissions.
-      # SSH directory for Linux, OSX and WSL
+      - ~/.ssh:/mnt/ssh
-      # On Linux and OSX, a symlink /mnt/ssh <-> ~/.ssh is
+      # Shell history persistence
-      # created in the container. On Windows, files are copied
+      - ~/.zsh_history:/root/.zsh_history
-      # from /mnt/ssh to ~/.ssh to fix permissions.
+      # Git config
-      - ~/.ssh:/mnt/ssh
+      - ~/.gitconfig:/root/.gitconfig
-      # Shell history persistence
+    environment:
-      - ~/.zsh_history:/root/.zsh_history
+      - TZ=
-    environment:
+    cap_add:
-      - TZ=
+      # For debugging with dlv
-    cap_add:
+      - SYS_PTRACE
-      # For debugging with dlv
+      - NET_ADMIN
-      # - SYS_PTRACE
+    security_opt:
-      - NET_ADMIN
+      # For debugging with dlv
-    security_opt:
+      - seccomp:unconfined
-      # For debugging with dlv
+    entrypoint: [ "zsh", "-c", "while sleep 1000; do :; done" ]
-      - seccomp:unconfined
-    entrypoint: zsh -c "while sleep 1000; do :; done"

.github/CONTRIBUTING.md

@@ -13,6 +13,6 @@ Contributions are [released](https://help.github.com/articles/github-terms-of-se
 
 ## Resources
 
-- [Gluetun guide on development](https://github.com/qdm12/gluetun/wiki/Development)
+- [Gluetun guide on development](https://github.com/qdm12/gluetun-wiki/blob/main/contributing/development.md)
 - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
 - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)

.github/ISSUE_TEMPLATE/bug.yml

@@ -7,13 +7,18 @@ body:
     attributes:
       value: |
         Thanks for taking the time to fill out this bug report!
+
+        ⚠️ Your issue will be instantly closed as not planned WITHOUT explanation if:
+        - you do not fill out **the title of the issue** ☝️
+        - you do not provide the **Gluetun version** as requested below
+        - you provide **less than 10 lines of logs** as requested below
   - type: dropdown
     id: urgent
     attributes:
       label: Is this urgent?
       description: |
         Is this a critical bug, or do you need this fixed urgently?
-        If this is urgent, note you can use one of the [image tags available](https://github.com/qdm12/gluetun/wiki/Docker-image-tags) if that can help.
+        If this is urgent, note you can use one of the [image tags available](https://github.com/qdm12/gluetun-wiki/blob/main/setup/docker-image-tags.md) if that can help.
       options:
         - "No"
         - "Yes"
@@ -75,6 +80,7 @@ body:
         - Portainer
         - Kubernetes
         - Podman
+        - Unraid
         - Other
     validations:
       required: true
@@ -84,7 +90,7 @@ body:
       label: What is the version of Gluetun
       description: |
         Copy paste the version line at the top of your logs.
-        It should be in the form `Running version latest built on 2020-03-13T01:30:06Z (commit d0f678c)`.
+        It MUST be in the form `Running version latest built on 2020-03-13T01:30:06Z (commit d0f678c)`.
     validations:
       required: true
   - type: textarea
@@ -97,7 +103,7 @@ body:
   - type: textarea
     id: logs
     attributes:
-      label: Share your logs
+      label: Share your logs (at least 10 lines)
       description: No sensitive information is logged out except when running with `LOG_LEVEL=debug`.
       render: plain text
     validations:

.github/ISSUE_TEMPLATE/config.yml

@@ -1,6 +1,10 @@
+blank_issues_enabled: false
 contact_links:
+  - name: Report a Wiki issue
+    url: https://github.com/qdm12/gluetun-wiki/issues/new/choose
+    about: Please create an issue on the gluetun-wiki repository.
   - name: Configuration help?
-    url: https://github.com/qdm12/gluetun/discussions/new
+    url: https://github.com/qdm12/gluetun/discussions/new/choose
     about: Please create a Github discussion.
   - name: Unraid template issue
     url: https://github.com/qdm12/gluetun/discussions/550

.github/ISSUE_TEMPLATE/provider.md

@@ -14,4 +14,4 @@ One of the following is required:
 
 If the list of servers requires to login **or** is hidden behind an interactive configurator,
 you can only use a custom Openvpn configuration file.
-[The Wiki](https://github.com/qdm12/gluetun/wiki/Openvpn-file) describes how to do so.
+[The Wiki's OpenVPN configuration file page](https://github.com/qdm12/gluetun-wiki/blob/main/setup/openvpn-configuration-file.md) describes how to do so.

.github/ISSUE_TEMPLATE/wiki issue.yml

@@ -1,18 +0,0 @@
-name: Wiki issue
-description: Report a Wiki issue
-title: "Wiki issue: "
-labels: ["📄 Wiki issue"]
-body:
-  - type: input
-    id: url
-    attributes:
-      label: "URL to the Wiki page"
-      placeholder: "https://github.com/qdm12/gluetun/wiki/OpenVPN-options"
-    validations:
-      required: true
-  - type: textarea
-    id: description
-    attributes:
-      label: "What's the issue?"
-    validations:
-      required: true

.github/labels.yml

@@ -1,121 +1,140 @@
-# Temporary status
+- name: "Status: 🗯️ Waiting for feedback"
-- name: "🗯️ Waiting for feedback"
+  color: "f7d692"
-  color: "aadefa"
+- name: "Status: 🔴 Blocked"
-  description: ""
+  color: "f7d692"
-- name: "🔴 Blocked"
-  color: "ff3f14"
   description: "Blocked by another issue or pull request"
-- name: "🔒 After next release"
+- name: "Status: 📌 Before next release"
-  color: "e8f274"
+  color: "f7d692"
+  description: "Has to be done before the next release"
+- name: "Status: 🔒 After next release"
+  color: "f7d692"
   description: "Will be done after the next release"
 
-# Priority
+- name: "Closed: ⚰️ Inactive"
-- name: "🚨 Urgent"
+  color: "959a9c"
-  color: "d5232f"
+  description: "No answer was received for weeks"
-  description: ""
+- name: "Closed: 👥 Duplicate"
-- name: "💤 Low priority"
+  color: "959a9c"
-  color: "4285f4"
+  description: "Issue duplicates an existing issue"
-  description: ""
+- name: "Closed: 🗑️ Bad issue"
+  color: "959a9c"
+- name: "Closed: ☠️ cannot be done"
+  color: "959a9c"
 
-# Complexity
+- name: "Priority: 🚨 Urgent"
-- name: "☣️ Hard to do"
+  color: "03adfc"
-  color: "7d0008"
+- name: "Priority: 💤 Low priority"
-  description: ""
+  color: "03adfc"
-- name: "🟩 Easy to do"
+
-  color: "34cf43"
+- name: "Complexity: ☣️ Hard to do"
-  description: ""
+  color: "ff9efc"
+- name: "Complexity: 🟩 Easy to do"
+  color: "ff9efc"
+
+- name: "Popularity: ❤️‍🔥 extreme"
+  color: "ffc7ea"
+- name: "Popularity: ❤️ high"
+  color: "ffc7ea"
 
 # VPN providers
-- name: ":cloud: AirVPN"
+- name: "☁️ AirVPN"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ Custom"
-- name: ":cloud: Cyberghost"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ Cyberghost"
-- name: ":cloud: HideMyAss"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ HideMyAss"
-- name: ":cloud: IPVanish"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ IPVanish"
-- name: ":cloud: IVPN"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ IVPN"
-- name: ":cloud: ExpressVPN"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ ExpressVPN"
-- name: ":cloud: FastestVPN"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ FastestVPN"
-- name: ":cloud: Mullvad"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ Mullvad"
-- name: ":cloud: NordVPN"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ NordVPN"
-- name: ":cloud: Perfect Privacy"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ Perfect Privacy"
-- name: ":cloud: PIA"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ PIA"
-- name: ":cloud: Privado"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ Privado"
-- name: ":cloud: PrivateVPN"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ PrivateVPN"
-- name: ":cloud: ProtonVPN"
   color: "cfe8d4"
-- name: ":cloud: PureVPN"
+- name: "☁️ ProtonVPN"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ PureVPN"
-- name: ":cloud: SlickVPN"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ SlickVPN"
-- name: ":cloud: Surfshark"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ Surfshark"
-- name: ":cloud: Torguard"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ Torguard"
-- name: ":cloud: VPNSecure.me"
   color: "cfe8d4"
-- name: ":cloud: VPNUnlimited"
+- name: "☁️ VPNSecure.me"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ VPNUnlimited"
-- name: ":cloud: Vyprvpn"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ Vyprvpn"
-- name: ":cloud: WeVPN"
   color: "cfe8d4"
-  description: ""
+- name: "☁️ WeVPN"
-- name: ":cloud: Windscribe"
+  color: "cfe8d4"
+- name: "☁️ Windscribe"
   color: "cfe8d4"
-  description: ""
 
-# Problem category
+- name: "Category: Config problem 📝"
-- name: "Openvpn"
   color: "ffc7ea"
-  description: ""
+- name: "Category: Healthcheck 🩺"
-- name: "Wireguard"
   color: "ffc7ea"
-  description: ""
+- name: "Category: Documentation ✒️"
-- name: "Unbound (DNS over TLS)"
+  description: "A problem with the readme or a code comment."
   color: "ffc7ea"
-  description: ""
+- name: "Category: Maintenance ⛓️"
-- name: "Firewall"
+  description: "Anything related to code or other maintenance"
   color: "ffc7ea"
-  description: ""
+- name: "Category: Logs 📚"
-- name: "HTTP proxy"
+  description: "Something to change in logs"
   color: "ffc7ea"
-  description: ""
+- name: "Category: Good idea 🎯"
-- name: "Shadowsocks"
+  description: "This is a good idea, judged by the maintainers"
   color: "ffc7ea"
-  description: ""
+- name: "Category: Motivated! 🙌"
-- name: "Healthcheck server"
+  description: "Your pumpness makes me pumped! The issue or PR shows great motivation!"
   color: "ffc7ea"
-  description: ""
+- name: "Category: Foolproof settings 👼"
-- name: "Control server"
+  color: "ffc7ea"
+- name: "Category: Label missing ❗"
+  color: "ffc7ea"
+- name: "Category: updater ♻️"
+  color: "ffc7ea"
+  description: "Concerns the code to update servers data"
+- name: "Category: New provider 🆕"
+  color: "ffc7ea"
+- name: "Category: OpenVPN 🔐"
+  color: "ffc7ea"
+- name: "Category: Wireguard 🔐"
+  color: "ffc7ea"
+- name: "Category: DNS 📠"
+  color: "ffc7ea"
+- name: "Category: Firewall ⛓️"
+  color: "ffc7ea"
+- name: "Category: Routing 🛤️"
+  color: "ffc7ea"
+- name: "Category: IPv6 🛰️"
+  color: "ffc7ea"
+- name: "Category: VPN port forwarding 📥"
+  color: "ffc7ea"
+- name: "Category: HTTP proxy 🔁"
+  color: "ffc7ea"
+- name: "Category: Shadowsocks 🔁"
+  color: "ffc7ea"
+- name: "Category: control server ⚙️"
+  color: "ffc7ea"
+- name: "Category: kernel 🧠"
+  color: "ffc7ea"
+- name: "Category: public IP service 💬"
   color: "ffc7ea"
-  description: ""

.github/workflows/ci-skip.yml

@@ -14,8 +14,6 @@ on:
       - go.mod
       - go.sum
   pull_request:
-    branches:
-      - master
     paths-ignore:
       - .github/workflows/ci.yml
       - cmd/**

.github/workflows/ci.yml

@@ -17,8 +17,6 @@ on:
       - go.mod
       - go.sum
   pull_request:
-    branches:
-      - master
     paths:
       - .github/workflows/ci.yml
       - cmd/**
@@ -39,7 +37,7 @@ jobs:
     env:
       DOCKER_BUILDKIT: "1"
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: reviewdog/action-misspell@v1
         with:
@@ -47,6 +45,7 @@ jobs:
           level: error
           exclude: |
             ./internal/storage/servers.json
+            *.md
 
       - name: Linting
         run: docker build --target lint .
@@ -74,12 +73,15 @@ jobs:
       contents: read
       security-events: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
-      - uses: github/codeql-action/init@v2
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "^1.22"
+      - uses: github/codeql-action/init@v3
         with:
           languages: go
-      - uses: github/codeql-action/autobuild@v2
+      - uses: github/codeql-action/autobuild@v3
-      - uses: github/codeql-action/analyze@v2
+      - uses: github/codeql-action/analyze@v3
 
   publish:
     if: |
@@ -96,13 +98,13 @@ jobs:
       packages: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       # extract metadata (tags, labels) for Docker
       # https://github.com/docker/metadata-action
       - name: Extract Docker metadata
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           flavor: |
             latest=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
@@ -117,15 +119,15 @@ jobs:
             type=semver,pattern=v{{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }}
             type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
 
-      - uses: docker/setup-qemu-action@v2
+      - uses: docker/setup-qemu-action@v3
-      - uses: docker/setup-buildx-action@v2
+      - uses: docker/setup-buildx-action@v3
 
-      - uses: docker/login-action@v2
+      - uses: docker/login-action@v3
         with:
           username: qmcgaw
           password: ${{ secrets.DOCKERHUB_PASSWORD }}
 
-      - uses: docker/login-action@v2
+      - uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: qdm12
@@ -136,7 +138,7 @@ jobs:
         run: echo "::set-output name=value::$(git rev-parse --short HEAD)"
 
       - name: Build and push final image
-        uses: docker/build-push-action@v4.0.0
+        uses: docker/build-push-action@v5
         with:
           platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/ppc64le
           labels: ${{ steps.meta.outputs.labels }}

.github/workflows/closed-issue.yml

@@ -0,0 +1,21 @@
+name: Closed issue
+on:
+  issues:
+    types: [closed]
+
+jobs:
+  comment:
+    permissions:
+      issues: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: peter-evans/create-or-update-comment@v4
+        with:
+          token: ${{ github.token }}
+          issue-number: ${{ github.event.issue.number }}
+          body: |
+            Closed issues are **NOT** monitored, so commenting here is likely to be not seen.
+            If you think this is *still unresolved* and have **more information** to bring, please create another issue.
+
+            This is an automated comment setup because @qdm12 is the sole maintainer of this project
+            which became too popular to monitor issues closed.

.github/workflows/configs/mlc-config.json

@@ -0,0 +1,13 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^https://console.substack.com/p/console-72$"
+    }
+  ],
+  "timeout": "20s",
+  "retryOn429": false,
+  "fallbackRetryDelay": "30s",
+  "aliveStatusCodes": [
+    200
+  ]
+}

.github/workflows/dockerhub-description.yml

@@ -1,25 +0,0 @@
-name: Docker Hub description
-on:
-  push:
-    branches:
-      - master
-    paths:
-      - README.md
-      - .github/workflows/dockerhub-description.yml
-jobs:
-  docker-hub-description:
-    if: github.repository == 'qdm12/gluetun'
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-    steps:
-      - uses: actions/checkout@v3
-
-      - uses: peter-evans/dockerhub-description@v3
-        with:
-          username: qmcgaw
-          password: ${{ secrets.DOCKERHUB_PASSWORD }}
-          repository: qmcgaw/gluetun
-          short-description: Lightweight Swiss-knife VPN client to connect to several VPN providers
-          readme-filepath: README.md

.github/workflows/labels.yml

@@ -11,7 +11,7 @@ jobs:
       issues: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
-      - uses: crazy-max/ghaction-github-labeler@v4
+      - uses: crazy-max/ghaction-github-labeler@v5
         with:
           yaml-file: .github/labels.yml

.github/workflows/markdown-skip.yml

@@ -0,0 +1,21 @@
+name: Markdown
+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - "**.md"
+      - .github/workflows/markdown.yml
+  pull_request:
+    paths-ignore:
+      - "**.md"
+      - .github/workflows/markdown.yml
+
+jobs:
+  markdown:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+    steps:
+      - name: No trigger path triggered for required markdown workflow.
+        run: exit 0

.github/workflows/markdown.yml

@@ -0,0 +1,47 @@
+name: Markdown
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "**.md"
+      - .github/workflows/markdown.yml
+  pull_request:
+    paths:
+      - "**.md"
+      - .github/workflows/markdown.yml
+
+jobs:
+  markdown:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: DavidAnson/markdownlint-cli2-action@v16
+        with:
+          globs: "**.md"
+          config: .markdownlint.json
+
+      - uses: reviewdog/action-misspell@v1
+        with:
+          locale: "US"
+          level: error
+          pattern: |
+            *.md
+
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-quiet-mode: yes
+          config-file: .github/workflows/configs/mlc-config.json
+
+      - uses: peter-evans/dockerhub-description@v4
+        if: github.repository == 'qdm12/gluetun' && github.event_name == 'push'
+        with:
+          username: qmcgaw
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          repository: qmcgaw/gluetun
+          short-description: Lightweight Swiss-knife VPN client to connect to several VPN providers
+          readme-filepath: README.md

.github/workflows/opened-issue.yml

@@ -0,0 +1,22 @@
+name: Opened issue
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  comment:
+    permissions:
+      issues: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: peter-evans/create-or-update-comment@v4
+        with:
+          token: ${{ github.token }}
+          issue-number: ${{ github.event.issue.number }}
+          body: |
+            @qdm12 is more or less the only maintainer of this project and works on it in his free time.
+            Please:
+            - **do not** ask for updates, be patient
+            - :+1: the issue to show your support instead of commenting
+            @qdm12 usually checks issues at least once a week, if this is a new urgent bug,
+            [revert to an older tagged container image](https://github.com/qdm12/gluetun-wiki/blob/main/setup/docker-image-tags.md)

.golangci.yml

@@ -9,6 +9,8 @@ issues:
         - dupl
         - goerr113
         - containedctx
+        - goconst
+        - maintidx
     - path: "internal\\/server\\/.+\\.go"
       linters:
         - dupl
@@ -33,6 +35,18 @@ issues:
       text: "newCipherDESCBCBlock returns interface \\(github\\.com\\/youmark\\/pkcs8\\.Cipher\\)"
       linters:
         - ireturn
+    - path: "internal\\/firewall\\/.*\\.go"
+      text: "string `-i ` has [1-9][0-9]* occurrences, make it a constant"
+      linters:
+        - goconst
+    - path: "internal\\/provider\\/ipvanish\\/updater\\/servers.go"
+      text: "string ` in ` has 3 occurrences, make it a constant"
+      linters:
+        - goconst
+    - path: "internal\\/vpn\\/portforward.go"
+      text: 'directive `//nolint:ireturn` is unused for linter "ireturn"'
+      linters:
+        - nolintlint
 
 linters:
   enable:
@@ -46,6 +60,7 @@ linters:
     - decorder
     - dogsled
     - dupl
+    - dupword
     - durationcheck
     - errchkjson
     - errname
@@ -54,6 +69,7 @@ linters:
     - exportloopref
     - forcetypeassert
     - gci
+    - gocheckcompilerdirectives
     - gochecknoglobals
     - gochecknoinits
     - gocognit
@@ -68,6 +84,7 @@ linters:
     - gomoddirectives
     - goprintffuncname
     - gosec
+    - gosmopolitan
     - grouper
     - importas
     - interfacebloat
@@ -75,7 +92,9 @@ linters:
     - lll
     - maintidx
     - makezero
+    - mirror
     - misspell
+    - musttag
     - nakedret
     - nestif
     - nilerr
@@ -83,6 +102,7 @@ linters:
     - noctx
     - nolintlint
     - nosprintfhostport
+    - paralleltest
     - prealloc
     - predeclared
     - promlinter
@@ -90,6 +110,7 @@ linters:
     - revive
     - rowserrcheck
     - sqlclosecheck
+    - tagalign
     - tenv
     - thelper
     - tparallel
@@ -98,9 +119,4 @@ linters:
     - usestdlibvars
     - wastedassign
     - whitespace
-
+    - zerologlint
-run:
-  skip-dirs:
-    - .devcontainer
-    - .github
-    - doc

.markdownlint.json

@@ -0,0 +1,3 @@
+{
+  "MD013": false
+}

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  // This list should be kept to the strict minimum
+  // to develop this project.
+  "recommendations": [
+    "golang.go",
+    "davidanson.vscode-markdownlint",
+  ],
+}

.vscode/settings.json

@@ -0,0 +1,29 @@
+{
+  // The settings should be kept to the strict minimum
+  // to develop this project.
+  "files.eol": "\n",
+  "editor.formatOnSave": true,
+  "go.buildTags": "linux",
+  "go.toolsEnvVars": {
+    "CGO_ENABLED": "0"
+  },
+  "go.testEnvVars": {
+    "CGO_ENABLED": "1"
+  },
+  "go.testFlags": [
+    "-v",
+    "-race"
+  ],
+  "go.testTimeout": "10s",
+  "go.coverOnSingleTest": true,
+  "go.coverOnSingleTestFile": true,
+  "go.coverOnTestPackage": true,
+  "go.useLanguageServer": true,
+  "[go]": {
+    "editor.codeActionsOnSave": {
+      "source.organizeImports": "explicit"
+    }
+  },
+  "go.lintTool": "golangci-lint",
+  "go.lintOnSave": "package"
+}

Dockerfile

@@ -1,8 +1,8 @@
-ARG ALPINE_VERSION=3.17
+ARG ALPINE_VERSION=3.20
-ARG GO_ALPINE_VERSION=3.17
+ARG GO_ALPINE_VERSION=3.20
-ARG GO_VERSION=1.20
+ARG GO_VERSION=1.22
 ARG XCPUTRANSLATE_VERSION=v0.6.0
-ARG GOLANGCI_LINT_VERSION=v1.52.2
+ARG GOLANGCI_LINT_VERSION=v1.56.2
 ARG MOCKGEN_VERSION=v1.6.0
 ARG BUILDPLATFORM=linux/amd64
 
@@ -76,40 +76,54 @@ LABEL \
 ENV VPN_SERVICE_PROVIDER=pia \
     VPN_TYPE=openvpn \
     # Common VPN options
-    VPN_ENDPOINT_IP= \
-    VPN_ENDPOINT_PORT= \
     VPN_INTERFACE=tun0 \
     # OpenVPN
+    OPENVPN_ENDPOINT_IP= \
+    OPENVPN_ENDPOINT_PORT= \
     OPENVPN_PROTOCOL=udp \
     OPENVPN_USER= \
     OPENVPN_PASSWORD= \
     OPENVPN_USER_SECRETFILE=/run/secrets/openvpn_user \
     OPENVPN_PASSWORD_SECRETFILE=/run/secrets/openvpn_password \
-    OPENVPN_VERSION=2.5 \
+    OPENVPN_VERSION=2.6 \
     OPENVPN_VERBOSITY=1 \
     OPENVPN_FLAGS= \
     OPENVPN_CIPHERS= \
     OPENVPN_AUTH= \
-    OPENVPN_PROCESS_USER= \
+    OPENVPN_PROCESS_USER=root \
     OPENVPN_CUSTOM_CONFIG= \
     # Wireguard
+    WIREGUARD_ENDPOINT_IP= \
+    WIREGUARD_ENDPOINT_PORT= \
+    WIREGUARD_CONF_SECRETFILE=/run/secrets/wg0.conf \
     WIREGUARD_PRIVATE_KEY= \
+    WIREGUARD_PRIVATE_KEY_SECRETFILE=/run/secrets/wireguard_private_key \
     WIREGUARD_PRESHARED_KEY= \
+    WIREGUARD_PRESHARED_KEY_SECRETFILE=/run/secrets/wireguard_preshared_key \
     WIREGUARD_PUBLIC_KEY= \
+    WIREGUARD_ALLOWED_IPS= \
+    WIREGUARD_PERSISTENT_KEEPALIVE_INTERVAL=0 \
     WIREGUARD_ADDRESSES= \
+    WIREGUARD_ADDRESSES_SECRETFILE=/run/secrets/wireguard_addresses \
+    WIREGUARD_MTU=1400 \
     WIREGUARD_IMPLEMENTATION=auto \
     # VPN server filtering
     SERVER_REGIONS= \
     SERVER_COUNTRIES= \
     SERVER_CITIES= \
     SERVER_HOSTNAMES= \
+    SERVER_CATEGORIES= \
     # # Mullvad only:
     ISP= \
     OWNED_ONLY=no \
     # # Private Internet Access only:
     PRIVATE_INTERNET_ACCESS_OPENVPN_ENCRYPTION_PRESET= \
     VPN_PORT_FORWARDING=off \
+    VPN_PORT_FORWARDING_LISTENING_PORT=0 \
+    VPN_PORT_FORWARDING_PROVIDER= \
     VPN_PORT_FORWARDING_STATUS_FILE="/tmp/gluetun/forwarded_port" \
+    VPN_PORT_FORWARDING_USERNAME= \
+    VPN_PORT_FORWARDING_PASSWORD= \
     # # Cyberghost only:
     OPENVPN_CERT= \
     OPENVPN_KEY= \
@@ -126,12 +140,16 @@ ENV VPN_SERVICE_PROVIDER=pia \
     SERVER_NAMES= \
     # # ProtonVPN only:
     FREE_ONLY= \
+    SECURE_CORE_ONLY= \
+    TOR_ONLY= \
     # # Surfshark only:
     MULTIHOP_ONLY= \
     # # VPN Secure only:
     PREMIUM_ONLY= \
+    # # PIA only:
+    PORT_FORWARD_ONLY= \
     # Firewall
-    FIREWALL=on \
+    FIREWALL_ENABLED_DISABLING_IT_SHOOTS_YOU_IN_YOUR_FOOT=on \
     FIREWALL_VPN_INPUT_PORTS= \
     FIREWALL_INPUT_PORTS= \
     FIREWALL_OUTBOUND_SUBNETS= \
@@ -164,6 +182,7 @@ ENV VPN_SERVICE_PROVIDER=pia \
     HTTPPROXY= \
     HTTPPROXY_LOG=off \
     HTTPPROXY_LISTENING_ADDRESS=":8888" \
+    HTTPPROXY_STEALTH=off \
     HTTPPROXY_USER= \
     HTTPPROXY_PASSWORD= \
     HTTPPROXY_USER_SECRETFILE=/run/secrets/httpproxy_user \
@@ -176,6 +195,7 @@ ENV VPN_SERVICE_PROVIDER=pia \
     SHADOWSOCKS_PASSWORD_SECRETFILE=/run/secrets/shadowsocks_password \
     SHADOWSOCKS_CIPHER=chacha20-ietf-poly1305 \
     # Control server
+    HTTP_CONTROL_SERVER_LOG=on \
     HTTP_CONTROL_SERVER_ADDRESS=":8000" \
     # Server data updater
     UPDATER_PERIOD=0 \
@@ -184,6 +204,8 @@ ENV VPN_SERVICE_PROVIDER=pia \
     # Public IP
     PUBLICIP_FILE="/tmp/gluetun/ip" \
     PUBLICIP_PERIOD=12h \
+    PUBLICIP_API=ipinfo \
+    PUBLICIP_API_TOKEN= \
     # Pprof
     PPROF_ENABLED=no \
     PPROF_BLOCK_PROFILE_RATE=0 \
@@ -196,17 +218,14 @@ ENV VPN_SERVICE_PROVIDER=pia \
     PGID=
 ENTRYPOINT ["/gluetun-entrypoint"]
 EXPOSE 8000/tcp 8888/tcp 8388/tcp 8388/udp
-HEALTHCHECK --interval=5s --timeout=5s --start-period=10s --retries=1 CMD /gluetun-entrypoint healthcheck
+HEALTHCHECK --interval=5s --timeout=5s --start-period=10s --retries=3 CMD /gluetun-entrypoint healthcheck
 ARG TARGETPLATFORM
 RUN apk add --no-cache --update -l wget && \
-    apk add --no-cache --update -X "https://dl-cdn.alpinelinux.org/alpine/v3.12/main" openvpn==2.4.12-r0 && \
+    apk add --no-cache --update -X "https://dl-cdn.alpinelinux.org/alpine/v3.17/main" openvpn\~2.5 && \
-    apk add --no-cache --update -X "https://dl-cdn.alpinelinux.org/alpine/v3.16/main" openssl\~1.1 && \
-    mv /usr/sbin/openvpn /usr/sbin/openvpn2.4 && \
-    apk del openvpn && \
-    apk add --no-cache --update openvpn ca-certificates iptables ip6tables unbound tzdata && \
     mv /usr/sbin/openvpn /usr/sbin/openvpn2.5 && \
-    # Fix vulnerability issue
+    apk del openvpn && \
-    apk add --no-cache --update busybox && \
+    apk add --no-cache --update openvpn ca-certificates iptables iptables-legacy unbound tzdata && \
+    mv /usr/sbin/openvpn /usr/sbin/openvpn2.6 && \
     rm -rf /var/cache/apk/* /etc/unbound/* /usr/sbin/unbound-* /etc/openvpn/*.sh /usr/lib/openvpn/plugins/openvpn-plugin-down-root.so && \
     deluser openvpn && \
     deluser unbound && \

README.md

@@ -35,20 +35,19 @@ Lightweight swiss-knife-like VPN client to multiple VPN service providers
 
 ## Quick links
 
-- [Setup](#Setup)
+- [Setup](#setup)
-- [Features](#Features)
+- [Features](#features)
 - Problem?
-  - [Check the Wiki](https://github.com/qdm12/gluetun/wiki)
+  - Check the Wiki [common errors](https://github.com/qdm12/gluetun-wiki/tree/main/errors) and [faq](https://github.com/qdm12/gluetun-wiki/tree/main/faq)
   - [Start a discussion](https://github.com/qdm12/gluetun/discussions)
   - [Fix the Unraid template](https://github.com/qdm12/gluetun/discussions/550)
 - Suggestion?
   - [Create an issue](https://github.com/qdm12/gluetun/issues)
-  - [Join the Slack channel](https://join.slack.com/t/qdm12/shared_invite/enQtOTE0NjcxNTM1ODc5LTYyZmVlOTM3MGI4ZWU0YmJkMjUxNmQ4ODQ2OTAwYzMxMTlhY2Q1MWQyOWUyNjc2ODliNjFjMDUxNWNmNzk5MDk)
 - Happy?
   - Sponsor me on [github.com/sponsors/qdm12](https://github.com/sponsors/qdm12)
   - Donate to [paypal.me/qmcgaw](https://www.paypal.me/qmcgaw)
   - Drop me [an email](mailto:quentin.mcgaw@gmail.com)
-- **Want to add a VPN provider?** check [Development](https://github.com/qdm12/gluetun/wiki/Development) and [Add a provider](https://github.com/qdm12/gluetun/wiki/Add-a-provider)
+- **Want to add a VPN provider?** check [the development page](https://github.com/qdm12/gluetun-wiki/blob/main/contributing/development.md) and [add a provider page](https://github.com/qdm12/gluetun-wiki/blob/main/contributing/add-a-provider.md)
 - Video:
 
   [![Video Gif](https://i.imgur.com/CetWunc.gif)](https://youtu.be/0F6I03LQcI4)
@@ -57,24 +56,24 @@ Lightweight swiss-knife-like VPN client to multiple VPN service providers
 
 ## Features
 
-- Based on Alpine 3.17 for a small Docker image of 42MB
+- Based on Alpine 3.20 for a small Docker image of 35.6MB
 - Supports: **AirVPN**, **Cyberghost**, **ExpressVPN**, **FastestVPN**, **HideMyAss**, **IPVanish**, **IVPN**, **Mullvad**, **NordVPN**, **Perfect Privacy**, **Privado**, **Private Internet Access**, **PrivateVPN**, **ProtonVPN**, **PureVPN**,  **SlickVPN**, **Surfshark**, **TorGuard**, **VPNSecure.me**, **VPNUnlimited**, **Vyprvpn**, **WeVPN**, **Windscribe** servers
 - Supports OpenVPN for all providers listed
 - Supports Wireguard both kernelspace and userspace
-  - For **Mullvad**, **Ivpn**, **Surfshark** and **Windscribe**
+  - For **AirVPN**, **FastestVPN**, **Ivpn**, **Mullvad**, **NordVPN**, **Perfect privacy**, **ProtonVPN**, **Surfshark** and **Windscribe**
-  - For **ProtonVPN**, **PureVPN**, **Torguard**, **VPN Unlimited** and **WeVPN** using [the custom provider](https://github.com/qdm12/gluetun/wiki/Custom-provider)
+  - For **Cyberghost**, **Private Internet Access**, **PrivateVPN**, **PureVPN**, **Torguard**, **VPN Unlimited**, **VyprVPN** and **WeVPN** using [the custom provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/custom.md)
-  - For custom Wireguard configurations using [the custom provider](https://github.com/qdm12/gluetun/wiki/Custom-provider)
+  - For custom Wireguard configurations using [the custom provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/custom.md)
   - More in progress, see [#134](https://github.com/qdm12/gluetun/issues/134)
 - DNS over TLS baked in with service provider(s) of your choice
 - DNS fine blocking of malicious/ads/surveillance hostnames and IP addresses, with live update every 24 hours
 - Choose the vpn network protocol, `udp` or `tcp`
 - Built in firewall kill switch to allow traffic only with needed the VPN servers and LAN devices
-- Built in Shadowsocks proxy (protocol based on SOCKS5 with an encryption layer, tunnels TCP+UDP)
+- Built in Shadowsocks proxy server (protocol based on SOCKS5 with an encryption layer, tunnels TCP+UDP)
 - Built in HTTP proxy (tunnels HTTP and HTTPS through TCP)
-- [Connect other containers to it](https://github.com/qdm12/gluetun/wiki/Connect-a-container-to-gluetun)
+- [Connect other containers to it](https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-container-to-gluetun.md)
-- [Connect LAN devices to it](https://github.com/qdm12/gluetun/wiki/Connect-a-LAN-device-to-gluetun)
+- [Connect LAN devices to it](https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-lan-device-to-gluetun.md)
 - Compatible with amd64, i686 (32 bit), **ARM** 64 bit, ARM 32 bit v6 and v7, and even ppc64le 🎆
-- [Custom VPN server side port forwarding for Private Internet Access](https://github.com/qdm12/gluetun/wiki/Private-internet-access#vpn-server-port-forwarding)
+- Custom VPN server side port forwarding for [Perfect Privacy](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/perfect-privacy.md#vpn-server-port-forwarding), [Private Internet Access](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/private-internet-access.md#vpn-server-port-forwarding) and [ProtonVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/protonvpn.md#vpn-server-port-forwarding)
 - Possibility of split horizon DNS by selecting multiple DNS over TLS providers
 - Unbound subprogram drops root privileges once launched
 - Can work as a Kubernetes sidecar container, thanks @rorph
@@ -83,9 +82,9 @@ Lightweight swiss-knife-like VPN client to multiple VPN service providers
 
 🎉 There are now instructions specific to each VPN provider with examples to help you get started as quickly as possible!
 
-Go to the [Wiki](https://github.com/qdm12/gluetun/wiki)!
+Go to the [Wiki](https://github.com/qdm12/gluetun-wiki)!
 
-[🐛 Found a bug in the Wiki?!](https://github.com/qdm12/gluetun/issues/new?assignees=&labels=%F0%9F%93%84+Wiki+issue&template=wiki+issue.yml&title=Wiki+issue%3A+)
+[🐛 Found a bug in the Wiki?!](https://github.com/qdm12/gluetun-wiki/issues/new/choose)
 
 Here's a docker-compose.yml for the laziest:
 
@@ -95,7 +94,8 @@ services:
   gluetun:
     image: qmcgaw/gluetun
     # container_name: gluetun
-    # line above must be uncommented to allow external containers to connect. See https://github.com/qdm12/gluetun/wiki/Connect-a-container-to-gluetun#external-container-to-gluetun
+    # line above must be uncommented to allow external containers to connect.
+    # See https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-container-to-gluetun.md#external-container-to-gluetun
     cap_add:
       - NET_ADMIN
     devices:
@@ -107,7 +107,7 @@ services:
     volumes:
       - /yourpath:/gluetun
     environment:
-      # See https://github.com/qdm12/gluetun/wiki
+      # See https://github.com/qdm12/gluetun-wiki/tree/main/setup#setup
       - VPN_SERVICE_PROVIDER=ivpn
       - VPN_TYPE=openvpn
       # OpenVPN:
@@ -118,13 +118,13 @@ services:
       # - WIREGUARD_ADDRESSES=10.64.222.21/32
       # Timezone for accurate log times
       - TZ=
-      # Server list updater. See https://github.com/qdm12/gluetun/wiki/Updating-Servers#periodic-update
+      # Server list updater
+      # See https://github.com/qdm12/gluetun-wiki/blob/main/setup/servers.md#update-the-vpn-servers-list
       - UPDATER_PERIOD=
-      - UPDATER_VPN_SERVICE_PROVIDERS=
 ```
 
 🆕 Image also available as `ghcr.io/qdm12/gluetun`
 
 ## License
 
-[![MIT](https://img.shields.io/github/license/qdm12/gluetun)](https://github.com/qdm12/gluetun/master/LICENSE)
+[![MIT](https://img.shields.io/github/license/qdm12/gluetun)](https://github.com/qdm12/gluetun/blob/master/LICENSE)

cmd/gluetun/main.go

@@ -17,9 +17,7 @@ import (
 	"github.com/qdm12/gluetun/internal/alpine"
 	"github.com/qdm12/gluetun/internal/cli"
 	"github.com/qdm12/gluetun/internal/configuration/settings"
-	"github.com/qdm12/gluetun/internal/configuration/sources/env"
 	"github.com/qdm12/gluetun/internal/configuration/sources/files"
-	mux "github.com/qdm12/gluetun/internal/configuration/sources/merge"
 	"github.com/qdm12/gluetun/internal/configuration/sources/secrets"
 	"github.com/qdm12/gluetun/internal/constants"
 	"github.com/qdm12/gluetun/internal/dns"
@@ -34,7 +32,7 @@ import (
 	"github.com/qdm12/gluetun/internal/pprof"
 	"github.com/qdm12/gluetun/internal/provider"
 	"github.com/qdm12/gluetun/internal/publicip"
-	"github.com/qdm12/gluetun/internal/publicip/ipinfo"
+	pubipapi "github.com/qdm12/gluetun/internal/publicip/api"
 	"github.com/qdm12/gluetun/internal/routing"
 	"github.com/qdm12/gluetun/internal/server"
 	"github.com/qdm12/gluetun/internal/shadowsocks"
@@ -45,6 +43,8 @@ import (
 	"github.com/qdm12/gluetun/internal/updater/unzip"
 	"github.com/qdm12/gluetun/internal/vpn"
 	"github.com/qdm12/golibs/command"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/reader/sources/env"
 	"github.com/qdm12/goshutdown"
 	"github.com/qdm12/goshutdown/goroutine"
 	"github.com/qdm12/goshutdown/group"
@@ -82,14 +82,21 @@ func main() {
 	cli := cli.New()
 	cmder := command.NewCmder()
 
-	envReader := env.New(logger)
+	reader := reader.New(reader.Settings{
-	filesReader := files.New()
+		Sources: []reader.Source{
-	secretsReader := secrets.New()
+			secrets.New(logger),
-	muxReader := mux.New(envReader, filesReader, secretsReader)
+			files.New(logger),
+			env.New(env.Settings{}),
+		},
+		HandleDeprecatedKey: func(source, deprecatedKey, currentKey string) {
+			logger.Warn("You are using the old " + source + " " + deprecatedKey +
+				", please consider changing it to " + currentKey)
+		},
+	})
 
 	errorCh := make(chan error)
 	go func() {
-		errorCh <- _main(ctx, buildInfo, args, logger, muxReader, tun, netLinker, cmder, cli)
+		errorCh <- _main(ctx, buildInfo, args, logger, reader, tun, netLinker, cmder, cli)
 	}()
 
 	var err error
@@ -139,17 +146,17 @@ var (
 
 //nolint:gocognit,gocyclo,maintidx
 func _main(ctx context.Context, buildInfo models.BuildInformation,
-	args []string, logger log.LoggerInterface, source Source,
+	args []string, logger log.LoggerInterface, reader *reader.Reader,
 	tun Tun, netLinker netLinker, cmder command.RunStarter,
 	cli clier) error {
 	if len(args) > 1 { // cli operation
 		switch args[1] {
 		case "healthcheck":
-			return cli.HealthCheck(ctx, source, logger)
+			return cli.HealthCheck(ctx, reader, logger)
 		case "clientkey":
 			return cli.ClientKey(args[2:])
 		case "openvpnconfig":
-			return cli.OpenvpnConfig(logger, source, netLinker)
+			return cli.OpenvpnConfig(logger, reader, netLinker)
 		case "update":
 			return cli.Update(ctx, args[2:], logger)
 		case "format-servers":
@@ -159,7 +166,7 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 		}
 	}
 
-	announcementExp, err := time.Parse(time.RFC3339, "2021-02-15T00:00:00Z")
+	announcementExp, err := time.Parse(time.RFC3339, "2023-07-01T00:00:00Z")
 	if err != nil {
 		return err
 	}
@@ -169,8 +176,8 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 		Emails:       []string{"quentin.mcgaw@gmail.com"},
 		Version:      buildInfo.Version,
 		Commit:       buildInfo.Commit,
-		BuildDate:    buildInfo.Created,
+		Created:      buildInfo.Created,
-		Announcement: "Large settings parsing refactoring merged on 2022-01-06, please report any issue!",
+		Announcement: "Wiki moved to https://github.com/qdm12/gluetun-wiki",
 		AnnounceExp:  announcementExp,
 		// Sponsor information
 		PaypalUser:    "qmcgaw",
@@ -180,17 +187,22 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 		fmt.Println(line)
 	}
 
-	allSettings, err := source.Read()
+	var allSettings settings.Settings
+	err = allSettings.Read(reader)
 	if err != nil {
 		return err
 	}
+	allSettings.SetDefaults()
 
 	// Note: no need to validate minimal settings for the firewall:
-	// - global log level is parsed from source
+	// - global log level is parsed below
 	// - firewall Debug and Enabled are booleans parsed from source
-
+	logLevel, err := log.ParseLevel(allSettings.Log.Level)
-	logger.Patch(log.SetLevel(*allSettings.Log.Level))
+	if err != nil {
-	netLinker.PatchLoggerLevel(*allSettings.Log.Level)
+		return fmt.Errorf("log level: %w", err)
+	}
+	logger.Patch(log.SetLevel(logLevel))
+	netLinker.PatchLoggerLevel(logLevel)
 
 	routingLogger := logger.New(log.SetComponent("routing"))
 	if *allSettings.Firewall.Debug { // To remove in v4
@@ -264,12 +276,10 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 
 	err = printVersions(ctx, logger, []printVersionElement{
 		{name: "Alpine", getVersion: alpineConf.Version},
-		{name: "OpenVPN 2.4", getVersion: ovpnConf.Version24},
 		{name: "OpenVPN 2.5", getVersion: ovpnConf.Version25},
+		{name: "OpenVPN 2.6", getVersion: ovpnConf.Version26},
 		{name: "Unbound", getVersion: dnsConf.Version},
-		{name: "IPtables", getVersion: func(ctx context.Context) (version string, err error) {
+		{name: "IPtables", getVersion: firewallConf.Version},
-			return firewall.Version(ctx, cmder)
-		}},
 	})
 	if err != nil {
 		return err
@@ -331,11 +341,15 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 	}
 
 	const tunDevice = "/dev/net/tun"
-	if err := tun.Check(tunDevice); err != nil {
+	err = tun.Check(tunDevice)
+	if err != nil {
+		if !errors.Is(err, os.ErrNotExist) {
+			return fmt.Errorf("checking TUN device: %w (see the Wiki errors/tun page)", err)
+		}
 		logger.Info(err.Error() + "; creating it...")
 		err = tun.Create(tunDevice)
 		if err != nil {
-			return err
+			return fmt.Errorf("creating tun device: %w", err)
 		}
 	}
 
@@ -376,12 +390,13 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 
 	portForwardLogger := logger.New(log.SetComponent("port forwarding"))
 	portForwardLooper := portforward.NewLoop(allSettings.VPN.Provider.PortForwarding,
-		httpClient, firewallConf, portForwardLogger, puid, pgid)
+		routingConf, httpClient, firewallConf, portForwardLogger, puid, pgid)
-	portForwardHandler, portForwardCtx, portForwardDone := goshutdown.NewGoRoutineHandler(
+	portForwardRunError, err := portForwardLooper.Start(ctx)
-		"port forwarding", goroutine.OptionTimeout(time.Second))
+	if err != nil {
-	go portForwardLooper.Run(portForwardCtx, portForwardDone)
+		return fmt.Errorf("starting port forwarding loop: %w", err)
+	}
 
-	unboundLogger := logger.New(log.SetComponent("dns over tls"))
+	unboundLogger := logger.New(log.SetComponent("dns"))
 	unboundLooper := dns.NewLoop(dnsConf, allSettings.DNS, httpClient,
 		unboundLogger)
 	dnsHandler, dnsCtx, dnsDone := goshutdown.NewGoRoutineHandler(
@@ -395,19 +410,18 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 	go unboundLooper.RunRestartTicker(dnsTickerCtx, dnsTickerDone)
 	controlGroupHandler.Add(dnsTickerHandler)
 
-	ipFetcher := ipinfo.New(httpClient)
+	publicipAPI, _ := pubipapi.ParseProvider(allSettings.PublicIP.API)
+	ipFetcher, err := pubipapi.New(publicipAPI, httpClient, *allSettings.PublicIP.APIToken)
+	if err != nil {
+		return fmt.Errorf("creating public IP API client: %w", err)
+	}
 	publicIPLooper := publicip.NewLoop(ipFetcher,
 		logger.New(log.SetComponent("ip getter")),
 		allSettings.PublicIP, puid, pgid)
-	pubIPHandler, pubIPCtx, pubIPDone := goshutdown.NewGoRoutineHandler(
+	publicIPRunError, err := publicIPLooper.Start(ctx)
-		"public IP", goroutine.OptionTimeout(defaultShutdownTimeout))
+	if err != nil {
-	go publicIPLooper.Run(pubIPCtx, pubIPDone)
+		return fmt.Errorf("starting public ip loop: %w", err)
-	otherGroupHandler.Add(pubIPHandler)
+	}
-
-	pubIPTickerHandler, pubIPTickerCtx, pubIPTickerDone := goshutdown.NewGoRoutineHandler(
-		"public IP", goroutine.OptionTimeout(defaultShutdownTimeout))
-	go publicIPLooper.RunRestartTicker(pubIPTickerCtx, pubIPTickerDone)
-	tickersGroupHandler.Add(pubIPTickerHandler)
 
 	updaterLogger := logger.New(log.SetComponent("updater"))
 
@@ -481,13 +495,31 @@ func _main(ctx context.Context, buildInfo models.BuildInformation,
 		order.OptionOnSuccess(defaultShutdownOnSuccess),
 		order.OptionOnFailure(defaultShutdownOnFailure))
 	orderHandler.Append(controlGroupHandler, tickersGroupHandler, healthServerHandler,
-		vpnHandler, portForwardHandler, otherGroupHandler)
+		vpnHandler, otherGroupHandler)
 
 	// Start VPN for the first time in a blocking call
 	// until the VPN is launched
 	_, _ = vpnLooper.ApplyStatus(ctx, constants.Running) // TODO option to disable with variable
 
-	<-ctx.Done()
+	select {
+	case <-ctx.Done():
+		stoppers := []interface {
+			String() string
+			Stop() error
+		}{
+			portForwardLooper, publicIPLooper,
+		}
+		for _, stopper := range stoppers {
+			err := stopper.Stop()
+			if err != nil {
+				logger.Error(fmt.Sprintf("stopping %s: %s", stopper, err))
+			}
+		}
+	case err := <-portForwardRunError:
+		logger.Errorf("port forwarding loop crashed: %s", err)
+	case err := <-publicIPRunError:
+		logger.Errorf("public IP loop crashed: %s", err)
+	}
 
 	return orderHandler.Shutdown(context.Background())
 }
@@ -531,38 +563,37 @@ type netLinker interface {
 type Addresser interface {
 	AddrList(link netlink.Link, family int) (
 		addresses []netlink.Addr, err error)
-	AddrAdd(link netlink.Link, addr *netlink.Addr) error
+	AddrReplace(link netlink.Link, addr netlink.Addr) error
 }
 
 type Router interface {
-	RouteList(link netlink.Link, family int) (
+	RouteList(family int) (routes []netlink.Route, err error)
-		routes []netlink.Route, err error)
+	RouteAdd(route netlink.Route) error
-	RouteAdd(route *netlink.Route) error
+	RouteDel(route netlink.Route) error
-	RouteDel(route *netlink.Route) error
+	RouteReplace(route netlink.Route) error
-	RouteReplace(route *netlink.Route) error
 }
 
 type Ruler interface {
 	RuleList(family int) (rules []netlink.Rule, err error)
-	RuleAdd(rule *netlink.Rule) error
+	RuleAdd(rule netlink.Rule) error
-	RuleDel(rule *netlink.Rule) error
+	RuleDel(rule netlink.Rule) error
 }
 
 type Linker interface {
 	LinkList() (links []netlink.Link, err error)
 	LinkByName(name string) (link netlink.Link, err error)
 	LinkByIndex(index int) (link netlink.Link, err error)
-	LinkAdd(link netlink.Link) (err error)
+	LinkAdd(link netlink.Link) (linkIndex int, err error)
 	LinkDel(link netlink.Link) (err error)
-	LinkSetUp(link netlink.Link) (err error)
+	LinkSetUp(link netlink.Link) (linkIndex int, err error)
 	LinkSetDown(link netlink.Link) (err error)
 }
 
 type clier interface {
 	ClientKey(args []string) error
 	FormatServers(args []string) error
-	OpenvpnConfig(logger cli.OpenvpnConfigLogger, source cli.Source, ipv6Checker cli.IPv6Checker) error
+	OpenvpnConfig(logger cli.OpenvpnConfigLogger, reader *reader.Reader, ipv6Checker cli.IPv6Checker) error
-	HealthCheck(ctx context.Context, source cli.Source, warner cli.Warner) error
+	HealthCheck(ctx context.Context, reader *reader.Reader, warner cli.Warner) error
 	Update(ctx context.Context, args []string, logger cli.UpdaterLogger) error
 }
 
@@ -570,9 +601,3 @@ type Tun interface {
 	Check(tunDevice string) error
 	Create(tunDevice string) error
 }
-
-type Source interface {
-	Read() (settings settings.Settings, err error)
-	ReadHealth() (health settings.Health, err error)
-	String() string
-}

go.mod

@@ -1,50 +1,56 @@
 module github.com/qdm12/gluetun
 
-go 1.20
+go 1.22
 
 require (
-	github.com/breml/rootcerts v0.2.10
+	github.com/breml/rootcerts v0.2.17
-	github.com/fatih/color v1.15.0
+	github.com/fatih/color v1.17.0
 	github.com/golang/mock v1.6.0
+	github.com/klauspost/compress v1.17.8
+	github.com/klauspost/pgzip v1.2.6
 	github.com/qdm12/dns v1.11.0
 	github.com/qdm12/golibs v0.0.0-20210822203818-5c568b0777b6
+	github.com/qdm12/gosettings v0.4.2
 	github.com/qdm12/goshutdown v0.3.0
-	github.com/qdm12/gosplash v0.1.0
+	github.com/qdm12/gosplash v0.2.0
 	github.com/qdm12/gotree v0.2.0
-	github.com/qdm12/govalid v0.1.0
 	github.com/qdm12/log v0.1.0
-	github.com/qdm12/ss-server v0.4.0
+	github.com/qdm12/ss-server v0.6.0
 	github.com/qdm12/updated v0.0.0-20210603204757-205acfe6937e
-	github.com/stretchr/testify v1.8.2
+	github.com/stretchr/testify v1.9.0
+	github.com/ulikunitz/xz v0.5.11
 	github.com/vishvananda/netlink v1.2.1-beta.2
 	github.com/youmark/pkcs8 v0.0.0-20201027041543-1326539a0a0a
-	golang.org/x/exp v0.0.0-20230519143937-03e91628a987
+	golang.org/x/net v0.25.0
-	golang.org/x/net v0.10.0
+	golang.org/x/sys v0.20.0
-	golang.org/x/sys v0.8.0
+	golang.org/x/text v0.15.0
-	golang.org/x/text v0.9.0
+	golang.zx2c4.com/wireguard v0.0.0-20231211153847-12269c276173
-	golang.zx2c4.com/wireguard v0.0.0-20230325221338-052af4a8072b
+	golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230429144221-925a1e7659e6
-	golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230215201556-9c5414ab4bde
+	gopkg.in/ini.v1 v1.67.0
 	inet.af/netaddr v0.0.0-20220811202034-502d2d690317
 )
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/google/go-cmp v0.5.9 // indirect
-	github.com/josharian/native v1.0.0 // indirect
+	github.com/josharian/native v1.1.0 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
-	github.com/mattn/go-isatty v0.0.17 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
-	github.com/mdlayher/genetlink v1.2.0 // indirect
+	github.com/mdlayher/genetlink v1.3.2 // indirect
-	github.com/mdlayher/netlink v1.6.2 // indirect
+	github.com/mdlayher/netlink v1.7.2 // indirect
-	github.com/mdlayher/socket v0.2.3 // indirect
+	github.com/mdlayher/socket v0.4.1 // indirect
 	github.com/miekg/dns v1.1.40 // indirect
 	github.com/mr-tron/base58 v1.2.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/riobard/go-bloom v0.0.0-20200614022211-cdc8013cb5b3 // indirect
 	github.com/vishvananda/netns v0.0.0-20200728191858-db3c7e526aae // indirect
 	go4.org/intern v0.0.0-20211027215823-ae77deb06f29 // indirect
-	go4.org/unsafe/assume-no-moving-gc v0.0.0-20230221090011-e4bae7ad2296 // indirect
+	go4.org/unsafe/assume-no-moving-gc v0.0.0-20230525183740-e7c30c78aeb2 // indirect
-	golang.org/x/crypto v0.6.0 // indirect
+	golang.org/x/crypto v0.23.0 // indirect
+	golang.org/x/exp v0.0.0-20231110203233-9a3e6036ecaa // indirect
 	golang.org/x/sync v0.1.0 // indirect
 	golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
+	kernel.org/pub/linux/libs/security/libcap/cap v1.2.69 // indirect
+	kernel.org/pub/linux/libs/security/libcap/psx v1.2.69 // indirect
 )

go.sum

@@ -4,8 +4,8 @@ github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/g
 github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
 github.com/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY=
-github.com/breml/rootcerts v0.2.10 h1:UGVZ193UTSUASpGtg6pbDwzOd7XQP+at0Ssg1/2E4h8=
+github.com/breml/rootcerts v0.2.17 h1:0/M2BE2Apw0qEJCXDOkaiu7d5Sx5ObNfe1BkImJ4u1I=
-github.com/breml/rootcerts v0.2.10/go.mod h1:24FDtzYMpqIeYC7QzaE8VPRQaFZU5TIUDlyk8qwjD88=
+github.com/breml/rootcerts v0.2.17/go.mod h1:S/PKh+4d1HUn4HQovEB8hPJZO6pUZYrIhmXBhsegfXw=
 github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
@@ -14,8 +14,8 @@ github.com/docker/go-units v0.3.3/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDD
 github.com/dvyukov/go-fuzz v0.0.0-20210103155950-6a8e9d1f2415/go.mod h1:11Gm+ccJnvAhCNLlf5+cS9KjtbaD5I5zaZpFMsTHWTw=
 github.com/emirpasic/gods v1.12.0/go.mod h1:YfzfFFoVP/catgzJb4IKIqXjX78Ha8FMSDh3ymbK86o=
 github.com/fatih/color v1.12.0/go.mod h1:ELkj/draVOlAH/xkhN6mQ50Qd0MPOk5AAr3maGEBuJM=
-github.com/fatih/color v1.15.0 h1:kOqh6YHBtK8aywxGerMG2Eq3H6Qgoqeo13Bk2Mv/nBs=
+github.com/fatih/color v1.17.0 h1:GlRw1BRJxkpqUCBKzKOw098ed57fEsKeNjpTe3cSjK4=
-github.com/fatih/color v1.15.0/go.mod h1:0h5ZqXfHYED7Bhv2ZJamyIOUej9KtShiJESRwBDUSsw=
+github.com/fatih/color v1.17.0/go.mod h1:YZ7TlrGPkiz6ku9fK3TLD/pl3CpsiFyu8N92HLgmosI=
 github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc=
 github.com/gliderlabs/ssh v0.2.2/go.mod h1:U7qILu1NlMHj9FlMhZLlkCdDnU1DBEAqr0aevW3Awn0=
 github.com/globalsign/mgo v0.0.0-20180905125535-1ca0a4f7cbcb/go.mod h1:xkRDCp4j0OGD1HRkm4kmhM+pmpv3AKq5SU7GMg4oO/Q=
@@ -37,18 +37,21 @@ github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc=
 github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs=
 github.com/gomodule/redigo v2.0.0+incompatible/go.mod h1:B4C85qUVwatsJoIUNIfCRsp7qO0iAmpGFZ4EELWSbC4=
 github.com/google/btree v1.0.1 h1:gK4Kx5IaGY9CD5sPJ36FHiBJ6ZXl0kilRiiCj+jdYp4=
+github.com/google/btree v1.0.1/go.mod h1:xXMiIv4Fb/0kKde4SpL7qlzvu5cMJDRkFDxJfI9uaxA=
 github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
-github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8/DtOE=
 github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
 github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/gotify/go-api-client/v2 v2.0.4/go.mod h1:VKiah/UK20bXsr0JObE1eBVLW44zbBouzjuri9iwjFU=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
-github.com/josharian/native v1.0.0 h1:Ts/E8zCSEsG17dUqv7joXJFybuMLjQfWE04tsBODTxk=
+github.com/josharian/native v1.1.0 h1:uuaP0hAbW7Y4l0ZRQ6C9zfb7Mg1mbFKry/xzDAfmtLA=
-github.com/josharian/native v1.0.0/go.mod h1:7X/raswPFr05uY3HiLlYeyQntB6OO7E/d2Cu7qoaN2w=
+github.com/josharian/native v1.1.0/go.mod h1:7X/raswPFr05uY3HiLlYeyQntB6OO7E/d2Cu7qoaN2w=
 github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
+github.com/klauspost/compress v1.17.8 h1:YcnTYrq7MikUT7k0Yb5eceMmALQPYBW/Xltxn0NAMnU=
+github.com/klauspost/compress v1.17.8/go.mod h1:Di0epgTjJY877eYKx5yC51cX2A2Vl2ibi7bDH9ttBbw=
+github.com/klauspost/pgzip v1.2.6 h1:8RXeL5crjEUFnR2/Sn6GJNWtSQ3Dk8pq4CL3jvdDyjU=
+github.com/klauspost/pgzip v1.2.6/go.mod h1:Ch1tH69qFZu15pkjo5kYi6mth2Zzwzt50oCQKQE9RUs=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
@@ -62,19 +65,18 @@ github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxec
 github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
 github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
-github.com/mattn/go-isatty v0.0.17 h1:BTarxUcIeDqL27Mc+vyvdWYSL28zpIhv3RoTdsLMPng=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
-github.com/mattn/go-isatty v0.0.17/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
-github.com/mdlayher/genetlink v1.2.0 h1:4yrIkRV5Wfk1WfpWTcoOlGmsWgQj3OtQN9ZsbrE+XtU=
+github.com/mdlayher/genetlink v1.3.2 h1:KdrNKe+CTu+IbZnm/GVUMXSqBBLqcGpRDa0xkQy56gw=
-github.com/mdlayher/genetlink v1.2.0/go.mod h1:ra5LDov2KrUCZJiAtEvXXZBxGMInICMXIwshlJ+qRxQ=
+github.com/mdlayher/genetlink v1.3.2/go.mod h1:tcC3pkCrPUGIKKsCsp0B3AdaaKuHtaxoJRz3cc+528o=
-github.com/mdlayher/netlink v1.6.0/go.mod h1:0o3PlBmGst1xve7wQ7j/hwpNaFaH4qCRyWCdcZk8/vA=
+github.com/mdlayher/netlink v1.7.2 h1:/UtM3ofJap7Vl4QWCPDGXY8d3GIY2UGSDbK+QWmY8/g=
-github.com/mdlayher/netlink v1.6.2 h1:D2zGSkvYsJ6NreeED3JiVTu1lj2sIYATqSaZlhPzUgQ=
+github.com/mdlayher/netlink v1.7.2/go.mod h1:xraEF7uJbxLhc5fpHL4cPe221LI2bdttWlU+ZGLfQSw=
-github.com/mdlayher/netlink v1.6.2/go.mod h1:O1HXX2sIWSMJ3Qn1BYZk1yZM+7iMki/uYGGiwGyq/iU=
+github.com/mdlayher/socket v0.4.1 h1:eM9y2/jlbs1M615oshPQOHZzj6R6wMT7bX5NPiQvn2U=
-github.com/mdlayher/socket v0.1.1/go.mod h1:mYV5YIZAfHh4dzDVzI8x8tWLWCliuX8Mon5Awbj+qDs=
+github.com/mdlayher/socket v0.4.1/go.mod h1:cAqeGjoufqdxWkD7DkpyS+wcefOtmu5OQ8KuoJGIReA=
-github.com/mdlayher/socket v0.2.3 h1:XZA2X2TjdOwNoNPVPclRCURoX/hokBY8nkTmRZFEheM=
-github.com/mdlayher/socket v0.2.3/go.mod h1:bz12/FozYNH/VbvC3q7TRIK/Y6dH1kCKsXaUeXi/FmY=
 github.com/miekg/dns v1.1.40 h1:pyyPFfGMnciYUk/mXpKkVmeMQjfXqt3FAJ2hy7tPiLA=
 github.com/miekg/dns v1.1.40/go.mod h1:KNUDUusw/aVsxyTYZM1oqvCicbwhgbNgztCETuNZ7xM=
 github.com/mikioh/ipaddr v0.0.0-20190404000644-d465c8ab6721 h1:RlZweED6sbSArvlE924+mUcZuXKLBHA35U7LN621Bws=
+github.com/mikioh/ipaddr v0.0.0-20190404000644-d465c8ab6721/go.mod h1:Ickgr2WtCLZ2MDGd4Gr0geeCH5HybhRJbonOgQpvSxc=
 github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
 github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
 github.com/mr-tron/base58 v1.2.0 h1:T/HDJBh4ZCPbU39/+c3rRvE0uKBQlU27+QI8LJ4t64o=
@@ -91,18 +93,18 @@ github.com/qdm12/golibs v0.0.0-20210603202746-e5494e9c2ebb/go.mod h1:15RBzkun0i8
 github.com/qdm12/golibs v0.0.0-20210723175634-a75ca7fd74c2/go.mod h1:6aRbg4Z/bTbm9JfxsGXfWKHi7zsOvPfUTK1S5HuAFKg=
 github.com/qdm12/golibs v0.0.0-20210822203818-5c568b0777b6 h1:bge5AL7cjHJMPz+5IOz5yF01q/l8No6+lIEBieA8gMg=
 github.com/qdm12/golibs v0.0.0-20210822203818-5c568b0777b6/go.mod h1:6aRbg4Z/bTbm9JfxsGXfWKHi7zsOvPfUTK1S5HuAFKg=
+github.com/qdm12/gosettings v0.4.2 h1:Gb39NScPr7OQV+oy0o1OD7A121udITDJuUGa7ljDF58=
+github.com/qdm12/gosettings v0.4.2/go.mod h1:CPrt2YC4UsURTrslmhxocVhMCW03lIrqdH2hzIf5prg=
 github.com/qdm12/goshutdown v0.3.0 h1:pqBpJkdwlZlfTEx4QHtS8u8CXx6pG0fVo6S1N0MpSEM=
 github.com/qdm12/goshutdown v0.3.0/go.mod h1:EqZ46No00kCTZ5qzdd3qIzY6ayhMt24QI8Mh8LVQYmM=
-github.com/qdm12/gosplash v0.1.0 h1:Sfl+zIjFZFP7b0iqf2l5UkmEY97XBnaKkH3FNY6Gf7g=
+github.com/qdm12/gosplash v0.2.0 h1:DOxCEizbW6ZG+FgpH2oK1atT6bM8MHL9GZ2ywSS4zZY=
-github.com/qdm12/gosplash v0.1.0/go.mod h1:+A3fWW4/rUeDXhY3ieBzwghKdnIPFJgD8K3qQkenJlw=
+github.com/qdm12/gosplash v0.2.0/go.mod h1:k+1PzhO0th9cpX4q2Nneu4xTsndXqrM/x7NTIYmJ4jo=
 github.com/qdm12/gotree v0.2.0 h1:+58ltxkNLUyHtATFereAcOjBVfY6ETqRex8XK90Fb/c=
 github.com/qdm12/gotree v0.2.0/go.mod h1:1SdFaqKZuI46U1apbXIf25pDMNnrPuYLEqMF/qL4lY4=
-github.com/qdm12/govalid v0.1.0 h1:UIFVmuaAg0Q+h0GeyfcFEZ5sQ5KJPvRQwycC1/cqDN8=
-github.com/qdm12/govalid v0.1.0/go.mod h1:CyS/OEQdOvunBgrtIsW93fjd4jBkwZPBjGSpxq3NwA4=
 github.com/qdm12/log v0.1.0 h1:jYBd/xscHYpblzZAd2kjZp2YmuYHjAAfbTViJWxoPTw=
 github.com/qdm12/log v0.1.0/go.mod h1:Vchi5M8uBvHfPNIblN4mjXn/oSbiWguQIbsgF1zdQPI=
-github.com/qdm12/ss-server v0.4.0 h1:lMMYfDGc9P86Lyvd3+p8lK4hhgHUKDzjZC91FqJYkDU=
+github.com/qdm12/ss-server v0.6.0 h1:OaOdCIBXx0z3DGHPT6Th0v88vGa3MtAS4oRgUsDHGZE=
-github.com/qdm12/ss-server v0.4.0/go.mod h1:AY0p4huvPUPW+/CiWsJcDgT6sneDryk26VXSccPNCxY=
+github.com/qdm12/ss-server v0.6.0/go.mod h1:0BO/zEmtTiLDlmQEcjtoHTC+w+cWxwItjBuGP6TWM78=
 github.com/qdm12/updated v0.0.0-20210603204757-205acfe6937e h1:4q+uFLawkaQRq3yARYLsjJPZd2wYwxn4g6G/5v0xW1g=
 github.com/qdm12/updated v0.0.0-20210603204757-205acfe6937e/go.mod h1:UvJRGkZ9XL3/D7e7JiTTVLm1F3Cymd3/gFpD6frEpBo=
 github.com/riobard/go-bloom v0.0.0-20200614022211-cdc8013cb5b3 h1:f/FNXud6gA3MNr8meMVVGxhp+QBTqY91tM8HjEuMjGg=
@@ -111,16 +113,14 @@ github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAm
 github.com/src-d/gcfg v1.4.0/go.mod h1:p/UMsR43ujA89BJY9duynAwIpvqEujIH/jFlfL7jWoI=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE=
-github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
-github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
-github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
-github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
+github.com/ulikunitz/xz v0.5.11 h1:kpFauv27b6ynzBNT/Xy+1k+fK4WswhN/6PN5WhFAGw8=
-github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+github.com/ulikunitz/xz v0.5.11/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
 github.com/vishvananda/netlink v1.2.1-beta.2 h1:Llsql0lnQEbHj0I1OuKyp8otXp0r3q0mPkuhwHfStVs=
 github.com/vishvananda/netlink v1.2.1-beta.2/go.mod h1:twkDnbuQxJYemMlGd4JFIcuhgX83tXhKS2B/PRMpOho=
 github.com/vishvananda/netns v0.0.0-20200728191858-db3c7e526aae h1:4hwBBUfQCFe3Cym0ZtKyq7L16eZUtYKs+BaHDN6mAns=
@@ -138,8 +138,8 @@ go4.org/unsafe/assume-no-moving-gc v0.0.0-20201222175341-b30ae309168e/go.mod h1:
 go4.org/unsafe/assume-no-moving-gc v0.0.0-20201222180813-1025295fd063/go.mod h1:FftLjUGFEDu5k8lt0ddY+HcrH/qU/0qk+H8j9/nTl3E=
 go4.org/unsafe/assume-no-moving-gc v0.0.0-20211027215541-db492cf91b37/go.mod h1:FftLjUGFEDu5k8lt0ddY+HcrH/qU/0qk+H8j9/nTl3E=
 go4.org/unsafe/assume-no-moving-gc v0.0.0-20220617031537-928513b29760/go.mod h1:FftLjUGFEDu5k8lt0ddY+HcrH/qU/0qk+H8j9/nTl3E=
-go4.org/unsafe/assume-no-moving-gc v0.0.0-20230221090011-e4bae7ad2296 h1:QJ/xcIANMLApehfgPCHnfK1hZiaMmbaTVmPv7DAoTbo=
+go4.org/unsafe/assume-no-moving-gc v0.0.0-20230525183740-e7c30c78aeb2 h1:WJhcL4p+YeDxmZWg141nRm7XC8IDmhz7lk5GpadO1Sg=
-go4.org/unsafe/assume-no-moving-gc v0.0.0-20230221090011-e4bae7ad2296/go.mod h1:FftLjUGFEDu5k8lt0ddY+HcrH/qU/0qk+H8j9/nTl3E=
+go4.org/unsafe/assume-no-moving-gc v0.0.0-20230525183740-e7c30c78aeb2/go.mod h1:FftLjUGFEDu5k8lt0ddY+HcrH/qU/0qk+H8j9/nTl3E=
 golang.org/x/crypto v0.0.0-20190219172222-a4c6cb3142f2/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
@@ -148,31 +148,26 @@ golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073/go.mod h1:LzIPMQfyMNhhGPh
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8=
 golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
-golang.org/x/crypto v0.6.0 h1:qfktjS5LUO+fFKeJXZ+ikTRijMmljikvG68fpMMruSc=
+golang.org/x/crypto v0.23.0 h1:dIJU/v2J8Mdglj/8rJ6UUOM3Zc9zLZxVZwwxMooUSAI=
-golang.org/x/crypto v0.6.0/go.mod h1:OFC/31mSvZgRz0V1QTNCzfAI1aIRzbiufJtkMIlEp58=
+golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
-golang.org/x/exp v0.0.0-20230519143937-03e91628a987 h1:3xJIFvzUFbu4ls0BTBYcgbCGhA63eAOEMxIHugyXJqA=
+golang.org/x/exp v0.0.0-20231110203233-9a3e6036ecaa h1:FRnLl4eNAQl8hwxVVC17teOw8kdjVDVAiFMtgUdTSRQ=
-golang.org/x/exp v0.0.0-20230519143937-03e91628a987/go.mod h1:V1LtkGg67GoY2N1AnLN78QLrzxkLyJw7RJb1gzOOz9w=
+golang.org/x/exp v0.0.0-20231110203233-9a3e6036ecaa/go.mod h1:zk2irFbV9DP96SEBUUAy67IdHUaZuSnrz1n472HUCLE=
 golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
 golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/net v0.0.0-20181005035420-146acd28ed58/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
-golang.org/x/net v0.0.0-20190503192946-f4e77d36d62c/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20190923162816-aa69164e4478/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
 golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
 golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM=
-golang.org/x/net v0.0.0-20210928044308-7d9f5e0b762b/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac=
-golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
+golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
-golang.org/x/net v0.0.0-20220923203811-8be639271d50/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk=
-golang.org/x/net v0.10.0 h1:X2//UzNDwYmtCLn7To6G58Wr6f5ahEAQgKNzv9Y951M=
-golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.0.0-20220923202941-7f9b1623fab7/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
 golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
@@ -188,27 +183,20 @@ golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220128215802-99c3d69c2c27/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220319134239-a9b59b0215f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.8.0 h1:EBmGv8NaZBZTWvrbjNoL6HVt+IVy3QDQpJs7VRIw3tU=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y=
+golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
-golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.15.0 h1:h1V/4gjBv8v9cjcR6+AR5+/cIYK5N/WAgiv4xlsEtAk=
-golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
-golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE=
+golang.org/x/time v0.0.0-20220210224613-90d013bbcef8 h1:vVKdlvoWBphwdxWKrFZEuM0kGgGLxUOYcY4U/2Vjg44=
-golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
+golang.org/x/time v0.0.0-20220210224613-90d013bbcef8/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
-golang.org/x/time v0.0.0-20191024005414-555d28b269f0 h1:/5xXl8Y5W96D+TtHSlonuFqGHIWVuyCkGJLwGh9JJFs=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190729092621-ff9f1409240a/go.mod h1:jcCCGcm9btYwXyDqrUWc6MKQKKGJCWEQ3AfLSRIbEuI=
 golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
@@ -217,17 +205,18 @@ golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
 golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2 h1:B82qJJgjvYKsXS9jeunTOisW56dUokqW/FOteYJJ/yg=
 golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2/go.mod h1:deeaetjYA+DHMHg+sMSMI58GrEteJUUzzw7en6TJQcI=
-golang.zx2c4.com/wireguard v0.0.0-20230325221338-052af4a8072b h1:J1CaxgLerRR5lgx3wnr6L04cJFbWoceSK9JWBdglINo=
+golang.zx2c4.com/wireguard v0.0.0-20231211153847-12269c276173 h1:/jFs0duh4rdb8uIfPMv78iAJGcPKDeqAFnaLBropIC4=
-golang.zx2c4.com/wireguard v0.0.0-20230325221338-052af4a8072b/go.mod h1:tqur9LnfstdR9ep2LaJT4lFUl0EjlHtge+gAjmsHUG4=
+golang.zx2c4.com/wireguard v0.0.0-20231211153847-12269c276173/go.mod h1:tkCQ4FQXmpAgYVh++1cq16/dH4QJtmvpRv19DWGAHSA=
-golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230215201556-9c5414ab4bde h1:ybF7AMzIUikL9x4LgwEmzhXtzRpKNqngme1VGDWz+Nk=
+golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230429144221-925a1e7659e6 h1:CawjfCvYQH2OU3/TnxLx97WDSUDRABfT18pCOYwc2GE=
-golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230215201556-9c5414ab4bde/go.mod h1:mQqgjkW8GQQcJQsbBvK890TKqUK1DfKWkuBGbOkuMHQ=
+golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230429144221-925a1e7659e6/go.mod h1:3rxYc4HtVcSG9gVaTs2GEBdehh+sYPOwKtyUWEOTb80=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA=
+gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
 gopkg.in/src-d/go-billy.v4 v4.3.2/go.mod h1:nDjArDMp+XMs1aFAESLRjfGSgfvoYN0hDfzEk0GjC98=
 gopkg.in/src-d/go-git-fixtures.v3 v3.5.0/go.mod h1:dLBcvytrw/TYZsNTWCnkNF2DSIlzWYqTe3rJR56Ac7g=
 gopkg.in/src-d/go-git.v4 v4.13.1/go.mod h1:nx5NYcxdKxq5fpltdHnPa2Exj4Sx0EclMWZQbYDu2z8=
@@ -237,7 +226,12 @@ gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gvisor.dev/gvisor v0.0.0-20221203005347-703fd9b7fbc0 h1:Wobr37noukisGxpKo5jAsLREcpj61RxrWYzD8uwveOY=
+gvisor.dev/gvisor v0.0.0-20230927004350-cbd86285d259 h1:TbRPT0HtzFP3Cno1zZo7yPzEEnfu8EjLfl6IU9VfqkQ=
+gvisor.dev/gvisor v0.0.0-20230927004350-cbd86285d259/go.mod h1:AVgIgHMwK63XvmAzWG9vLQ41YnVHN0du0tEC46fI7yY=
 inet.af/netaddr v0.0.0-20210511181906-37180328850c/go.mod h1:z0nx+Dh+7N7CC8V5ayHtHGpZpxLQZZxkIaaz6HN65Ls=
 inet.af/netaddr v0.0.0-20220811202034-502d2d690317 h1:U2fwK6P2EqmopP/hFLTOAjWTki0qgd4GMJn5X8wOleU=
 inet.af/netaddr v0.0.0-20220811202034-502d2d690317/go.mod h1:OIezDfdzOgFhuw4HuWapWq2e9l0H9tK4F1j+ETRtF3k=
+kernel.org/pub/linux/libs/security/libcap/cap v1.2.69 h1:N0m3tKYbkRMmDobh/47ngz+AWeV7PcfXMDi8xu3Vrag=
+kernel.org/pub/linux/libs/security/libcap/cap v1.2.69/go.mod h1:Tk5Ip2TuxaWGpccL7//rAsLRH6RQ/jfqTGxuN/+i/FQ=
+kernel.org/pub/linux/libs/security/libcap/psx v1.2.69 h1:IdrOs1ZgwGw5CI+BH6GgVVlOt+LAXoPyh7enr8lfaXs=
+kernel.org/pub/linux/libs/security/libcap/psx v1.2.69/go.mod h1:+l6Ee2F59XiJ2I6WR5ObpC1utCQJZ/VLsEbQCD8RG24=

internal/cli/clientkey.go

@@ -6,13 +6,12 @@ import (
 	"io"
 	"os"
 	"strings"
-
-	"github.com/qdm12/gluetun/internal/configuration/sources/files"
 )
 
 func (c *CLI) ClientKey(args []string) error {
 	flagSet := flag.NewFlagSet("clientkey", flag.ExitOnError)
-	filepath := flagSet.String("path", files.OpenVPNClientKeyPath, "file path to the client.key file")
+	const openVPNClientKeyPath = "/gluetun/client.key" // TODO deduplicate?
+	filepath := flagSet.String("path", openVPNClientKeyPath, "file path to the client.key file")
 	if err := flagSet.Parse(args); err != nil {
 		return err
 	}

internal/cli/formatservers.go

@@ -33,15 +33,20 @@ func addProviderFlag(flagSet *flag.FlagSet, providerToFormat map[string]*bool,
 func (c *CLI) FormatServers(args []string) error {
 	var format, output string
 	allProviders := providers.All()
+	allProviderFlags := make([]string, len(allProviders))
+	for i, provider := range allProviders {
+		allProviderFlags[i] = strings.ReplaceAll(provider, " ", "-")
+	}
+
 	providersToFormat := make(map[string]*bool, len(allProviders))
-	for _, provider := range allProviders {
+	for _, provider := range allProviderFlags {
 		providersToFormat[provider] = new(bool)
 	}
-	flagSet := flag.NewFlagSet("markdown", flag.ExitOnError)
+	flagSet := flag.NewFlagSet("format-servers", flag.ExitOnError)
 	flagSet.StringVar(&format, "format", "markdown", "Format to use which can be: 'markdown'")
 	flagSet.StringVar(&output, "output", "/dev/stdout", "Output file to write the formatted data to")
 	titleCaser := cases.Title(language.English)
-	for _, provider := range allProviders {
+	for _, provider := range allProviderFlags {
 		addProviderFlag(flagSet, providersToFormat, provider, titleCaser)
 	}
 	if err := flagSet.Parse(args); err != nil {
@@ -68,7 +73,13 @@ func (c *CLI) FormatServers(args []string) error {
 			ErrMultipleProvidersToFormat, len(providers),
 			strings.Join(providers, ", "))
 	}
-	providerToFormat := providers[0]
+
+	var providerToFormat string
+	for _, providerToFormat = range allProviders {
+		if strings.ReplaceAll(providerToFormat, " ", "-") == providers[0] {
+			break
+		}
+	}
 
 	logger := newNoopLogger()
 	storage, err := storage.New(logger, constants.ServersData)

internal/cli/healthcheck.go

@@ -6,12 +6,15 @@ import (
 	"net/http"
 	"time"
 
+	"github.com/qdm12/gluetun/internal/configuration/settings"
 	"github.com/qdm12/gluetun/internal/healthcheck"
+	"github.com/qdm12/gosettings/reader"
 )
 
-func (c *CLI) HealthCheck(ctx context.Context, source Source, _ Warner) error {
+func (c *CLI) HealthCheck(ctx context.Context, reader *reader.Reader, _ Warner) (err error) {
 	// Extract the health server port from the configuration.
-	config, err := source.ReadHealth()
+	var config settings.Health
+	err = config.Read(reader)
 	if err != nil {
 		return err
 	}

internal/cli/openvpnconfig.go

@@ -8,12 +8,14 @@ import (
 	"strings"
 	"time"
 
+	"github.com/qdm12/gluetun/internal/configuration/settings"
 	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/models"
 	"github.com/qdm12/gluetun/internal/openvpn/extract"
 	"github.com/qdm12/gluetun/internal/provider"
-	"github.com/qdm12/gluetun/internal/publicip/ipinfo"
 	"github.com/qdm12/gluetun/internal/storage"
 	"github.com/qdm12/gluetun/internal/updater/resolver"
+	"github.com/qdm12/gosettings/reader"
 )
 
 type OpenvpnConfigLogger interface {
@@ -32,21 +34,22 @@ type ParallelResolver interface {
 }
 
 type IPFetcher interface {
-	FetchMultiInfo(ctx context.Context, ips []netip.Addr) (data []ipinfo.Response, err error)
+	FetchInfo(ctx context.Context, ip netip.Addr) (data models.PublicIP, err error)
 }
 
 type IPv6Checker interface {
 	IsIPv6Supported() (supported bool, err error)
 }
 
-func (c *CLI) OpenvpnConfig(logger OpenvpnConfigLogger, source Source,
+func (c *CLI) OpenvpnConfig(logger OpenvpnConfigLogger, reader *reader.Reader,
 	ipv6Checker IPv6Checker) error {
 	storage, err := storage.New(logger, constants.ServersData)
 	if err != nil {
 		return err
 	}
 
-	allSettings, err := source.Read()
+	var allSettings settings.Settings
+	err = allSettings.Read(reader)
 	if err != nil {
 		return err
 	}
@@ -70,7 +73,7 @@ func (c *CLI) OpenvpnConfig(logger OpenvpnConfigLogger, source Source,
 
 	providers := provider.NewProviders(storage, time.Now, warner, client,
 		unzipper, parallelResolver, ipFetcher, openvpnFileExtractor)
-	providerConf := providers.Get(*allSettings.VPN.Provider.Name)
+	providerConf := providers.Get(allSettings.VPN.Provider.Name)
 	connection, err := providerConf.GetConnection(
 		allSettings.VPN.Provider.ServerSelection, ipv6Supported)
 	if err != nil {

internal/cli/update.go

@@ -14,7 +14,7 @@ import (
 	"github.com/qdm12/gluetun/internal/constants/providers"
 	"github.com/qdm12/gluetun/internal/openvpn/extract"
 	"github.com/qdm12/gluetun/internal/provider"
-	"github.com/qdm12/gluetun/internal/publicip/ipinfo"
+	"github.com/qdm12/gluetun/internal/publicip/api"
 	"github.com/qdm12/gluetun/internal/storage"
 	"github.com/qdm12/gluetun/internal/updater"
 	"github.com/qdm12/gluetun/internal/updater/resolver"
@@ -35,7 +35,7 @@ type UpdaterLogger interface {
 func (c *CLI) Update(ctx context.Context, args []string, logger UpdaterLogger) error {
 	options := settings.Updater{}
 	var endUserMode, maintainerMode, updateAll bool
-	var csvProviders string
+	var csvProviders, ipToken string
 	flagSet := flag.NewFlagSet("update", flag.ExitOnError)
 	flagSet.BoolVar(&endUserMode, "enduser", false, "Write results to /gluetun/servers.json (for end users)")
 	flagSet.BoolVar(&maintainerMode, "maintainer", false,
@@ -46,6 +46,7 @@ func (c *CLI) Update(ctx context.Context, args []string, logger UpdaterLogger) e
 		"Minimum ratio of servers to find for the update to succeed")
 	flagSet.BoolVar(&updateAll, "all", false, "Update servers for all VPN providers")
 	flagSet.StringVar(&csvProviders, "providers", "", "CSV string of VPN providers to update server data for")
+	flagSet.StringVar(&ipToken, "ip-token", "", "IP data service token (e.g. ipinfo.io) to use")
 	if err := flagSet.Parse(args); err != nil {
 		return err
 	}
@@ -79,7 +80,10 @@ func (c *CLI) Update(ctx context.Context, args []string, logger UpdaterLogger) e
 	httpClient := &http.Client{Timeout: clientTimeout}
 	unzipper := unzip.New(httpClient)
 	parallelResolver := resolver.NewParallelResolver(options.DNSAddress)
-	ipFetcher := ipinfo.New(httpClient)
+	ipFetcher, err := api.New(api.IPInfo, httpClient, ipToken)
+	if err != nil {
+		return fmt.Errorf("creating public IP API client: %w", err)
+	}
 	openvpnFileExtractor := extract.New()
 
 	providers := provider.NewProviders(storage, time.Now, logger, httpClient,

internal/configuration/settings/dns.go

@@ -4,7 +4,8 @@ import (
 	"fmt"
 	"net/netip"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 )
 
@@ -16,10 +17,14 @@ type DNS struct {
 	// DoT server. It cannot be the zero value in the internal
 	// state.
 	ServerAddress netip.Addr
-	// KeepNameserver is true if the Docker DNS server
+	// KeepNameserver is true if the existing DNS server
-	// found in /etc/resolv.conf should be kept.
+	// found in /etc/resolv.conf should be used
-	// Note settings this to true will go around the
+	// Note setting this to true will likely DNS traffic
-	// DoT server blocking.
+	// outside the VPN tunnel since it would go through
+	// the local DNS server of your Docker/Kubernetes
+	// configuration, which is likely not going through the tunnel.
+	// This will also disable the DNS over TLS server and the
+	// `ServerAddress` field will be ignored.
 	// It defaults to false and cannot be nil in the
 	// internal state.
 	KeepNameserver *bool
@@ -40,32 +45,24 @@ func (d DNS) validate() (err error) {
 func (d *DNS) Copy() (copied DNS) {
 	return DNS{
 		ServerAddress:  d.ServerAddress,
-		KeepNameserver: helpers.CopyPointer(d.KeepNameserver),
+		KeepNameserver: gosettings.CopyPointer(d.KeepNameserver),
 		DoT:            d.DoT.copy(),
 	}
 }
 
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (d *DNS) mergeWith(other DNS) {
-	d.ServerAddress = helpers.MergeWithIP(d.ServerAddress, other.ServerAddress)
-	d.KeepNameserver = helpers.MergeWithPointer(d.KeepNameserver, other.KeepNameserver)
-	d.DoT.mergeWith(other.DoT)
-}
-
 // overrideWith overrides fields of the receiver
 // settings object with any field set in the other
 // settings.
 func (d *DNS) overrideWith(other DNS) {
-	d.ServerAddress = helpers.OverrideWithIP(d.ServerAddress, other.ServerAddress)
+	d.ServerAddress = gosettings.OverrideWithValidator(d.ServerAddress, other.ServerAddress)
-	d.KeepNameserver = helpers.OverrideWithPointer(d.KeepNameserver, other.KeepNameserver)
+	d.KeepNameserver = gosettings.OverrideWithPointer(d.KeepNameserver, other.KeepNameserver)
 	d.DoT.overrideWith(other.DoT)
 }
 
 func (d *DNS) setDefaults() {
 	localhost := netip.AddrFrom4([4]byte{127, 0, 0, 1})
-	d.ServerAddress = helpers.DefaultIP(d.ServerAddress, localhost)
+	d.ServerAddress = gosettings.DefaultValidator(d.ServerAddress, localhost)
-	d.KeepNameserver = helpers.DefaultPointer(d.KeepNameserver, false)
+	d.KeepNameserver = gosettings.DefaultPointer(d.KeepNameserver, false)
 	d.DoT.setDefaults()
 }
 
@@ -75,8 +72,30 @@ func (d DNS) String() string {
 
 func (d DNS) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("DNS settings:")
+	node.Appendf("Keep existing nameserver(s): %s", gosettings.BoolToYesNo(d.KeepNameserver))
+	if *d.KeepNameserver {
+		return node
+	}
 	node.Appendf("DNS server address to use: %s", d.ServerAddress)
-	node.Appendf("Keep existing nameserver(s): %s", helpers.BoolPtrToYesNo(d.KeepNameserver))
 	node.AppendNode(d.DoT.toLinesNode())
 	return node
 }
+
+func (d *DNS) read(r *reader.Reader) (err error) {
+	d.ServerAddress, err = r.NetipAddr("DNS_ADDRESS", reader.RetroKeys("DNS_PLAINTEXT_ADDRESS"))
+	if err != nil {
+		return err
+	}
+
+	d.KeepNameserver, err = r.BoolPtr("DNS_KEEP_NAMESERVER")
+	if err != nil {
+		return err
+	}
+
+	err = d.DoT.read(r)
+	if err != nil {
+		return fmt.Errorf("DNS over TLS settings: %w", err)
+	}
+
+	return nil
+}

internal/configuration/settings/dnsblacklist.go

@@ -7,7 +7,8 @@ import (
 	"regexp"
 
 	"github.com/qdm12/dns/pkg/blacklist"
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 )
 
@@ -23,9 +24,9 @@ type DNSBlacklist struct {
 }
 
 func (b *DNSBlacklist) setDefaults() {
-	b.BlockMalicious = helpers.DefaultPointer(b.BlockMalicious, true)
+	b.BlockMalicious = gosettings.DefaultPointer(b.BlockMalicious, true)
-	b.BlockAds = helpers.DefaultPointer(b.BlockAds, false)
+	b.BlockAds = gosettings.DefaultPointer(b.BlockAds, false)
-	b.BlockSurveillance = helpers.DefaultPointer(b.BlockSurveillance, true)
+	b.BlockSurveillance = gosettings.DefaultPointer(b.BlockSurveillance, true)
 }
 
 var hostRegex = regexp.MustCompile(`^([a-zA-Z0-9]|[a-zA-Z0-9_][a-zA-Z0-9\-_]{0,61}[a-zA-Z0-9_])(\.([a-zA-Z0-9]|[a-zA-Z0-9_][a-zA-Z0-9\-_]{0,61}[a-zA-Z0-9]))*$`) //nolint:lll
@@ -53,34 +54,24 @@ func (b DNSBlacklist) validate() (err error) {
 
 func (b DNSBlacklist) copy() (copied DNSBlacklist) {
 	return DNSBlacklist{
-		BlockMalicious:       helpers.CopyPointer(b.BlockMalicious),
+		BlockMalicious:       gosettings.CopyPointer(b.BlockMalicious),
-		BlockAds:             helpers.CopyPointer(b.BlockAds),
+		BlockAds:             gosettings.CopyPointer(b.BlockAds),
-		BlockSurveillance:    helpers.CopyPointer(b.BlockSurveillance),
+		BlockSurveillance:    gosettings.CopyPointer(b.BlockSurveillance),
-		AllowedHosts:         helpers.CopySlice(b.AllowedHosts),
+		AllowedHosts:         gosettings.CopySlice(b.AllowedHosts),
-		AddBlockedHosts:      helpers.CopySlice(b.AddBlockedHosts),
+		AddBlockedHosts:      gosettings.CopySlice(b.AddBlockedHosts),
-		AddBlockedIPs:        helpers.CopySlice(b.AddBlockedIPs),
+		AddBlockedIPs:        gosettings.CopySlice(b.AddBlockedIPs),
-		AddBlockedIPPrefixes: helpers.CopySlice(b.AddBlockedIPPrefixes),
+		AddBlockedIPPrefixes: gosettings.CopySlice(b.AddBlockedIPPrefixes),
 	}
 }
 
-func (b *DNSBlacklist) mergeWith(other DNSBlacklist) {
-	b.BlockMalicious = helpers.MergeWithPointer(b.BlockMalicious, other.BlockMalicious)
-	b.BlockAds = helpers.MergeWithPointer(b.BlockAds, other.BlockAds)
-	b.BlockSurveillance = helpers.MergeWithPointer(b.BlockSurveillance, other.BlockSurveillance)
-	b.AllowedHosts = helpers.MergeSlices(b.AllowedHosts, other.AllowedHosts)
-	b.AddBlockedHosts = helpers.MergeSlices(b.AddBlockedHosts, other.AddBlockedHosts)
-	b.AddBlockedIPs = helpers.MergeSlices(b.AddBlockedIPs, other.AddBlockedIPs)
-	b.AddBlockedIPPrefixes = helpers.MergeSlices(b.AddBlockedIPPrefixes, other.AddBlockedIPPrefixes)
-}
-
 func (b *DNSBlacklist) overrideWith(other DNSBlacklist) {
-	b.BlockMalicious = helpers.OverrideWithPointer(b.BlockMalicious, other.BlockMalicious)
+	b.BlockMalicious = gosettings.OverrideWithPointer(b.BlockMalicious, other.BlockMalicious)
-	b.BlockAds = helpers.OverrideWithPointer(b.BlockAds, other.BlockAds)
+	b.BlockAds = gosettings.OverrideWithPointer(b.BlockAds, other.BlockAds)
-	b.BlockSurveillance = helpers.OverrideWithPointer(b.BlockSurveillance, other.BlockSurveillance)
+	b.BlockSurveillance = gosettings.OverrideWithPointer(b.BlockSurveillance, other.BlockSurveillance)
-	b.AllowedHosts = helpers.OverrideWithSlice(b.AllowedHosts, other.AllowedHosts)
+	b.AllowedHosts = gosettings.OverrideWithSlice(b.AllowedHosts, other.AllowedHosts)
-	b.AddBlockedHosts = helpers.OverrideWithSlice(b.AddBlockedHosts, other.AddBlockedHosts)
+	b.AddBlockedHosts = gosettings.OverrideWithSlice(b.AddBlockedHosts, other.AddBlockedHosts)
-	b.AddBlockedIPs = helpers.OverrideWithSlice(b.AddBlockedIPs, other.AddBlockedIPs)
+	b.AddBlockedIPs = gosettings.OverrideWithSlice(b.AddBlockedIPs, other.AddBlockedIPs)
-	b.AddBlockedIPPrefixes = helpers.OverrideWithSlice(b.AddBlockedIPPrefixes, other.AddBlockedIPPrefixes)
+	b.AddBlockedIPPrefixes = gosettings.OverrideWithSlice(b.AddBlockedIPPrefixes, other.AddBlockedIPPrefixes)
 }
 
 func (b DNSBlacklist) ToBlacklistFormat() (settings blacklist.BuilderSettings, err error) {
@@ -102,9 +93,9 @@ func (b DNSBlacklist) String() string {
 func (b DNSBlacklist) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("DNS filtering settings:")
 
-	node.Appendf("Block malicious: %s", helpers.BoolPtrToYesNo(b.BlockMalicious))
+	node.Appendf("Block malicious: %s", gosettings.BoolToYesNo(b.BlockMalicious))
-	node.Appendf("Block ads: %s", helpers.BoolPtrToYesNo(b.BlockAds))
+	node.Appendf("Block ads: %s", gosettings.BoolToYesNo(b.BlockAds))
-	node.Appendf("Block surveillance: %s", helpers.BoolPtrToYesNo(b.BlockSurveillance))
+	node.Appendf("Block surveillance: %s", gosettings.BoolToYesNo(b.BlockSurveillance))
 
 	if len(b.AllowedHosts) > 0 {
 		allowedHostsNode := node.Appendf("Allowed hosts:")
@@ -136,3 +127,66 @@ func (b DNSBlacklist) toLinesNode() (node *gotree.Node) {
 
 	return node
 }
+
+func (b *DNSBlacklist) read(r *reader.Reader) (err error) {
+	b.BlockMalicious, err = r.BoolPtr("BLOCK_MALICIOUS")
+	if err != nil {
+		return err
+	}
+
+	b.BlockSurveillance, err = r.BoolPtr("BLOCK_SURVEILLANCE",
+		reader.RetroKeys("BLOCK_NSA"))
+	if err != nil {
+		return err
+	}
+
+	b.BlockAds, err = r.BoolPtr("BLOCK_ADS")
+	if err != nil {
+		return err
+	}
+
+	b.AddBlockedIPs, b.AddBlockedIPPrefixes,
+		err = readDoTPrivateAddresses(r) // TODO v4 split in 2
+	if err != nil {
+		return err
+	}
+
+	b.AllowedHosts = r.CSV("UNBLOCK") // TODO v4 change name
+
+	return nil
+}
+
+var (
+	ErrPrivateAddressNotValid = errors.New("private address is not a valid IP or CIDR range")
+)
+
+func readDoTPrivateAddresses(reader *reader.Reader) (ips []netip.Addr,
+	ipPrefixes []netip.Prefix, err error) {
+	privateAddresses := reader.CSV("DOT_PRIVATE_ADDRESS")
+	if len(privateAddresses) == 0 {
+		return nil, nil, nil
+	}
+
+	ips = make([]netip.Addr, 0, len(privateAddresses))
+	ipPrefixes = make([]netip.Prefix, 0, len(privateAddresses))
+
+	for _, privateAddress := range privateAddresses {
+		ip, err := netip.ParseAddr(privateAddress)
+		if err == nil {
+			ips = append(ips, ip)
+			continue
+		}
+
+		ipPrefix, err := netip.ParsePrefix(privateAddress)
+		if err == nil {
+			ipPrefixes = append(ipPrefixes, ipPrefix)
+			continue
+		}
+
+		return nil, nil, fmt.Errorf(
+			"environment variable DOT_PRIVATE_ADDRESS: %w: %s",
+			ErrPrivateAddressNotValid, privateAddress)
+	}
+
+	return ips, ipPrefixes, nil
+}

internal/configuration/settings/dot.go

@@ -5,7 +5,8 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 )
 
@@ -54,36 +55,27 @@ func (d DoT) validate() (err error) {
 
 func (d *DoT) copy() (copied DoT) {
 	return DoT{
-		Enabled:      helpers.CopyPointer(d.Enabled),
+		Enabled:      gosettings.CopyPointer(d.Enabled),
-		UpdatePeriod: helpers.CopyPointer(d.UpdatePeriod),
+		UpdatePeriod: gosettings.CopyPointer(d.UpdatePeriod),
 		Unbound:      d.Unbound.copy(),
 		Blacklist:    d.Blacklist.copy(),
 	}
 }
 
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (d *DoT) mergeWith(other DoT) {
-	d.Enabled = helpers.MergeWithPointer(d.Enabled, other.Enabled)
-	d.UpdatePeriod = helpers.MergeWithPointer(d.UpdatePeriod, other.UpdatePeriod)
-	d.Unbound.mergeWith(other.Unbound)
-	d.Blacklist.mergeWith(other.Blacklist)
-}
-
 // overrideWith overrides fields of the receiver
 // settings object with any field set in the other
 // settings.
 func (d *DoT) overrideWith(other DoT) {
-	d.Enabled = helpers.OverrideWithPointer(d.Enabled, other.Enabled)
+	d.Enabled = gosettings.OverrideWithPointer(d.Enabled, other.Enabled)
-	d.UpdatePeriod = helpers.OverrideWithPointer(d.UpdatePeriod, other.UpdatePeriod)
+	d.UpdatePeriod = gosettings.OverrideWithPointer(d.UpdatePeriod, other.UpdatePeriod)
 	d.Unbound.overrideWith(other.Unbound)
 	d.Blacklist.overrideWith(other.Blacklist)
 }
 
 func (d *DoT) setDefaults() {
-	d.Enabled = helpers.DefaultPointer(d.Enabled, true)
+	d.Enabled = gosettings.DefaultPointer(d.Enabled, true)
 	const defaultUpdatePeriod = 24 * time.Hour
-	d.UpdatePeriod = helpers.DefaultPointer(d.UpdatePeriod, defaultUpdatePeriod)
+	d.UpdatePeriod = gosettings.DefaultPointer(d.UpdatePeriod, defaultUpdatePeriod)
 	d.Unbound.setDefaults()
 	d.Blacklist.setDefaults()
 }
@@ -95,12 +87,12 @@ func (d DoT) String() string {
 func (d DoT) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("DNS over TLS settings:")
 
-	node.Appendf("Enabled: %s", helpers.BoolPtrToYesNo(d.Enabled))
+	node.Appendf("Enabled: %s", gosettings.BoolToYesNo(d.Enabled))
 	if !*d.Enabled {
 		return node
 	}
 
-	update := "disabled"
+	update := "disabled" //nolint:goconst
 	if *d.UpdatePeriod > 0 {
 		update = "every " + d.UpdatePeriod.String()
 	}
@@ -111,3 +103,27 @@ func (d DoT) toLinesNode() (node *gotree.Node) {
 
 	return node
 }
+
+func (d *DoT) read(reader *reader.Reader) (err error) {
+	d.Enabled, err = reader.BoolPtr("DOT")
+	if err != nil {
+		return err
+	}
+
+	d.UpdatePeriod, err = reader.DurationPtr("DNS_UPDATE_PERIOD")
+	if err != nil {
+		return err
+	}
+
+	err = d.Unbound.read(reader)
+	if err != nil {
+		return err
+	}
+
+	err = d.Blacklist.read(reader)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/configuration/settings/errors.go

@@ -3,11 +3,14 @@ package settings
 import "errors"
 
 var (
+	ErrValueUnknown                    = errors.New("value is unknown")
 	ErrCityNotValid                    = errors.New("the city specified is not valid")
 	ErrControlServerPrivilegedPort     = errors.New("cannot use privileged port without running as root")
+	ErrCategoryNotValid                = errors.New("the category specified is not valid")
 	ErrCountryNotValid                 = errors.New("the country specified is not valid")
 	ErrFilepathMissing                 = errors.New("filepath is missing")
-	ErrFirewallZeroPort                = errors.New("cannot have a zero port to block")
+	ErrFirewallZeroPort                = errors.New("cannot have a zero port")
+	ErrFirewallPublicOutboundSubnet    = errors.New("outbound subnet has an unspecified address")
 	ErrHostnameNotValid                = errors.New("the hostname specified is not valid")
 	ErrISPNotValid                     = errors.New("the ISP specified is not valid")
 	ErrMinRatioNotValid                = errors.New("minimum ratio is not valid")
@@ -25,6 +28,8 @@ var (
 	ErrOpenVPNVerbosityIsOutOfBounds   = errors.New("verbosity value is out of bounds")
 	ErrOpenVPNVersionIsNotValid        = errors.New("version is not valid")
 	ErrPortForwardingEnabled           = errors.New("port forwarding cannot be enabled")
+	ErrPortForwardingUserEmpty         = errors.New("port forwarding username is empty")
+	ErrPortForwardingPasswordEmpty     = errors.New("port forwarding password is empty")
 	ErrPublicIPPeriodTooShort          = errors.New("public IP address check period is too short")
 	ErrRegionNotValid                  = errors.New("the region specified is not valid")
 	ErrServerAddressNotValid           = errors.New("server listening address is not valid")
@@ -34,6 +39,8 @@ var (
 	ErrUpdaterPeriodTooSmall           = errors.New("VPN server data updater period is too small")
 	ErrVPNProviderNameNotValid         = errors.New("VPN provider name is not valid")
 	ErrVPNTypeNotValid                 = errors.New("VPN type is not valid")
+	ErrWireguardAllowedIPNotSet        = errors.New("allowed IP is not set")
+	ErrWireguardAllowedIPsNotSet       = errors.New("allowed IPs is not set")
 	ErrWireguardEndpointIPNotSet       = errors.New("endpoint IP is not set")
 	ErrWireguardEndpointPortNotAllowed = errors.New("endpoint port is not allowed")
 	ErrWireguardEndpointPortNotSet     = errors.New("endpoint port is not set")
@@ -45,5 +52,6 @@ var (
 	ErrWireguardPrivateKeyNotSet       = errors.New("private key is not set")
 	ErrWireguardPublicKeyNotSet        = errors.New("public key is not set")
 	ErrWireguardPublicKeyNotValid      = errors.New("public key is not valid")
+	ErrWireguardKeepAliveNegative      = errors.New("persistent keep alive interval is negative")
 	ErrWireguardImplementationNotValid = errors.New("implementation is not valid")
 )

internal/configuration/settings/firewall.go

@@ -4,7 +4,8 @@ import (
 	"fmt"
 	"net/netip"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 )
 
@@ -26,6 +27,12 @@ func (f Firewall) validate() (err error) {
 		return fmt.Errorf("input ports: %w", ErrFirewallZeroPort)
 	}
 
+	for _, subnet := range f.OutboundSubnets {
+		if subnet.Addr().IsUnspecified() {
+			return fmt.Errorf("%w: %s", ErrFirewallPublicOutboundSubnet, subnet)
+		}
+	}
+
 	return nil
 }
 
@@ -40,40 +47,28 @@ func hasZeroPort(ports []uint16) (has bool) {
 
 func (f *Firewall) copy() (copied Firewall) {
 	return Firewall{
-		VPNInputPorts:   helpers.CopySlice(f.VPNInputPorts),
+		VPNInputPorts:   gosettings.CopySlice(f.VPNInputPorts),
-		InputPorts:      helpers.CopySlice(f.InputPorts),
+		InputPorts:      gosettings.CopySlice(f.InputPorts),
-		OutboundSubnets: helpers.CopySlice(f.OutboundSubnets),
+		OutboundSubnets: gosettings.CopySlice(f.OutboundSubnets),
-		Enabled:         helpers.CopyPointer(f.Enabled),
+		Enabled:         gosettings.CopyPointer(f.Enabled),
-		Debug:           helpers.CopyPointer(f.Debug),
+		Debug:           gosettings.CopyPointer(f.Debug),
 	}
 }
 
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-// It merges values of slices together, even if they
-// are set in the receiver settings.
-func (f *Firewall) mergeWith(other Firewall) {
-	f.VPNInputPorts = helpers.MergeSlices(f.VPNInputPorts, other.VPNInputPorts)
-	f.InputPorts = helpers.MergeSlices(f.InputPorts, other.InputPorts)
-	f.OutboundSubnets = helpers.MergeSlices(f.OutboundSubnets, other.OutboundSubnets)
-	f.Enabled = helpers.MergeWithPointer(f.Enabled, other.Enabled)
-	f.Debug = helpers.MergeWithPointer(f.Debug, other.Debug)
-}
-
 // overrideWith overrides fields of the receiver
 // settings object with any field set in the other
 // settings.
 func (f *Firewall) overrideWith(other Firewall) {
-	f.VPNInputPorts = helpers.OverrideWithSlice(f.VPNInputPorts, other.VPNInputPorts)
+	f.VPNInputPorts = gosettings.OverrideWithSlice(f.VPNInputPorts, other.VPNInputPorts)
-	f.InputPorts = helpers.OverrideWithSlice(f.InputPorts, other.InputPorts)
+	f.InputPorts = gosettings.OverrideWithSlice(f.InputPorts, other.InputPorts)
-	f.OutboundSubnets = helpers.OverrideWithSlice(f.OutboundSubnets, other.OutboundSubnets)
+	f.OutboundSubnets = gosettings.OverrideWithSlice(f.OutboundSubnets, other.OutboundSubnets)
-	f.Enabled = helpers.OverrideWithPointer(f.Enabled, other.Enabled)
+	f.Enabled = gosettings.OverrideWithPointer(f.Enabled, other.Enabled)
-	f.Debug = helpers.OverrideWithPointer(f.Debug, other.Debug)
+	f.Debug = gosettings.OverrideWithPointer(f.Debug, other.Debug)
 }
 
 func (f *Firewall) setDefaults() {
-	f.Enabled = helpers.DefaultPointer(f.Enabled, true)
+	f.Enabled = gosettings.DefaultPointer(f.Enabled, true)
-	f.Debug = helpers.DefaultPointer(f.Debug, false)
+	f.Debug = gosettings.DefaultPointer(f.Debug, false)
 }
 
 func (f Firewall) String() string {
@@ -83,7 +78,7 @@ func (f Firewall) String() string {
 func (f Firewall) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("Firewall settings:")
 
-	node.Appendf("Enabled: %s", helpers.BoolPtrToYesNo(f.Enabled))
+	node.Appendf("Enabled: %s", gosettings.BoolToYesNo(f.Enabled))
 	if !*f.Enabled {
 		return node
 	}
@@ -116,3 +111,33 @@ func (f Firewall) toLinesNode() (node *gotree.Node) {
 
 	return node
 }
+
+func (f *Firewall) read(r *reader.Reader) (err error) {
+	f.VPNInputPorts, err = r.CSVUint16("FIREWALL_VPN_INPUT_PORTS")
+	if err != nil {
+		return err
+	}
+
+	f.InputPorts, err = r.CSVUint16("FIREWALL_INPUT_PORTS")
+	if err != nil {
+		return err
+	}
+
+	f.OutboundSubnets, err = r.CSVNetipPrefixes(
+		"FIREWALL_OUTBOUND_SUBNETS", reader.RetroKeys("EXTRA_SUBNETS"))
+	if err != nil {
+		return err
+	}
+
+	f.Enabled, err = r.BoolPtr("FIREWALL_ENABLED_DISABLING_IT_SHOOTS_YOU_IN_YOUR_FOOT")
+	if err != nil {
+		return err
+	}
+
+	f.Debug, err = r.BoolPtr("FIREWALL_DEBUG")
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/configuration/settings/firewall_test.go

@@ -0,0 +1,74 @@
+package settings
+
+import (
+	"net/netip"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_Firewall_validate(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		firewall   Firewall
+		errWrapped error
+		errMessage string
+	}{
+		"empty": {},
+		"zero_vpn_input_port": {
+			firewall: Firewall{
+				VPNInputPorts: []uint16{0},
+			},
+			errWrapped: ErrFirewallZeroPort,
+			errMessage: "VPN input ports: cannot have a zero port",
+		},
+		"zero_input_port": {
+			firewall: Firewall{
+				InputPorts: []uint16{0},
+			},
+			errWrapped: ErrFirewallZeroPort,
+			errMessage: "input ports: cannot have a zero port",
+		},
+		"unspecified_outbound_subnet": {
+			firewall: Firewall{
+				OutboundSubnets: []netip.Prefix{
+					netip.MustParsePrefix("0.0.0.0/0"),
+				},
+			},
+			errWrapped: ErrFirewallPublicOutboundSubnet,
+			errMessage: "outbound subnet has an unspecified address: 0.0.0.0/0",
+		},
+		"public_outbound_subnet": {
+			firewall: Firewall{
+				OutboundSubnets: []netip.Prefix{
+					netip.MustParsePrefix("1.2.3.4/32"),
+				},
+			},
+		},
+		"valid_settings": {
+			firewall: Firewall{
+				VPNInputPorts: []uint16{100, 101},
+				InputPorts:    []uint16{200, 201},
+				OutboundSubnets: []netip.Prefix{
+					netip.MustParsePrefix("192.168.1.0/24"),
+					netip.MustParsePrefix("10.10.1.1/32"),
+				},
+			},
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			err := testCase.firewall.validate()
+
+			assert.ErrorIs(t, err, testCase.errWrapped)
+			if testCase.errWrapped != nil {
+				assert.EqualError(t, err, testCase.errMessage)
+			}
+		})
+	}
+}

internal/configuration/settings/health.go

@@ -5,9 +5,10 @@ import (
 	"os"
 	"time"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
 	"github.com/qdm12/gotree"
-	"github.com/qdm12/govalid/address"
 )
 
 // Health contains settings for the healthcheck and health server.
@@ -36,9 +37,7 @@ type Health struct {
 }
 
 func (h Health) Validate() (err error) {
-	uid := os.Getuid()
+	err = validate.ListeningAddress(h.ServerAddress, os.Getuid())
-	_, err = address.Validate(h.ServerAddress,
-		address.OptionListening(uid))
 	if err != nil {
 		return fmt.Errorf("server listening address is not valid: %w", err)
 	}
@@ -62,38 +61,27 @@ func (h *Health) copy() (copied Health) {
 	}
 }
 
-// MergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (h *Health) MergeWith(other Health) {
-	h.ServerAddress = helpers.MergeWithString(h.ServerAddress, other.ServerAddress)
-	h.ReadHeaderTimeout = helpers.MergeWithNumber(h.ReadHeaderTimeout, other.ReadHeaderTimeout)
-	h.ReadTimeout = helpers.MergeWithNumber(h.ReadTimeout, other.ReadTimeout)
-	h.TargetAddress = helpers.MergeWithString(h.TargetAddress, other.TargetAddress)
-	h.SuccessWait = helpers.MergeWithNumber(h.SuccessWait, other.SuccessWait)
-	h.VPN.mergeWith(other.VPN)
-}
-
 // OverrideWith overrides fields of the receiver
 // settings object with any field set in the other
 // settings.
 func (h *Health) OverrideWith(other Health) {
-	h.ServerAddress = helpers.OverrideWithString(h.ServerAddress, other.ServerAddress)
+	h.ServerAddress = gosettings.OverrideWithComparable(h.ServerAddress, other.ServerAddress)
-	h.ReadHeaderTimeout = helpers.OverrideWithNumber(h.ReadHeaderTimeout, other.ReadHeaderTimeout)
+	h.ReadHeaderTimeout = gosettings.OverrideWithComparable(h.ReadHeaderTimeout, other.ReadHeaderTimeout)
-	h.ReadTimeout = helpers.OverrideWithNumber(h.ReadTimeout, other.ReadTimeout)
+	h.ReadTimeout = gosettings.OverrideWithComparable(h.ReadTimeout, other.ReadTimeout)
-	h.TargetAddress = helpers.OverrideWithString(h.TargetAddress, other.TargetAddress)
+	h.TargetAddress = gosettings.OverrideWithComparable(h.TargetAddress, other.TargetAddress)
-	h.SuccessWait = helpers.OverrideWithNumber(h.SuccessWait, other.SuccessWait)
+	h.SuccessWait = gosettings.OverrideWithComparable(h.SuccessWait, other.SuccessWait)
 	h.VPN.overrideWith(other.VPN)
 }
 
 func (h *Health) SetDefaults() {
-	h.ServerAddress = helpers.DefaultString(h.ServerAddress, "127.0.0.1:9999")
+	h.ServerAddress = gosettings.DefaultComparable(h.ServerAddress, "127.0.0.1:9999")
 	const defaultReadHeaderTimeout = 100 * time.Millisecond
-	h.ReadHeaderTimeout = helpers.DefaultNumber(h.ReadHeaderTimeout, defaultReadHeaderTimeout)
+	h.ReadHeaderTimeout = gosettings.DefaultComparable(h.ReadHeaderTimeout, defaultReadHeaderTimeout)
 	const defaultReadTimeout = 500 * time.Millisecond
-	h.ReadTimeout = helpers.DefaultNumber(h.ReadTimeout, defaultReadTimeout)
+	h.ReadTimeout = gosettings.DefaultComparable(h.ReadTimeout, defaultReadTimeout)
-	h.TargetAddress = helpers.DefaultString(h.TargetAddress, "cloudflare.com:443")
+	h.TargetAddress = gosettings.DefaultComparable(h.TargetAddress, "cloudflare.com:443")
 	const defaultSuccessWait = 5 * time.Second
-	h.SuccessWait = helpers.DefaultNumber(h.SuccessWait, defaultSuccessWait)
+	h.SuccessWait = gosettings.DefaultComparable(h.SuccessWait, defaultSuccessWait)
 	h.VPN.setDefaults()
 }
 
@@ -111,3 +99,21 @@ func (h Health) toLinesNode() (node *gotree.Node) {
 	node.AppendNode(h.VPN.toLinesNode("VPN"))
 	return node
 }
+
+func (h *Health) Read(r *reader.Reader) (err error) {
+	h.ServerAddress = r.String("HEALTH_SERVER_ADDRESS")
+	h.TargetAddress = r.String("HEALTH_TARGET_ADDRESS",
+		reader.RetroKeys("HEALTH_ADDRESS_TO_PING"))
+
+	h.SuccessWait, err = r.Duration("HEALTH_SUCCESS_WAIT_DURATION")
+	if err != nil {
+		return err
+	}
+
+	err = h.VPN.read(r)
+	if err != nil {
+		return fmt.Errorf("VPN health settings: %w", err)
+	}
+
+	return nil
+}

internal/configuration/settings/healthywait.go

@@ -3,7 +3,8 @@ package settings
 import (
 	"time"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 )
 
@@ -23,35 +24,26 @@ func (h HealthyWait) validate() (err error) {
 	return nil
 }
 
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
 func (h *HealthyWait) copy() (copied HealthyWait) {
 	return HealthyWait{
-		Initial:  helpers.CopyPointer(h.Initial),
+		Initial:  gosettings.CopyPointer(h.Initial),
-		Addition: helpers.CopyPointer(h.Addition),
+		Addition: gosettings.CopyPointer(h.Addition),
 	}
 }
 
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (h *HealthyWait) mergeWith(other HealthyWait) {
-	h.Initial = helpers.MergeWithPointer(h.Initial, other.Initial)
-	h.Addition = helpers.MergeWithPointer(h.Addition, other.Addition)
-}
-
 // overrideWith overrides fields of the receiver
 // settings object with any field set in the other
 // settings.
 func (h *HealthyWait) overrideWith(other HealthyWait) {
-	h.Initial = helpers.OverrideWithPointer(h.Initial, other.Initial)
+	h.Initial = gosettings.OverrideWithPointer(h.Initial, other.Initial)
-	h.Addition = helpers.OverrideWithPointer(h.Addition, other.Addition)
+	h.Addition = gosettings.OverrideWithPointer(h.Addition, other.Addition)
 }
 
 func (h *HealthyWait) setDefaults() {
 	const initialDurationDefault = 6 * time.Second
 	const additionDurationDefault = 5 * time.Second
-	h.Initial = helpers.DefaultPointer(h.Initial, initialDurationDefault)
+	h.Initial = gosettings.DefaultPointer(h.Initial, initialDurationDefault)
-	h.Addition = helpers.DefaultPointer(h.Addition, additionDurationDefault)
+	h.Addition = gosettings.DefaultPointer(h.Addition, additionDurationDefault)
 }
 
 func (h HealthyWait) String() string {
@@ -64,3 +56,21 @@ func (h HealthyWait) toLinesNode(kind string) (node *gotree.Node) {
 	node.Appendf("Additional duration: %s", *h.Addition)
 	return node
 }
+
+func (h *HealthyWait) read(r *reader.Reader) (err error) {
+	h.Initial, err = r.DurationPtr(
+		"HEALTH_VPN_DURATION_INITIAL",
+		reader.RetroKeys("HEALTH_OPENVPN_DURATION_INITIAL"))
+	if err != nil {
+		return err
+	}
+
+	h.Addition, err = r.DurationPtr(
+		"HEALTH_VPN_DURATION_ADDITION",
+		reader.RetroKeys("HEALTH_OPENVPN_DURATION_ADDITION"))
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/configuration/settings/helpers.go

@@ -0,0 +1,5 @@
+package settings
+
+func ptrTo[T any](value T) *T {
+	return &value
+}

internal/configuration/settings/helpers/belong.go

@@ -1,12 +1,6 @@
 package helpers
 
-import (
+func IsOneOf[T comparable](value T, choices ...T) (ok bool) {
-	"errors"
-	"fmt"
-	"strings"
-)
-
-func IsOneOf(value string, choices ...string) (ok bool) {
 	for _, choice := range choices {
 		if value == choice {
 			return true
@@ -14,39 +8,3 @@ func IsOneOf(value string, choices ...string) (ok bool) {
 	}
 	return false
 }
-
-var (
-	ErrNoChoice      = errors.New("one or more values is set but there is no possible value available")
-	ErrValueNotOneOf = errors.New("value is not one of the possible choices")
-)
-
-func AreAllOneOf(values, choices []string) (err error) {
-	if len(values) > 0 && len(choices) == 0 {
-		return fmt.Errorf("%w", ErrNoChoice)
-	}
-
-	set := make(map[string]struct{}, len(choices))
-	for _, choice := range choices {
-		choice = strings.ToLower(choice)
-		set[choice] = struct{}{}
-	}
-
-	for _, value := range values {
-		_, ok := set[value]
-		if !ok {
-			return fmt.Errorf("%w: value %q, choices available are %s",
-				ErrValueNotOneOf, value, strings.Join(choices, ", "))
-		}
-	}
-
-	return nil
-}
-
-func Uint16IsOneOf(port uint16, choices []uint16) (ok bool) {
-	for _, choice := range choices {
-		if port == choice {
-			return true
-		}
-	}
-	return false
-}

internal/configuration/settings/helpers/copy.go

@@ -1,20 +0,0 @@
-package helpers
-
-import (
-	"net/netip"
-
-	"golang.org/x/exp/slices"
-)
-
-func CopyPointer[T any](original *T) (copied *T) {
-	if original == nil {
-		return nil
-	}
-	copied = new(T)
-	*copied = *original
-	return copied
-}
-
-func CopySlice[T string | uint16 | netip.Addr | netip.Prefix](original []T) (copied []T) {
-	return slices.Clone(original)
-}

internal/configuration/settings/helpers/default.go

@@ -1,39 +0,0 @@
-package helpers
-
-import (
-	"net/netip"
-)
-
-func DefaultPointer[T any](existing *T, defaultValue T) (
-	result *T) {
-	if existing != nil {
-		return existing
-	}
-	result = new(T)
-	*result = defaultValue
-	return result
-}
-
-func DefaultString(existing string, defaultValue string) (
-	result string) {
-	if existing != "" {
-		return existing
-	}
-	return defaultValue
-}
-
-func DefaultNumber[T Number](existing T, defaultValue T) ( //nolint:ireturn
-	result T) {
-	if existing != 0 {
-		return existing
-	}
-	return defaultValue
-}
-
-func DefaultIP(existing netip.Addr, defaultValue netip.Addr) (
-	result netip.Addr) {
-	if existing.IsValid() {
-		return existing
-	}
-	return defaultValue
-}

internal/configuration/settings/helpers/files.go

@@ -1,31 +0,0 @@
-package helpers
-
-import (
-	"errors"
-	"fmt"
-	"os"
-	"path/filepath"
-)
-
-var (
-	ErrFileDoesNotExist = errors.New("file does not exist")
-	ErrFileRead         = errors.New("cannot read file")
-	ErrFileClose        = errors.New("cannot close file")
-)
-
-func FileExists(path string) (err error) {
-	path = filepath.Clean(path)
-
-	f, err := os.Open(path)
-	if errors.Is(err, os.ErrNotExist) {
-		return fmt.Errorf("%w: %s", ErrFileDoesNotExist, path)
-	} else if err != nil {
-		return fmt.Errorf("%w: %s", ErrFileRead, err)
-	}
-
-	if err := f.Close(); err != nil {
-		return fmt.Errorf("%w: %s", ErrFileClose, err)
-	}
-
-	return nil
-}

internal/configuration/settings/helpers/generics.go

@@ -1,10 +0,0 @@
-package helpers
-
-import "time"
-
-type Number interface {
-	uint8 | uint16 | uint32 | uint64 | uint |
-		int8 | int16 | int32 | int64 | int |
-		float32 | float64 |
-		time.Duration
-}

internal/configuration/settings/helpers/merge.go

@@ -1,69 +0,0 @@
-package helpers
-
-import (
-	"net/http"
-	"net/netip"
-)
-
-func MergeWithPointer[T any](existing, other *T) (result *T) {
-	if existing != nil {
-		return existing
-	} else if other == nil {
-		return nil
-	}
-	result = new(T)
-	*result = *other
-	return result
-}
-
-func MergeWithString(existing, other string) (result string) {
-	if existing != "" {
-		return existing
-	}
-	return other
-}
-
-func MergeWithNumber[T Number](existing, other T) (result T) { //nolint:ireturn
-	if existing != 0 {
-		return existing
-	}
-	return other
-}
-
-func MergeWithIP(existing, other netip.Addr) (result netip.Addr) {
-	if existing.IsValid() {
-		return existing
-	}
-	return other
-}
-
-func MergeWithHTTPHandler(existing, other http.Handler) (result http.Handler) {
-	if existing != nil {
-		return existing
-	}
-	return other
-}
-
-func MergeSlices[T comparable](a, b []T) (result []T) {
-	if a == nil && b == nil {
-		return nil
-	}
-
-	seen := make(map[T]struct{}, len(a)+len(b))
-	result = make([]T, 0, len(a)+len(b))
-	for _, s := range a {
-		if _, ok := seen[s]; ok {
-			continue // duplicate
-		}
-		result = append(result, s)
-		seen[s] = struct{}{}
-	}
-	for _, s := range b {
-		if _, ok := seen[s]; ok {
-			continue // duplicate
-		}
-		result = append(result, s)
-		seen[s] = struct{}{}
-	}
-	return result
-}

internal/configuration/settings/helpers/messages.go

@@ -1,29 +0,0 @@
-package helpers
-
-import (
-	"fmt"
-	"strings"
-)
-
-func ChoicesOrString(choices []string) string {
-	return strings.Join(
-		choices[:len(choices)-1], ", ") +
-		" or " + choices[len(choices)-1]
-}
-
-func PortChoicesOrString(ports []uint16) (s string) {
-	switch len(ports) {
-	case 0:
-		return "there is no allowed port"
-	case 1:
-		return "allowed port is " + fmt.Sprint(ports[0])
-	}
-
-	s = "allowed ports are "
-	portStrings := make([]string, len(ports))
-	for i := range ports {
-		portStrings[i] = fmt.Sprint(ports[i])
-	}
-	s += ChoicesOrString(portStrings)
-	return s
-}

internal/configuration/settings/helpers/obfuscate.go

@@ -1,25 +0,0 @@
-package helpers
-
-func ObfuscateWireguardKey(fullKey string) (obfuscatedKey string) {
-	const minKeyLength = 10
-	if len(fullKey) < minKeyLength {
-		return "(too short)"
-	}
-
-	lastIndex := len(fullKey) - 1
-	return fullKey[0:2] + "..." + fullKey[lastIndex-2:]
-}
-
-func ObfuscatePassword(password string) (obfuscatedPassword string) {
-	if password != "" {
-		return "[set]"
-	}
-	return "[not set]"
-}
-
-func ObfuscateData(data string) (obfuscated string) {
-	if data != "" {
-		return "[set]"
-	}
-	return "[not set]"
-}

internal/configuration/settings/helpers/override.go

@@ -1,52 +0,0 @@
-package helpers
-
-import (
-	"net/http"
-	"net/netip"
-)
-
-func OverrideWithPointer[T any](existing, other *T) (result *T) {
-	if other == nil {
-		return existing
-	}
-	result = new(T)
-	*result = *other
-	return result
-}
-
-func OverrideWithString(existing, other string) (result string) {
-	if other == "" {
-		return existing
-	}
-	return other
-}
-
-func OverrideWithNumber[T Number](existing, other T) (result T) { //nolint:ireturn
-	if other == 0 {
-		return existing
-	}
-	return other
-}
-
-func OverrideWithIP(existing, other netip.Addr) (result netip.Addr) {
-	if !other.IsValid() {
-		return existing
-	}
-	return other
-}
-
-func OverrideWithHTTPHandler(existing, other http.Handler) (result http.Handler) {
-	if other != nil {
-		return other
-	}
-	return existing
-}
-
-func OverrideWithSlice[T any](existing, other []T) (result []T) {
-	if other == nil {
-		return existing
-	}
-	result = make([]T, len(other))
-	copy(result, other)
-	return result
-}

internal/configuration/settings/helpers/string.go

@@ -1,15 +0,0 @@
-package helpers
-
-func BoolPtrToYesNo(b *bool) string {
-	if *b {
-		return "yes"
-	}
-	return "no"
-}
-
-func TCPPtrToString(tcp *bool) string {
-	if *tcp {
-		return "TCP"
-	}
-	return "UDP"
-}

internal/configuration/settings/httpproxy.go

@@ -3,11 +3,13 @@ package settings
 import (
 	"fmt"
 	"os"
+	"strings"
 	"time"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
 	"github.com/qdm12/gotree"
-	"github.com/qdm12/govalid/address"
 )
 
 // HTTPProxy contains settings to configure the HTTP proxy.
@@ -44,9 +46,7 @@ type HTTPProxy struct {
 
 func (h HTTPProxy) validate() (err error) {
 	// Do not validate user and password
-
+	err = validate.ListeningAddress(h.ListeningAddress, os.Getuid())
-	uid := os.Getuid()
-	_, err = address.Validate(h.ListeningAddress, address.OptionListening(uid))
 	if err != nil {
 		return fmt.Errorf("%w: %s", ErrServerAddressNotValid, h.ListeningAddress)
 	}
@@ -56,55 +56,42 @@ func (h HTTPProxy) validate() (err error) {
 
 func (h *HTTPProxy) copy() (copied HTTPProxy) {
 	return HTTPProxy{
-		User:              helpers.CopyPointer(h.User),
+		User:              gosettings.CopyPointer(h.User),
-		Password:          helpers.CopyPointer(h.Password),
+		Password:          gosettings.CopyPointer(h.Password),
 		ListeningAddress:  h.ListeningAddress,
-		Enabled:           helpers.CopyPointer(h.Enabled),
+		Enabled:           gosettings.CopyPointer(h.Enabled),
-		Stealth:           helpers.CopyPointer(h.Stealth),
+		Stealth:           gosettings.CopyPointer(h.Stealth),
-		Log:               helpers.CopyPointer(h.Log),
+		Log:               gosettings.CopyPointer(h.Log),
 		ReadHeaderTimeout: h.ReadHeaderTimeout,
 		ReadTimeout:       h.ReadTimeout,
 	}
 }
 
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (h *HTTPProxy) mergeWith(other HTTPProxy) {
-	h.User = helpers.MergeWithPointer(h.User, other.User)
-	h.Password = helpers.MergeWithPointer(h.Password, other.Password)
-	h.ListeningAddress = helpers.MergeWithString(h.ListeningAddress, other.ListeningAddress)
-	h.Enabled = helpers.MergeWithPointer(h.Enabled, other.Enabled)
-	h.Stealth = helpers.MergeWithPointer(h.Stealth, other.Stealth)
-	h.Log = helpers.MergeWithPointer(h.Log, other.Log)
-	h.ReadHeaderTimeout = helpers.MergeWithNumber(h.ReadHeaderTimeout, other.ReadHeaderTimeout)
-	h.ReadTimeout = helpers.MergeWithNumber(h.ReadTimeout, other.ReadTimeout)
-}
-
 // overrideWith overrides fields of the receiver
 // settings object with any field set in the other
 // settings.
 func (h *HTTPProxy) overrideWith(other HTTPProxy) {
-	h.User = helpers.OverrideWithPointer(h.User, other.User)
+	h.User = gosettings.OverrideWithPointer(h.User, other.User)
-	h.Password = helpers.OverrideWithPointer(h.Password, other.Password)
+	h.Password = gosettings.OverrideWithPointer(h.Password, other.Password)
-	h.ListeningAddress = helpers.OverrideWithString(h.ListeningAddress, other.ListeningAddress)
+	h.ListeningAddress = gosettings.OverrideWithComparable(h.ListeningAddress, other.ListeningAddress)
-	h.Enabled = helpers.OverrideWithPointer(h.Enabled, other.Enabled)
+	h.Enabled = gosettings.OverrideWithPointer(h.Enabled, other.Enabled)
-	h.Stealth = helpers.OverrideWithPointer(h.Stealth, other.Stealth)
+	h.Stealth = gosettings.OverrideWithPointer(h.Stealth, other.Stealth)
-	h.Log = helpers.OverrideWithPointer(h.Log, other.Log)
+	h.Log = gosettings.OverrideWithPointer(h.Log, other.Log)
-	h.ReadHeaderTimeout = helpers.OverrideWithNumber(h.ReadHeaderTimeout, other.ReadHeaderTimeout)
+	h.ReadHeaderTimeout = gosettings.OverrideWithComparable(h.ReadHeaderTimeout, other.ReadHeaderTimeout)
-	h.ReadTimeout = helpers.OverrideWithNumber(h.ReadTimeout, other.ReadTimeout)
+	h.ReadTimeout = gosettings.OverrideWithComparable(h.ReadTimeout, other.ReadTimeout)
 }
 
 func (h *HTTPProxy) setDefaults() {
-	h.User = helpers.DefaultPointer(h.User, "")
+	h.User = gosettings.DefaultPointer(h.User, "")
-	h.Password = helpers.DefaultPointer(h.Password, "")
+	h.Password = gosettings.DefaultPointer(h.Password, "")
-	h.ListeningAddress = helpers.DefaultString(h.ListeningAddress, ":8888")
+	h.ListeningAddress = gosettings.DefaultComparable(h.ListeningAddress, ":8888")
-	h.Enabled = helpers.DefaultPointer(h.Enabled, false)
+	h.Enabled = gosettings.DefaultPointer(h.Enabled, false)
-	h.Stealth = helpers.DefaultPointer(h.Stealth, false)
+	h.Stealth = gosettings.DefaultPointer(h.Stealth, false)
-	h.Log = helpers.DefaultPointer(h.Log, false)
+	h.Log = gosettings.DefaultPointer(h.Log, false)
 	const defaultReadHeaderTimeout = time.Second
-	h.ReadHeaderTimeout = helpers.DefaultNumber(h.ReadHeaderTimeout, defaultReadHeaderTimeout)
+	h.ReadHeaderTimeout = gosettings.DefaultComparable(h.ReadHeaderTimeout, defaultReadHeaderTimeout)
 	const defaultReadTimeout = 3 * time.Second
-	h.ReadTimeout = helpers.DefaultNumber(h.ReadTimeout, defaultReadTimeout)
+	h.ReadTimeout = gosettings.DefaultComparable(h.ReadTimeout, defaultReadTimeout)
 }
 
 func (h HTTPProxy) String() string {
@@ -113,18 +100,83 @@ func (h HTTPProxy) String() string {
 
 func (h HTTPProxy) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("HTTP proxy settings:")
-	node.Appendf("Enabled: %s", helpers.BoolPtrToYesNo(h.Enabled))
+	node.Appendf("Enabled: %s", gosettings.BoolToYesNo(h.Enabled))
 	if !*h.Enabled {
 		return node
 	}
 
 	node.Appendf("Listening address: %s", h.ListeningAddress)
 	node.Appendf("User: %s", *h.User)
-	node.Appendf("Password: %s", helpers.ObfuscatePassword(*h.Password))
+	node.Appendf("Password: %s", gosettings.ObfuscateKey(*h.Password))
-	node.Appendf("Stealth mode: %s", helpers.BoolPtrToYesNo(h.Stealth))
+	node.Appendf("Stealth mode: %s", gosettings.BoolToYesNo(h.Stealth))
-	node.Appendf("Log: %s", helpers.BoolPtrToYesNo(h.Log))
+	node.Appendf("Log: %s", gosettings.BoolToYesNo(h.Log))
 	node.Appendf("Read header timeout: %s", h.ReadHeaderTimeout)
 	node.Appendf("Read timeout: %s", h.ReadTimeout)
 
 	return node
 }
+
+func (h *HTTPProxy) read(r *reader.Reader) (err error) {
+	h.User = r.Get("HTTPPROXY_USER",
+		reader.RetroKeys("PROXY_USER", "TINYPROXY_USER"),
+		reader.ForceLowercase(false))
+
+	h.Password = r.Get("HTTPPROXY_PASSWORD",
+		reader.RetroKeys("PROXY_PASSWORD", "TINYPROXY_PASSWORD"),
+		reader.ForceLowercase(false))
+
+	h.ListeningAddress, err = readHTTProxyListeningAddress(r)
+	if err != nil {
+		return err
+	}
+
+	h.Enabled, err = r.BoolPtr("HTTPPROXY", reader.RetroKeys("PROXY", "TINYPROXY"))
+	if err != nil {
+		return err
+	}
+
+	h.Stealth, err = r.BoolPtr("HTTPPROXY_STEALTH")
+	if err != nil {
+		return err
+	}
+
+	h.Log, err = readHTTProxyLog(r)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func readHTTProxyListeningAddress(r *reader.Reader) (listeningAddress string, err error) {
+	// Retro-compatible keys using a port only
+	port, err := r.Uint16Ptr("",
+		reader.RetroKeys("HTTPPROXY_PORT", "TINYPROXY_PORT", "PROXY_PORT"),
+		reader.IsRetro("HTTPPROXY_LISTENING_ADDRESS"))
+	if err != nil {
+		return "", err
+	} else if port != nil {
+		return fmt.Sprintf(":%d", *port), nil
+	}
+	const currentKey = "HTTPPROXY_LISTENING_ADDRESS"
+	return r.String(currentKey), nil
+}
+
+func readHTTProxyLog(r *reader.Reader) (enabled *bool, err error) {
+	const currentKey = "HTTPPROXY_LOG"
+	// Retro-compatible keys using different boolean verbs
+	value := r.String("",
+		reader.RetroKeys("PROXY_LOG", "TINYPROXY_LOG"),
+		reader.IsRetro(currentKey))
+	switch strings.ToLower(value) {
+	case "":
+		return r.BoolPtr(currentKey)
+	case "on", "info", "connect", "notice":
+		return ptrTo(true), nil
+	case "disabled", "no", "off":
+		return ptrTo(false), nil
+	default:
+		return nil, fmt.Errorf("HTTP retro-compatible proxy log setting: %w: %s",
+			ErrValueUnknown, value)
+	}
+}

internal/configuration/settings/log.go

@@ -1,7 +1,10 @@
 package settings
 
 import (
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"fmt"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 	"github.com/qdm12/log"
 )
@@ -9,35 +12,33 @@ import (
 // Log contains settings to configure the logger.
 type Log struct {
 	// Level is the log level of the logger.
-	// It cannot be nil in the internal state.
+	// It cannot be empty in the internal state.
-	Level *log.Level
+	Level string
 }
 
 func (l Log) validate() (err error) {
+	_, err = log.ParseLevel(l.Level)
+	if err != nil {
+		return fmt.Errorf("level: %w", err)
+	}
 	return nil
 }
 
 func (l *Log) copy() (copied Log) {
 	return Log{
-		Level: helpers.CopyPointer(l.Level),
+		Level: l.Level,
 	}
 }
 
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (l *Log) mergeWith(other Log) {
-	l.Level = helpers.MergeWithPointer(l.Level, other.Level)
-}
-
 // overrideWith overrides fields of the receiver
 // settings object with any field set in the other
 // settings.
 func (l *Log) overrideWith(other Log) {
-	l.Level = helpers.OverrideWithPointer(l.Level, other.Level)
+	l.Level = gosettings.OverrideWithComparable(l.Level, other.Level)
 }
 
 func (l *Log) setDefaults() {
-	l.Level = helpers.DefaultPointer(l.Level, log.LevelInfo)
+	l.Level = gosettings.DefaultComparable(l.Level, log.LevelInfo.String())
 }
 
 func (l Log) String() string {
@@ -46,6 +47,11 @@ func (l Log) String() string {
 
 func (l Log) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("Log settings:")
-	node.Appendf("Log level: %s", l.Level.String())
+	node.Appendf("Log level: %s", l.Level)
 	return node
 }
+
+func (l *Log) read(r *reader.Reader) (err error) {
+	l.Level = r.String("LOG_LEVEL")
+	return nil
+}

internal/configuration/settings/nordvpn_retro.go

@@ -0,0 +1,42 @@
+package settings
+
+// Retro-compatibility because SERVER_REGIONS changed to SERVER_COUNTRIES
+// and SERVER_REGIONS is now the continent field for servers.
+// TODO v4 remove.
+func nordvpnRetroRegion(selection ServerSelection, validRegions, validCountries []string) (
+	updatedSelection ServerSelection) {
+	validRegionsMap := stringSliceToMap(validRegions)
+	validCountriesMap := stringSliceToMap(validCountries)
+
+	updatedSelection = selection.copy()
+	updatedSelection.Regions = make([]string, 0, len(selection.Regions))
+	for _, region := range selection.Regions {
+		_, isValid := validRegionsMap[region]
+		if isValid {
+			updatedSelection.Regions = append(updatedSelection.Regions, region)
+			continue
+		}
+
+		_, isValid = validCountriesMap[region]
+		if !isValid {
+			// Region is not valid for the country or region
+			// just leave it to the validation to fail it later
+			continue
+		}
+
+		// Region is not valid for a region, but is a valid country
+		// Handle retro-compatibility and transfer the value to the
+		// country field.
+		updatedSelection.Countries = append(updatedSelection.Countries, region)
+	}
+
+	return updatedSelection
+}
+
+func stringSliceToMap(slice []string) (m map[string]struct{}) {
+	m = make(map[string]struct{}, len(slice))
+	for _, s := range slice {
+		m[s] = struct{}{}
+	}
+	return m
+}

internal/configuration/settings/openvpn.go

@@ -6,92 +6,93 @@ import (
 	"regexp"
 	"strings"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
 	"github.com/qdm12/gluetun/internal/constants/openvpn"
 	"github.com/qdm12/gluetun/internal/constants/providers"
 	"github.com/qdm12/gluetun/internal/openvpn/extract"
 	"github.com/qdm12/gluetun/internal/provider/privateinternetaccess/presets"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
 	"github.com/qdm12/gotree"
 )
 
 // OpenVPN contains settings to configure the OpenVPN client.
 type OpenVPN struct {
 	// Version is the OpenVPN version to run.
-	// It can only be "2.4" or "2.5".
+	// It can only be "2.5" or "2.6".
-	Version string
+	Version string `json:"version"`
 	// User is the OpenVPN authentication username.
 	// It cannot be nil in the internal state if OpenVPN is used.
 	// It is usually required but in some cases can be the empty string
 	// to indicate no user+password authentication is needed.
-	User *string
+	User *string `json:"user"`
 	// Password is the OpenVPN authentication password.
 	// It cannot be nil in the internal state if OpenVPN is used.
 	// It is usually required but in some cases can be the empty string
 	// to indicate no user+password authentication is needed.
-	Password *string
+	Password *string `json:"password"`
 	// ConfFile is a custom OpenVPN configuration file path.
 	// It can be set to the empty string for it to be ignored.
 	// It cannot be nil in the internal state.
-	ConfFile *string
+	ConfFile *string `json:"config_file_path"`
 	// Ciphers is a list of ciphers to use for OpenVPN,
 	// different from the ones specified by the VPN
 	// service provider configuration files.
-	Ciphers []string
+	Ciphers []string `json:"ciphers"`
 	// Auth is an auth algorithm to use in OpenVPN instead
 	// of the one specified by the VPN service provider.
 	// It cannot be nil in the internal state.
 	// It is ignored if it is set to the empty string.
-	Auth *string
+	Auth *string `json:"auth"`
 	// Cert is the base64 encoded DER of an OpenVPN certificate for the <cert> block.
 	// This is notably used by Cyberghost and VPN secure.
 	// It can be set to the empty string to be ignored.
 	// It cannot be nil in the internal state.
-	Cert *string
+	Cert *string `json:"cert"`
 	// Key is the base64 encoded DER of an OpenVPN key.
 	// This is used by Cyberghost and VPN Unlimited.
 	// It can be set to the empty string to be ignored.
 	// It cannot be nil in the internal state.
-	Key *string
+	Key *string `json:"key"`
 	// EncryptedKey is the base64 encoded DER of an encrypted key for OpenVPN.
 	// It is used by VPN secure.
 	// It defaults to the empty string meaning it is not
 	// to be used. KeyPassphrase must be set if this one is set.
-	EncryptedKey *string
+	EncryptedKey *string `json:"encrypted_key"`
 	// KeyPassphrase is the key passphrase to be used by OpenVPN
 	// to decrypt the EncryptedPrivateKey. It defaults to the
 	// empty string and must be set if EncryptedPrivateKey is set.
-	KeyPassphrase *string
+	KeyPassphrase *string `json:"key_passphrase"`
 	// PIAEncPreset is the encryption preset for
 	// Private Internet Access. It can be set to an
 	// empty string for other providers.
-	PIAEncPreset *string
+	PIAEncPreset *string `json:"pia_encryption_preset"`
 	// MSSFix is the value (1 to 10000) to set for the
 	// mssfix option for OpenVPN. It is ignored if set to 0.
 	// It cannot be nil in the internal state.
-	MSSFix *uint16
+	MSSFix *uint16 `json:"mssfix"`
 	// Interface is the OpenVPN device interface name.
 	// It cannot be an empty string in the internal state.
-	Interface string
+	Interface string `json:"interface"`
 	// ProcessUser is the OpenVPN process OS username
 	// to use. It cannot be empty in the internal state.
 	// It defaults to 'root'.
-	ProcessUser string
+	ProcessUser string `json:"process_user"`
 	// Verbosity is the OpenVPN verbosity level from 0 to 6.
 	// It cannot be nil in the internal state.
-	Verbosity *int
+	Verbosity *int `json:"verbosity"`
 	// Flags is a slice of additional flags to be passed
 	// to the OpenVPN program.
-	Flags []string
+	Flags []string `json:"flags"`
 }
 
 var ivpnAccountID = regexp.MustCompile(`^(i|ivpn)\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}$`)
 
 func (o OpenVPN) validate(vpnProvider string) (err error) {
 	// Validate version
-	validVersions := []string{openvpn.Openvpn24, openvpn.Openvpn25}
+	validVersions := []string{openvpn.Openvpn25, openvpn.Openvpn26}
-	if !helpers.IsOneOf(o.Version, validVersions...) {
+	if err = validate.IsOneOf(o.Version, validVersions...); err != nil {
-		return fmt.Errorf("%w: %q can only be one of %s",
+		return fmt.Errorf("%w: %w", ErrOpenVPNVersionIsNotValid, err)
-			ErrOpenVPNVersionIsNotValid, o.Version, strings.Join(validVersions, ", "))
 	}
 
 	isCustom := vpnProvider == providers.Custom
@@ -163,7 +164,7 @@ func validateOpenVPNConfigFilepath(isCustom bool,
 		return fmt.Errorf("%w", ErrFilepathMissing)
 	}
 
-	err = helpers.FileExists(confFile)
+	err = validate.FileExists(confFile)
 	if err != nil {
 		return err
 	}
@@ -244,92 +245,71 @@ func validateOpenVPNEncryptedKey(vpnProvider,
 func (o *OpenVPN) copy() (copied OpenVPN) {
 	return OpenVPN{
 		Version:       o.Version,
-		User:          helpers.CopyPointer(o.User),
+		User:          gosettings.CopyPointer(o.User),
-		Password:      helpers.CopyPointer(o.Password),
+		Password:      gosettings.CopyPointer(o.Password),
-		ConfFile:      helpers.CopyPointer(o.ConfFile),
+		ConfFile:      gosettings.CopyPointer(o.ConfFile),
-		Ciphers:       helpers.CopySlice(o.Ciphers),
+		Ciphers:       gosettings.CopySlice(o.Ciphers),
-		Auth:          helpers.CopyPointer(o.Auth),
+		Auth:          gosettings.CopyPointer(o.Auth),
-		Cert:          helpers.CopyPointer(o.Cert),
+		Cert:          gosettings.CopyPointer(o.Cert),
-		Key:           helpers.CopyPointer(o.Key),
+		Key:           gosettings.CopyPointer(o.Key),
-		EncryptedKey:  helpers.CopyPointer(o.EncryptedKey),
+		EncryptedKey:  gosettings.CopyPointer(o.EncryptedKey),
-		KeyPassphrase: helpers.CopyPointer(o.KeyPassphrase),
+		KeyPassphrase: gosettings.CopyPointer(o.KeyPassphrase),
-		PIAEncPreset:  helpers.CopyPointer(o.PIAEncPreset),
+		PIAEncPreset:  gosettings.CopyPointer(o.PIAEncPreset),
-		MSSFix:        helpers.CopyPointer(o.MSSFix),
+		MSSFix:        gosettings.CopyPointer(o.MSSFix),
 		Interface:     o.Interface,
 		ProcessUser:   o.ProcessUser,
-		Verbosity:     helpers.CopyPointer(o.Verbosity),
+		Verbosity:     gosettings.CopyPointer(o.Verbosity),
-		Flags:         helpers.CopySlice(o.Flags),
+		Flags:         gosettings.CopySlice(o.Flags),
 	}
 }
 
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (o *OpenVPN) mergeWith(other OpenVPN) {
-	o.Version = helpers.MergeWithString(o.Version, other.Version)
-	o.User = helpers.MergeWithPointer(o.User, other.User)
-	o.Password = helpers.MergeWithPointer(o.Password, other.Password)
-	o.ConfFile = helpers.MergeWithPointer(o.ConfFile, other.ConfFile)
-	o.Ciphers = helpers.MergeSlices(o.Ciphers, other.Ciphers)
-	o.Auth = helpers.MergeWithPointer(o.Auth, other.Auth)
-	o.Cert = helpers.MergeWithPointer(o.Cert, other.Cert)
-	o.Key = helpers.MergeWithPointer(o.Key, other.Key)
-	o.EncryptedKey = helpers.MergeWithPointer(o.EncryptedKey, other.EncryptedKey)
-	o.KeyPassphrase = helpers.MergeWithPointer(o.KeyPassphrase, other.KeyPassphrase)
-	o.PIAEncPreset = helpers.MergeWithPointer(o.PIAEncPreset, other.PIAEncPreset)
-	o.MSSFix = helpers.MergeWithPointer(o.MSSFix, other.MSSFix)
-	o.Interface = helpers.MergeWithString(o.Interface, other.Interface)
-	o.ProcessUser = helpers.MergeWithString(o.ProcessUser, other.ProcessUser)
-	o.Verbosity = helpers.MergeWithPointer(o.Verbosity, other.Verbosity)
-	o.Flags = helpers.MergeSlices(o.Flags, other.Flags)
-}
-
 // overrideWith overrides fields of the receiver
 // settings object with any field set in the other
 // settings.
 func (o *OpenVPN) overrideWith(other OpenVPN) {
-	o.Version = helpers.OverrideWithString(o.Version, other.Version)
+	o.Version = gosettings.OverrideWithComparable(o.Version, other.Version)
-	o.User = helpers.OverrideWithPointer(o.User, other.User)
+	o.User = gosettings.OverrideWithPointer(o.User, other.User)
-	o.Password = helpers.OverrideWithPointer(o.Password, other.Password)
+	o.Password = gosettings.OverrideWithPointer(o.Password, other.Password)
-	o.ConfFile = helpers.OverrideWithPointer(o.ConfFile, other.ConfFile)
+	o.ConfFile = gosettings.OverrideWithPointer(o.ConfFile, other.ConfFile)
-	o.Ciphers = helpers.OverrideWithSlice(o.Ciphers, other.Ciphers)
+	o.Ciphers = gosettings.OverrideWithSlice(o.Ciphers, other.Ciphers)
-	o.Auth = helpers.OverrideWithPointer(o.Auth, other.Auth)
+	o.Auth = gosettings.OverrideWithPointer(o.Auth, other.Auth)
-	o.Cert = helpers.OverrideWithPointer(o.Cert, other.Cert)
+	o.Cert = gosettings.OverrideWithPointer(o.Cert, other.Cert)
-	o.Key = helpers.OverrideWithPointer(o.Key, other.Key)
+	o.Key = gosettings.OverrideWithPointer(o.Key, other.Key)
-	o.EncryptedKey = helpers.OverrideWithPointer(o.EncryptedKey, other.EncryptedKey)
+	o.EncryptedKey = gosettings.OverrideWithPointer(o.EncryptedKey, other.EncryptedKey)
-	o.KeyPassphrase = helpers.OverrideWithPointer(o.KeyPassphrase, other.KeyPassphrase)
+	o.KeyPassphrase = gosettings.OverrideWithPointer(o.KeyPassphrase, other.KeyPassphrase)
-	o.PIAEncPreset = helpers.OverrideWithPointer(o.PIAEncPreset, other.PIAEncPreset)
+	o.PIAEncPreset = gosettings.OverrideWithPointer(o.PIAEncPreset, other.PIAEncPreset)
-	o.MSSFix = helpers.OverrideWithPointer(o.MSSFix, other.MSSFix)
+	o.MSSFix = gosettings.OverrideWithPointer(o.MSSFix, other.MSSFix)
-	o.Interface = helpers.OverrideWithString(o.Interface, other.Interface)
+	o.Interface = gosettings.OverrideWithComparable(o.Interface, other.Interface)
-	o.ProcessUser = helpers.OverrideWithString(o.ProcessUser, other.ProcessUser)
+	o.ProcessUser = gosettings.OverrideWithComparable(o.ProcessUser, other.ProcessUser)
-	o.Verbosity = helpers.OverrideWithPointer(o.Verbosity, other.Verbosity)
+	o.Verbosity = gosettings.OverrideWithPointer(o.Verbosity, other.Verbosity)
-	o.Flags = helpers.OverrideWithSlice(o.Flags, other.Flags)
+	o.Flags = gosettings.OverrideWithSlice(o.Flags, other.Flags)
 }
 
 func (o *OpenVPN) setDefaults(vpnProvider string) {
-	o.Version = helpers.DefaultString(o.Version, openvpn.Openvpn25)
+	o.Version = gosettings.DefaultComparable(o.Version, openvpn.Openvpn26)
-	o.User = helpers.DefaultPointer(o.User, "")
+	o.User = gosettings.DefaultPointer(o.User, "")
 	if vpnProvider == providers.Mullvad {
-		o.Password = helpers.DefaultPointer(o.Password, "m")
+		o.Password = gosettings.DefaultPointer(o.Password, "m")
 	} else {
-		o.Password = helpers.DefaultPointer(o.Password, "")
+		o.Password = gosettings.DefaultPointer(o.Password, "")
 	}
 
-	o.ConfFile = helpers.DefaultPointer(o.ConfFile, "")
+	o.ConfFile = gosettings.DefaultPointer(o.ConfFile, "")
-	o.Auth = helpers.DefaultPointer(o.Auth, "")
+	o.Auth = gosettings.DefaultPointer(o.Auth, "")
-	o.Cert = helpers.DefaultPointer(o.Cert, "")
+	o.Cert = gosettings.DefaultPointer(o.Cert, "")
-	o.Key = helpers.DefaultPointer(o.Key, "")
+	o.Key = gosettings.DefaultPointer(o.Key, "")
-	o.EncryptedKey = helpers.DefaultPointer(o.EncryptedKey, "")
+	o.EncryptedKey = gosettings.DefaultPointer(o.EncryptedKey, "")
-	o.KeyPassphrase = helpers.DefaultPointer(o.KeyPassphrase, "")
+	o.KeyPassphrase = gosettings.DefaultPointer(o.KeyPassphrase, "")
 
 	var defaultEncPreset string
 	if vpnProvider == providers.PrivateInternetAccess {
 		defaultEncPreset = presets.Strong
 	}
-	o.PIAEncPreset = helpers.DefaultPointer(o.PIAEncPreset, defaultEncPreset)
+	o.PIAEncPreset = gosettings.DefaultPointer(o.PIAEncPreset, defaultEncPreset)
-	o.MSSFix = helpers.DefaultPointer(o.MSSFix, 0)
+	o.MSSFix = gosettings.DefaultPointer(o.MSSFix, 0)
-	o.Interface = helpers.DefaultString(o.Interface, "tun0")
+	o.Interface = gosettings.DefaultComparable(o.Interface, "tun0")
-	o.ProcessUser = helpers.DefaultString(o.ProcessUser, "root")
+	o.ProcessUser = gosettings.DefaultComparable(o.ProcessUser, "root")
-	o.Verbosity = helpers.DefaultPointer(o.Verbosity, 1)
+	o.Verbosity = gosettings.DefaultPointer(o.Verbosity, 1)
 }
 
 func (o OpenVPN) String() string {
@@ -339,8 +319,8 @@ func (o OpenVPN) String() string {
 func (o OpenVPN) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("OpenVPN settings:")
 	node.Appendf("OpenVPN version: %s", o.Version)
-	node.Appendf("User: %s", helpers.ObfuscatePassword(*o.User))
+	node.Appendf("User: %s", gosettings.ObfuscateKey(*o.User))
-	node.Appendf("Password: %s", helpers.ObfuscatePassword(*o.Password))
+	node.Appendf("Password: %s", gosettings.ObfuscateKey(*o.Password))
 
 	if *o.ConfFile != "" {
 		node.Appendf("Custom configuration file: %s", *o.ConfFile)
@@ -355,16 +335,16 @@ func (o OpenVPN) toLinesNode() (node *gotree.Node) {
 	}
 
 	if *o.Cert != "" {
-		node.Appendf("Client crt: %s", helpers.ObfuscateData(*o.Cert))
+		node.Appendf("Client crt: %s", gosettings.ObfuscateKey(*o.Cert))
 	}
 
 	if *o.Key != "" {
-		node.Appendf("Client key: %s", helpers.ObfuscateData(*o.Key))
+		node.Appendf("Client key: %s", gosettings.ObfuscateKey(*o.Key))
 	}
 
 	if *o.EncryptedKey != "" {
 		node.Appendf("Encrypted key: %s (key passhrapse %s)",
-			helpers.ObfuscateData(*o.EncryptedKey), helpers.ObfuscatePassword(*o.KeyPassphrase))
+			gosettings.ObfuscateKey(*o.EncryptedKey), gosettings.ObfuscateKey(*o.KeyPassphrase))
 	}
 
 	if *o.PIAEncPreset != "" {
@@ -396,3 +376,58 @@ func (o OpenVPN) WithDefaults(provider string) OpenVPN {
 	o.setDefaults(provider)
 	return o
 }
+
+func (o *OpenVPN) read(r *reader.Reader) (err error) {
+	o.Version = r.String("OPENVPN_VERSION")
+	o.User = r.Get("OPENVPN_USER", reader.RetroKeys("USER"), reader.ForceLowercase(false))
+	o.Password = r.Get("OPENVPN_PASSWORD", reader.RetroKeys("PASSWORD"), reader.ForceLowercase(false))
+	o.ConfFile = r.Get("OPENVPN_CUSTOM_CONFIG", reader.ForceLowercase(false))
+	o.Ciphers = r.CSV("OPENVPN_CIPHERS", reader.RetroKeys("OPENVPN_CIPHER"))
+	o.Auth = r.Get("OPENVPN_AUTH")
+	o.Cert = r.Get("OPENVPN_CERT", reader.ForceLowercase(false))
+	o.Key = r.Get("OPENVPN_KEY", reader.ForceLowercase(false))
+	o.EncryptedKey = r.Get("OPENVPN_ENCRYPTED_KEY", reader.ForceLowercase(false))
+	o.KeyPassphrase = r.Get("OPENVPN_KEY_PASSPHRASE", reader.ForceLowercase(false))
+	o.PIAEncPreset = r.Get("PRIVATE_INTERNET_ACCESS_OPENVPN_ENCRYPTION_PRESET",
+		reader.RetroKeys("ENCRYPTION", "PIA_ENCRYPTION"))
+
+	o.MSSFix, err = r.Uint16Ptr("OPENVPN_MSSFIX")
+	if err != nil {
+		return err
+	}
+
+	o.Interface = r.String("VPN_INTERFACE",
+		reader.RetroKeys("OPENVPN_INTERFACE"), reader.ForceLowercase(false))
+
+	o.ProcessUser, err = readOpenVPNProcessUser(r)
+	if err != nil {
+		return err
+	}
+
+	o.Verbosity, err = r.IntPtr("OPENVPN_VERBOSITY")
+	if err != nil {
+		return err
+	}
+
+	flagsPtr := r.Get("OPENVPN_FLAGS", reader.ForceLowercase(false))
+	if flagsPtr != nil {
+		o.Flags = strings.Fields(*flagsPtr)
+	}
+
+	return nil
+}
+
+func readOpenVPNProcessUser(r *reader.Reader) (processUser string, err error) {
+	value, err := r.BoolPtr("OPENVPN_ROOT") // Retro-compatibility
+	if err != nil {
+		return "", err
+	} else if value != nil {
+		if *value {
+			return "root", nil
+		}
+		const defaultNonRootUser = "nonrootuser"
+		return defaultNonRootUser, nil
+	}
+
+	return r.String("OPENVPN_PROCESS_USER"), nil
+}

internal/configuration/settings/openvpnselection.go

@@ -2,10 +2,15 @@ package settings
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gluetun/internal/constants"
 	"github.com/qdm12/gluetun/internal/constants/providers"
 	"github.com/qdm12/gluetun/internal/provider/privateinternetaccess/presets"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
 	"github.com/qdm12/gotree"
 )
 
@@ -14,36 +19,40 @@ type OpenVPNSelection struct {
 	// It can be set to an empty string to indicate to
 	// NOT use a custom configuration file.
 	// It cannot be nil in the internal state.
-	ConfFile *string
+	ConfFile *string `json:"config_file_path"`
-	// TCP is true if the OpenVPN protocol is TCP,
+	// Protocol is the OpenVPN network protocol to use,
-	// and false for UDP.
+	// and can be udp or tcp. It cannot be the empty string
-	// It cannot be nil in the internal state.
+	// in the internal state.
-	TCP *bool
+	Protocol string `json:"protocol"`
 	// CustomPort is the OpenVPN server endpoint port.
 	// It can be set to 0 to indicate no custom port should
 	// be used. It cannot be nil in the internal state.
-	CustomPort *uint16 // HideMyAss, Mullvad, PIA, ProtonVPN, WeVPN, Windscribe
+	CustomPort *uint16 `json:"custom_port"`
 	// PIAEncPreset is the encryption preset for
 	// Private Internet Access. It can be set to an
 	// empty string for other providers.
-	PIAEncPreset *string
+	PIAEncPreset *string `json:"pia_encryption_preset"`
 }
 
 func (o OpenVPNSelection) validate(vpnProvider string) (err error) {
 	// Validate ConfFile
 	if confFile := *o.ConfFile; confFile != "" {
-		err := helpers.FileExists(confFile)
+		err := validate.FileExists(confFile)
 		if err != nil {
 			return fmt.Errorf("configuration file: %w", err)
 		}
 	}
 
+	err = validate.IsOneOf(o.Protocol, constants.UDP, constants.TCP)
+	if err != nil {
+		return fmt.Errorf("network protocol: %w", err)
+	}
+
 	// Validate TCP
-	if *o.TCP && helpers.IsOneOf(vpnProvider,
+	if o.Protocol == constants.TCP && helpers.IsOneOf(vpnProvider,
 		providers.Ipvanish,
 		providers.Perfectprivacy,
 		providers.Privado,
-		providers.VPNUnlimited,
 		providers.Vyprvpn,
 	) {
 		return fmt.Errorf("%w: for VPN service provider %s",
@@ -54,7 +63,7 @@ func (o OpenVPNSelection) validate(vpnProvider string) (err error) {
 	if *o.CustomPort != 0 {
 		switch vpnProvider {
 		// no restriction on port
-		case providers.Cyberghost, providers.HideMyAss,
+		case providers.Custom, providers.Cyberghost, providers.HideMyAss,
 			providers.Privatevpn, providers.Torguard:
 		// no custom port allowed
 		case providers.Expressvpn, providers.Fastestvpn,
@@ -97,16 +106,18 @@ func (o OpenVPNSelection) validate(vpnProvider string) (err error) {
 			case providers.Windscribe:
 				allowedTCP = []uint16{21, 22, 80, 123, 143, 443, 587, 1194, 3306, 8080, 54783}
 				allowedUDP = []uint16{53, 80, 123, 443, 1194, 54783}
+			default:
+				panic(fmt.Sprintf("VPN provider %s has no registered allowed ports", vpnProvider))
 			}
 
-			if *o.TCP && !helpers.Uint16IsOneOf(*o.CustomPort, allowedTCP) {
+			allowedPorts := allowedUDP
-				return fmt.Errorf("%w: %d for VPN service provider %s; %s",
+			if o.Protocol == constants.TCP {
-					ErrOpenVPNCustomPortNotAllowed, o.CustomPort, vpnProvider,
+				allowedPorts = allowedTCP
-					helpers.PortChoicesOrString(allowedTCP))
+			}
-			} else if !*o.TCP && !helpers.Uint16IsOneOf(*o.CustomPort, allowedUDP) {
+			err = validate.IsOneOf(*o.CustomPort, allowedPorts...)
-				return fmt.Errorf("%w: %d for VPN service provider %s; %s",
+			if err != nil {
-					ErrOpenVPNCustomPortNotAllowed, o.CustomPort, vpnProvider,
+				return fmt.Errorf("%w: for VPN service provider %s: %w",
-					helpers.PortChoicesOrString(allowedUDP))
+					ErrOpenVPNCustomPortNotAllowed, vpnProvider, err)
 			}
 		}
 	}
@@ -118,10 +129,8 @@ func (o OpenVPNSelection) validate(vpnProvider string) (err error) {
 			presets.Normal,
 			presets.Strong,
 		}
-		if !helpers.IsOneOf(*o.PIAEncPreset, validEncryptionPresets...) {
+		if err = validate.IsOneOf(*o.PIAEncPreset, validEncryptionPresets...); err != nil {
-			return fmt.Errorf("%w: %s; valid presets are %s",
+			return fmt.Errorf("%w: %w", ErrOpenVPNEncryptionPresetNotValid, err)
-				ErrOpenVPNEncryptionPresetNotValid, *o.PIAEncPreset,
-				helpers.ChoicesOrString(validEncryptionPresets))
 		}
 	}
 
@@ -130,37 +139,30 @@ func (o OpenVPNSelection) validate(vpnProvider string) (err error) {
 
 func (o *OpenVPNSelection) copy() (copied OpenVPNSelection) {
 	return OpenVPNSelection{
-		ConfFile:     helpers.CopyPointer(o.ConfFile),
+		ConfFile:     gosettings.CopyPointer(o.ConfFile),
-		TCP:          helpers.CopyPointer(o.TCP),
+		Protocol:     o.Protocol,
-		CustomPort:   helpers.CopyPointer(o.CustomPort),
+		CustomPort:   gosettings.CopyPointer(o.CustomPort),
-		PIAEncPreset: helpers.CopyPointer(o.PIAEncPreset),
+		PIAEncPreset: gosettings.CopyPointer(o.PIAEncPreset),
 	}
 }
 
-func (o *OpenVPNSelection) mergeWith(other OpenVPNSelection) {
-	o.ConfFile = helpers.MergeWithPointer(o.ConfFile, other.ConfFile)
-	o.TCP = helpers.MergeWithPointer(o.TCP, other.TCP)
-	o.CustomPort = helpers.MergeWithPointer(o.CustomPort, other.CustomPort)
-	o.PIAEncPreset = helpers.MergeWithPointer(o.PIAEncPreset, other.PIAEncPreset)
-}
-
 func (o *OpenVPNSelection) overrideWith(other OpenVPNSelection) {
-	o.ConfFile = helpers.OverrideWithPointer(o.ConfFile, other.ConfFile)
+	o.ConfFile = gosettings.OverrideWithPointer(o.ConfFile, other.ConfFile)
-	o.TCP = helpers.OverrideWithPointer(o.TCP, other.TCP)
+	o.Protocol = gosettings.OverrideWithComparable(o.Protocol, other.Protocol)
-	o.CustomPort = helpers.OverrideWithPointer(o.CustomPort, other.CustomPort)
+	o.CustomPort = gosettings.OverrideWithPointer(o.CustomPort, other.CustomPort)
-	o.PIAEncPreset = helpers.OverrideWithPointer(o.PIAEncPreset, other.PIAEncPreset)
+	o.PIAEncPreset = gosettings.OverrideWithPointer(o.PIAEncPreset, other.PIAEncPreset)
 }
 
 func (o *OpenVPNSelection) setDefaults(vpnProvider string) {
-	o.ConfFile = helpers.DefaultPointer(o.ConfFile, "")
+	o.ConfFile = gosettings.DefaultPointer(o.ConfFile, "")
-	o.TCP = helpers.DefaultPointer(o.TCP, false)
+	o.Protocol = gosettings.DefaultComparable(o.Protocol, constants.UDP)
-	o.CustomPort = helpers.DefaultPointer(o.CustomPort, 0)
+	o.CustomPort = gosettings.DefaultPointer(o.CustomPort, 0)
 
 	var defaultEncPreset string
 	if vpnProvider == providers.PrivateInternetAccess {
 		defaultEncPreset = presets.Strong
 	}
-	o.PIAEncPreset = helpers.DefaultPointer(o.PIAEncPreset, defaultEncPreset)
+	o.PIAEncPreset = gosettings.DefaultPointer(o.PIAEncPreset, defaultEncPreset)
 }
 
 func (o OpenVPNSelection) String() string {
@@ -169,7 +171,7 @@ func (o OpenVPNSelection) String() string {
 
 func (o OpenVPNSelection) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("OpenVPN server selection settings:")
-	node.Appendf("Protocol: %s", helpers.TCPPtrToString(o.TCP))
+	node.Appendf("Protocol: %s", strings.ToUpper(o.Protocol))
 
 	if *o.CustomPort != 0 {
 		node.Appendf("Custom port: %d", *o.CustomPort)
@@ -185,3 +187,23 @@ func (o OpenVPNSelection) toLinesNode() (node *gotree.Node) {
 
 	return node
 }
+
+func (o *OpenVPNSelection) read(r *reader.Reader) (err error) {
+	o.ConfFile = r.Get("OPENVPN_CUSTOM_CONFIG", reader.ForceLowercase(false))
+
+	o.Protocol = r.String("OPENVPN_PROTOCOL", reader.RetroKeys("PROTOCOL"))
+	if err != nil {
+		return err
+	}
+
+	o.CustomPort, err = r.Uint16Ptr("OPENVPN_ENDPOINT_PORT",
+		reader.RetroKeys("PORT", "OPENVPN_PORT", "VPN_ENDPOINT_PORT"))
+	if err != nil {
+		return err
+	}
+
+	o.PIAEncPreset = r.Get("PRIVATE_INTERNET_ACCESS_OPENVPN_ENCRYPTION_PRESET",
+		reader.RetroKeys("ENCRYPTION", "PIA_ENCRYPTION"))
+
+	return nil
+}

internal/configuration/settings/portforward.go

@@ -3,10 +3,11 @@ package settings
 import (
 	"fmt"
 	"path/filepath"
-	"strings"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
 	"github.com/qdm12/gluetun/internal/constants/providers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
 	"github.com/qdm12/gotree"
 )
 
@@ -14,24 +15,47 @@ import (
 type PortForwarding struct {
 	// Enabled is true if port forwarding should be activated.
 	// It cannot be nil for the internal state.
-	Enabled *bool
+	Enabled *bool `json:"enabled"`
+	// Provider is set to specify which custom port forwarding code
+	// should be used. This is especially necessary for the custom
+	// provider using Wireguard for a provider where Wireguard is not
+	// natively supported but custom port forwarding code is available.
+	// It defaults to the empty string, meaning the current provider
+	// should be the one used for port forwarding.
+	// It cannot be nil for the internal state.
+	Provider *string `json:"provider"`
 	// Filepath is the port forwarding status file path
 	// to use. It can be the empty string to indicate not
 	// to write to a file. It cannot be nil for the
 	// internal state
-	Filepath *string
+	Filepath *string `json:"status_file_path"`
+	// ListeningPort is the port traffic would be redirected to from the
+	// forwarded port. The redirection is disabled if it is set to 0, which
+	// is its default as well.
+	ListeningPort *uint16 `json:"listening_port"`
+	// Username is only used for Private Internet Access port forwarding.
+	Username string `json:"username"`
+	// Password is only used for Private Internet Access port forwarding.
+	Password string `json:"password"`
 }
 
-func (p PortForwarding) validate(vpnProvider string) (err error) {
+func (p PortForwarding) Validate(vpnProvider string) (err error) {
 	if !*p.Enabled {
 		return nil
 	}
 
-	// Validate Enabled
+	// Validate current provider or custom provider specified
-	validProviders := []string{providers.PrivateInternetAccess}
+	providerSelected := vpnProvider
-	if !helpers.IsOneOf(vpnProvider, validProviders...) {
+	if *p.Provider != "" {
-		return fmt.Errorf("%w: for provider %s, it is only available for %s",
+		providerSelected = *p.Provider
-			ErrPortForwardingEnabled, vpnProvider, strings.Join(validProviders, ", "))
+	}
+	validProviders := []string{
+		providers.Perfectprivacy,
+		providers.PrivateInternetAccess,
+		providers.Protonvpn,
+	}
+	if err = validate.IsOneOf(providerSelected, validProviders...); err != nil {
+		return fmt.Errorf("%w: %w", ErrPortForwardingEnabled, err)
 	}
 
 	// Validate Filepath
@@ -42,29 +66,43 @@ func (p PortForwarding) validate(vpnProvider string) (err error) {
 		}
 	}
 
+	if providerSelected == providers.PrivateInternetAccess {
+		switch {
+		case p.Username == "":
+			return fmt.Errorf("%w", ErrPortForwardingUserEmpty)
+		case p.Password == "":
+			return fmt.Errorf("%w", ErrPortForwardingPasswordEmpty)
+		}
+	}
+
 	return nil
 }
 
-func (p *PortForwarding) copy() (copied PortForwarding) {
+func (p *PortForwarding) Copy() (copied PortForwarding) {
 	return PortForwarding{
-		Enabled:  helpers.CopyPointer(p.Enabled),
+		Enabled:       gosettings.CopyPointer(p.Enabled),
-		Filepath: helpers.CopyPointer(p.Filepath),
+		Provider:      gosettings.CopyPointer(p.Provider),
+		Filepath:      gosettings.CopyPointer(p.Filepath),
+		ListeningPort: gosettings.CopyPointer(p.ListeningPort),
+		Username:      p.Username,
+		Password:      p.Password,
 	}
 }
 
-func (p *PortForwarding) mergeWith(other PortForwarding) {
+func (p *PortForwarding) OverrideWith(other PortForwarding) {
-	p.Enabled = helpers.MergeWithPointer(p.Enabled, other.Enabled)
+	p.Enabled = gosettings.OverrideWithPointer(p.Enabled, other.Enabled)
-	p.Filepath = helpers.MergeWithPointer(p.Filepath, other.Filepath)
+	p.Provider = gosettings.OverrideWithPointer(p.Provider, other.Provider)
-}
+	p.Filepath = gosettings.OverrideWithPointer(p.Filepath, other.Filepath)
-
+	p.ListeningPort = gosettings.OverrideWithPointer(p.ListeningPort, other.ListeningPort)
-func (p *PortForwarding) overrideWith(other PortForwarding) {
+	p.Username = gosettings.OverrideWithComparable(p.Username, other.Username)
-	p.Enabled = helpers.OverrideWithPointer(p.Enabled, other.Enabled)
+	p.Password = gosettings.OverrideWithComparable(p.Password, other.Password)
-	p.Filepath = helpers.OverrideWithPointer(p.Filepath, other.Filepath)
 }
 
 func (p *PortForwarding) setDefaults() {
-	p.Enabled = helpers.DefaultPointer(p.Enabled, false)
+	p.Enabled = gosettings.DefaultPointer(p.Enabled, false)
-	p.Filepath = helpers.DefaultPointer(p.Filepath, "/tmp/gluetun/forwarded_port")
+	p.Provider = gosettings.DefaultPointer(p.Provider, "")
+	p.Filepath = gosettings.DefaultPointer(p.Filepath, "/tmp/gluetun/forwarded_port")
+	p.ListeningPort = gosettings.DefaultPointer(p.ListeningPort, 0)
 }
 
 func (p PortForwarding) String() string {
@@ -77,7 +115,18 @@ func (p PortForwarding) toLinesNode() (node *gotree.Node) {
 	}
 
 	node = gotree.New("Automatic port forwarding settings:")
-	node.Appendf("Enabled: yes")
+
+	listeningPort := "disabled"
+	if *p.ListeningPort != 0 {
+		listeningPort = fmt.Sprintf("%d", *p.ListeningPort)
+	}
+	node.Appendf("Redirection listening port: %s", listeningPort)
+
+	if *p.Provider == "" {
+		node.Appendf("Use port forwarding code for current provider")
+	} else {
+		node.Appendf("Use code for provider: %s", *p.Provider)
+	}
 
 	filepath := *p.Filepath
 	if filepath == "" {
@@ -85,5 +134,54 @@ func (p PortForwarding) toLinesNode() (node *gotree.Node) {
 	}
 	node.Appendf("Forwarded port file path: %s", filepath)
 
+	if p.Username != "" {
+		credentialsNode := node.Appendf("Credentials:")
+		credentialsNode.Appendf("Username: %s", p.Username)
+		credentialsNode.Appendf("Password: %s", gosettings.ObfuscateKey(p.Password))
+	}
+
 	return node
 }
+
+func (p *PortForwarding) read(r *reader.Reader) (err error) {
+	p.Enabled, err = r.BoolPtr("VPN_PORT_FORWARDING",
+		reader.RetroKeys(
+			"PORT_FORWARDING",
+			"PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING",
+		))
+	if err != nil {
+		return err
+	}
+
+	p.Provider = r.Get("VPN_PORT_FORWARDING_PROVIDER")
+
+	p.Filepath = r.Get("VPN_PORT_FORWARDING_STATUS_FILE",
+		reader.ForceLowercase(false),
+		reader.RetroKeys(
+			"PORT_FORWARDING_STATUS_FILE",
+			"PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING_STATUS_FILE",
+		))
+
+	p.ListeningPort, err = r.Uint16Ptr("VPN_PORT_FORWARDING_LISTENING_PORT")
+	if err != nil {
+		return err
+	}
+
+	usernameKeys := []string{"VPN_PORT_FORWARDING_USERNAME", "OPENVPN_USER", "USER"}
+	for _, key := range usernameKeys {
+		p.Username = r.String(key, reader.ForceLowercase(false))
+		if p.Username != "" {
+			break
+		}
+	}
+
+	passwordKeys := []string{"VPN_PORT_FORWARDING_PASSWORD", "OPENVPN_PASSWORD", "PASSWORD"}
+	for _, key := range passwordKeys {
+		p.Password = r.String(key, reader.ForceLowercase(false))
+		if p.Password != "" {
+			break
+		}
+	}
+
+	return nil
+}

internal/configuration/settings/provider.go

@@ -2,23 +2,26 @@ package settings
 
 import (
 	"fmt"
+	"strings"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
 	"github.com/qdm12/gluetun/internal/constants/providers"
 	"github.com/qdm12/gluetun/internal/constants/vpn"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
 	"github.com/qdm12/gotree"
 )
 
 // Provider contains settings specific to a VPN provider.
 type Provider struct {
 	// Name is the VPN service provider name.
-	// It cannot be nil in the internal state.
+	// It cannot be the empty string in the internal state.
-	Name *string
+	Name string `json:"name"`
 	// ServerSelection is the settings to
 	// select the VPN server.
-	ServerSelection ServerSelection
+	ServerSelection ServerSelection `json:"server_selection"`
 	// PortForwarding is the settings about port forwarding.
-	PortForwarding PortForwarding
+	PortForwarding PortForwarding `json:"port_forwarding"`
 }
 
 // TODO v4 remove pointer for receiver (because of Surfshark).
@@ -32,23 +35,25 @@ func (p *Provider) validate(vpnType string, storage Storage) (err error) {
 		validNames = []string{
 			providers.Airvpn,
 			providers.Custom,
+			providers.Fastestvpn,
 			providers.Ivpn,
 			providers.Mullvad,
+			providers.Nordvpn,
+			providers.Protonvpn,
 			providers.Surfshark,
 			providers.Windscribe,
 		}
 	}
-	if !helpers.IsOneOf(*p.Name, validNames...) {
+	if err = validate.IsOneOf(p.Name, validNames...); err != nil {
-		return fmt.Errorf("%w for Wireguard: %q can only be one of %s",
+		return fmt.Errorf("%w for Wireguard: %w", ErrVPNProviderNameNotValid, err)
-			ErrVPNProviderNameNotValid, *p.Name, helpers.ChoicesOrString(validNames))
 	}
 
-	err = p.ServerSelection.validate(*p.Name, storage)
+	err = p.ServerSelection.validate(p.Name, storage)
 	if err != nil {
 		return fmt.Errorf("server selection: %w", err)
 	}
 
-	err = p.PortForwarding.validate(*p.Name)
+	err = p.PortForwarding.Validate(p.Name)
 	if err != nil {
 		return fmt.Errorf("port forwarding: %w", err)
 	}
@@ -58,28 +63,22 @@ func (p *Provider) validate(vpnType string, storage Storage) (err error) {
 
 func (p *Provider) copy() (copied Provider) {
 	return Provider{
-		Name:            helpers.CopyPointer(p.Name),
+		Name:            p.Name,
 		ServerSelection: p.ServerSelection.copy(),
-		PortForwarding:  p.PortForwarding.copy(),
+		PortForwarding:  p.PortForwarding.Copy(),
 	}
 }
 
-func (p *Provider) mergeWith(other Provider) {
-	p.Name = helpers.MergeWithPointer(p.Name, other.Name)
-	p.ServerSelection.mergeWith(other.ServerSelection)
-	p.PortForwarding.mergeWith(other.PortForwarding)
-}
-
 func (p *Provider) overrideWith(other Provider) {
-	p.Name = helpers.OverrideWithPointer(p.Name, other.Name)
+	p.Name = gosettings.OverrideWithComparable(p.Name, other.Name)
 	p.ServerSelection.overrideWith(other.ServerSelection)
-	p.PortForwarding.overrideWith(other.PortForwarding)
+	p.PortForwarding.OverrideWith(other.PortForwarding)
 }
 
 func (p *Provider) setDefaults() {
-	p.Name = helpers.DefaultPointer(p.Name, providers.PrivateInternetAccess)
+	p.Name = gosettings.DefaultComparable(p.Name, providers.PrivateInternetAccess)
-	p.ServerSelection.setDefaults(*p.Name)
 	p.PortForwarding.setDefaults()
+	p.ServerSelection.setDefaults(p.Name, *p.PortForwarding.Enabled)
 }
 
 func (p Provider) String() string {
@@ -88,8 +87,42 @@ func (p Provider) String() string {
 
 func (p Provider) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("VPN provider settings:")
-	node.Appendf("Name: %s", *p.Name)
+	node.Appendf("Name: %s", p.Name)
 	node.AppendNode(p.ServerSelection.toLinesNode())
 	node.AppendNode(p.PortForwarding.toLinesNode())
 	return node
 }
+
+func (p *Provider) read(r *reader.Reader, vpnType string) (err error) {
+	p.Name = readVPNServiceProvider(r, vpnType)
+
+	err = p.ServerSelection.read(r, p.Name, vpnType)
+	if err != nil {
+		return fmt.Errorf("server selection: %w", err)
+	}
+
+	err = p.PortForwarding.read(r)
+	if err != nil {
+		return fmt.Errorf("port forwarding: %w", err)
+	}
+
+	return nil
+}
+
+func readVPNServiceProvider(r *reader.Reader, vpnType string) (vpnProvider string) {
+	vpnProvider = r.String("VPN_SERVICE_PROVIDER", reader.RetroKeys("VPNSP"))
+	if vpnProvider == "" {
+		if vpnType != vpn.Wireguard && r.Get("OPENVPN_CUSTOM_CONFIG") != nil {
+			// retro compatibility
+			return providers.Custom
+		}
+		return ""
+	}
+
+	vpnProvider = strings.ToLower(vpnProvider)
+	if vpnProvider == "pia" { // retro compatibility
+		return providers.PrivateInternetAccess
+	}
+
+	return vpnProvider
+}

internal/configuration/settings/publicip.go

@@ -5,7 +5,9 @@ import (
 	"path/filepath"
 	"time"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gluetun/internal/publicip/api"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 )
 
@@ -21,6 +23,28 @@ type PublicIP struct {
 	// to write to a file. It cannot be nil for the
 	// internal state
 	IPFilepath *string
+	// API is the API name to use to fetch public IP information.
+	// It can be ipinfo or ip2location. It defaults to ipinfo.
+	API string
+	// APIToken is the token to use for the IP data service
+	// such as ipinfo.io. It can be the empty string to
+	// indicate not to use a token. It cannot be nil for the
+	// internal state.
+	APIToken *string
+}
+
+// UpdateWith deep copies the receiving settings, overrides the copy with
+// fields set in the partialUpdate argument, validates the new settings
+// and returns them if they are valid, or returns an error otherwise.
+// In all cases, the receiving settings are unmodified.
+func (p PublicIP) UpdateWith(partialUpdate PublicIP) (updatedSettings PublicIP, err error) {
+	updatedSettings = p.copy()
+	updatedSettings.overrideWith(partialUpdate)
+	err = updatedSettings.validate()
+	if err != nil {
+		return updatedSettings, fmt.Errorf("validating updated settings: %w", err)
+	}
+	return updatedSettings, nil
 }
 
 func (p PublicIP) validate() (err error) {
@@ -37,30 +61,36 @@ func (p PublicIP) validate() (err error) {
 		}
 	}
 
+	_, err = api.ParseProvider(p.API)
+	if err != nil {
+		return fmt.Errorf("API name: %w", err)
+	}
+
 	return nil
 }
 
 func (p *PublicIP) copy() (copied PublicIP) {
 	return PublicIP{
-		Period:     helpers.CopyPointer(p.Period),
+		Period:     gosettings.CopyPointer(p.Period),
-		IPFilepath: helpers.CopyPointer(p.IPFilepath),
+		IPFilepath: gosettings.CopyPointer(p.IPFilepath),
+		API:        p.API,
+		APIToken:   gosettings.CopyPointer(p.APIToken),
 	}
 }
 
-func (p *PublicIP) mergeWith(other PublicIP) {
-	p.Period = helpers.MergeWithPointer(p.Period, other.Period)
-	p.IPFilepath = helpers.MergeWithPointer(p.IPFilepath, other.IPFilepath)
-}
-
 func (p *PublicIP) overrideWith(other PublicIP) {
-	p.Period = helpers.OverrideWithPointer(p.Period, other.Period)
+	p.Period = gosettings.OverrideWithPointer(p.Period, other.Period)
-	p.IPFilepath = helpers.OverrideWithPointer(p.IPFilepath, other.IPFilepath)
+	p.IPFilepath = gosettings.OverrideWithPointer(p.IPFilepath, other.IPFilepath)
+	p.API = gosettings.OverrideWithComparable(p.API, other.API)
+	p.APIToken = gosettings.OverrideWithPointer(p.APIToken, other.APIToken)
 }
 
 func (p *PublicIP) setDefaults() {
 	const defaultPeriod = 12 * time.Hour
-	p.Period = helpers.DefaultPointer(p.Period, defaultPeriod)
+	p.Period = gosettings.DefaultPointer(p.Period, defaultPeriod)
-	p.IPFilepath = helpers.DefaultPointer(p.IPFilepath, "/tmp/gluetun/ip")
+	p.IPFilepath = gosettings.DefaultPointer(p.IPFilepath, "/tmp/gluetun/ip")
+	p.API = gosettings.DefaultComparable(p.API, "ipinfo")
+	p.APIToken = gosettings.DefaultPointer(p.APIToken, "")
 }
 
 func (p PublicIP) String() string {
@@ -85,5 +115,24 @@ func (p PublicIP) toLinesNode() (node *gotree.Node) {
 		node.Appendf("IP file path: %s", *p.IPFilepath)
 	}
 
+	node.Appendf("Public IP data API: %s", p.API)
+
+	if *p.APIToken != "" {
+		node.Appendf("API token: %s", gosettings.ObfuscateKey(*p.APIToken))
+	}
+
 	return node
 }
+
+func (p *PublicIP) read(r *reader.Reader) (err error) {
+	p.Period, err = r.DurationPtr("PUBLICIP_PERIOD")
+	if err != nil {
+		return err
+	}
+
+	p.IPFilepath = r.Get("PUBLICIP_FILE",
+		reader.ForceLowercase(false), reader.RetroKeys("IP_STATUS_FILE"))
+	p.API = r.String("PUBLICIP_API")
+	p.APIToken = r.Get("PUBLICIP_API_TOKEN")
+	return nil
+}

internal/configuration/settings/server.go

@@ -6,7 +6,8 @@ import (
 	"os"
 	"strconv"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 )
 
@@ -43,29 +44,22 @@ func (c ControlServer) validate() (err error) {
 
 func (c *ControlServer) copy() (copied ControlServer) {
 	return ControlServer{
-		Address: helpers.CopyPointer(c.Address),
+		Address: gosettings.CopyPointer(c.Address),
-		Log:     helpers.CopyPointer(c.Log),
+		Log:     gosettings.CopyPointer(c.Log),
 	}
 }
 
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (c *ControlServer) mergeWith(other ControlServer) {
-	c.Address = helpers.MergeWithPointer(c.Address, other.Address)
-	c.Log = helpers.MergeWithPointer(c.Log, other.Log)
-}
-
 // overrideWith overrides fields of the receiver
 // settings object with any field set in the other
 // settings.
 func (c *ControlServer) overrideWith(other ControlServer) {
-	c.Address = helpers.OverrideWithPointer(c.Address, other.Address)
+	c.Address = gosettings.OverrideWithPointer(c.Address, other.Address)
-	c.Log = helpers.OverrideWithPointer(c.Log, other.Log)
+	c.Log = gosettings.OverrideWithPointer(c.Log, other.Log)
 }
 
 func (c *ControlServer) setDefaults() {
-	c.Address = helpers.DefaultPointer(c.Address, ":8000")
+	c.Address = gosettings.DefaultPointer(c.Address, ":8000")
-	c.Log = helpers.DefaultPointer(c.Log, true)
+	c.Log = gosettings.DefaultPointer(c.Log, true)
 }
 
 func (c ControlServer) String() string {
@@ -75,6 +69,15 @@ func (c ControlServer) String() string {
 func (c ControlServer) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("Control server settings:")
 	node.Appendf("Listening address: %s", *c.Address)
-	node.Appendf("Logging: %s", helpers.BoolPtrToYesNo(c.Log))
+	node.Appendf("Logging: %s", gosettings.BoolToYesNo(c.Log))
 	return node
 }
+
+func (c *ControlServer) read(r *reader.Reader) (err error) {
+	c.Log, err = r.BoolPtr("HTTP_CONTROL_SERVER_LOG")
+	if err != nil {
+		return err
+	}
+	c.Address = r.Get("HTTP_CONTROL_SERVER_ADDRESS")
+	return nil
+}

internal/configuration/settings/serverselection.go

@@ -11,6 +11,9 @@ import (
 	"github.com/qdm12/gluetun/internal/constants/providers"
 	"github.com/qdm12/gluetun/internal/constants/vpn"
 	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
 	"github.com/qdm12/gotree"
 )
 
@@ -18,59 +21,73 @@ type ServerSelection struct { //nolint:maligned
 	// VPN is the VPN type which can be 'openvpn'
 	// or 'wireguard'. It cannot be the empty string
 	// in the internal state.
-	VPN string
+	VPN string `json:"vpn"`
 	// TargetIP is the server endpoint IP address to use.
 	// It will override any IP address from the picked
 	// built-in server. It cannot be the empty value in the internal
 	// state, and can be set to the unspecified address to indicate
 	// there is not target IP address to use.
-	TargetIP netip.Addr
+	TargetIP netip.Addr `json:"target_ip"`
-	// Counties is the list of countries to filter VPN servers with.
+	// Countries is the list of countries to filter VPN servers with.
-	Countries []string
+	Countries []string `json:"countries"`
+	// Categories is the list of categories to filter VPN servers with.
+	Categories []string `json:"categories"`
 	// Regions is the list of regions to filter VPN servers with.
-	Regions []string
+	Regions []string `json:"regions"`
 	// Cities is the list of cities to filter VPN servers with.
-	Cities []string
+	Cities []string `json:"cities"`
 	// ISPs is the list of ISP names to filter VPN servers with.
-	ISPs []string
+	ISPs []string `json:"isps"`
 	// Names is the list of server names to filter VPN servers with.
-	Names []string
+	Names []string `json:"names"`
 	// Numbers is the list of server numbers to filter VPN servers with.
-	Numbers []uint16
+	Numbers []uint16 `json:"numbers"`
 	// Hostnames is the list of hostnames to filter VPN servers with.
-	Hostnames []string
+	Hostnames []string `json:"hostnames"`
 	// OwnedOnly is true if VPN provider servers that are not owned
 	// should be filtered. This is used with Mullvad.
-	OwnedOnly *bool
+	OwnedOnly *bool `json:"owned_only"`
 	// FreeOnly is true if VPN servers that are not free should
 	// be filtered. This is used with ProtonVPN and VPN Unlimited.
-	FreeOnly *bool
+	FreeOnly *bool `json:"free_only"`
 	// PremiumOnly is true if VPN servers that are not premium should
 	// be filtered. This is used with VPN Secure.
 	// TODO extend to providers using FreeOnly.
-	PremiumOnly *bool
+	PremiumOnly *bool `json:"premium_only"`
 	// StreamOnly is true if VPN servers not for streaming should
-	// be filtered. This is used with VPNUnlimited.
+	// be filtered. This is used with ProtonVPN and VPNUnlimited.
-	StreamOnly *bool
+	StreamOnly *bool `json:"stream_only"`
 	// MultiHopOnly is true if VPN servers that are not multihop
 	// should be filtered. This is used with Surfshark.
-	MultiHopOnly *bool
+	MultiHopOnly *bool `json:"multi_hop_only"`
-
+	// PortForwardOnly is true if VPN servers that don't support
+	// port forwarding should be filtered. This is used with PIA
+	// and ProtonVPN.
+	PortForwardOnly *bool `json:"port_forward_only"`
+	// SecureCoreOnly is true if VPN servers without secure core should
+	// be filtered. This is used with ProtonVPN.
+	SecureCoreOnly *bool `json:"secure_core_only"`
+	// TorOnly is true if VPN servers without tor should
+	// be filtered. This is used with ProtonVPN.
+	TorOnly *bool `json:"tor_only"`
 	// OpenVPN contains settings to select OpenVPN servers
 	// and the final connection.
-	OpenVPN OpenVPNSelection
+	OpenVPN OpenVPNSelection `json:"openvpn"`
 	// Wireguard contains settings to select Wireguard servers
 	// and the final connection.
-	Wireguard WireguardSelection
+	Wireguard WireguardSelection `json:"wireguard"`
 }
 
 var (
-	ErrOwnedOnlyNotSupported    = errors.New("owned only filter is not supported")
+	ErrOwnedOnlyNotSupported       = errors.New("owned only filter is not supported")
-	ErrFreeOnlyNotSupported     = errors.New("free only filter is not supported")
+	ErrFreeOnlyNotSupported        = errors.New("free only filter is not supported")
-	ErrPremiumOnlyNotSupported  = errors.New("premium only filter is not supported")
+	ErrPremiumOnlyNotSupported     = errors.New("premium only filter is not supported")
-	ErrStreamOnlyNotSupported   = errors.New("stream only filter is not supported")
+	ErrStreamOnlyNotSupported      = errors.New("stream only filter is not supported")
-	ErrMultiHopOnlyNotSupported = errors.New("multi hop only filter is not supported")
+	ErrMultiHopOnlyNotSupported    = errors.New("multi hop only filter is not supported")
-	ErrFreePremiumBothSet       = errors.New("free only and premium only filters are both set")
+	ErrPortForwardOnlyNotSupported = errors.New("port forwarding only filter is not supported")
+	ErrFreePremiumBothSet          = errors.New("free only and premium only filters are both set")
+	ErrSecureCoreOnlyNotSupported  = errors.New("secure core only filter is not supported")
+	ErrTorOnlyNotSupported         = errors.New("tor only filter is not supported")
 )
 
 func (ss *ServerSelection) validate(vpnServiceProvider string,
@@ -86,54 +103,27 @@ func (ss *ServerSelection) validate(vpnServiceProvider string,
 		return err // already wrapped error
 	}
 
-	err = validateServerFilters(*ss, filterChoices)
+	// Retro-compatibility
+	switch vpnServiceProvider {
+	case providers.Nordvpn:
+		*ss = nordvpnRetroRegion(*ss, filterChoices.Regions, filterChoices.Countries)
+	case providers.Surfshark:
+		*ss = surfsharkRetroRegion(*ss)
+	}
+
+	err = validateServerFilters(*ss, filterChoices, vpnServiceProvider)
 	if err != nil {
-		if errors.Is(err, helpers.ErrNoChoice) {
+		return fmt.Errorf("for VPN service provider %s: %w", vpnServiceProvider, err)
-			return fmt.Errorf("for VPN service provider %s: %w", vpnServiceProvider, err)
-		}
-		return err // already wrapped error
 	}
 
-	if *ss.OwnedOnly &&
+	err = validateSubscriptionTierFilters(*ss, vpnServiceProvider)
-		vpnServiceProvider != providers.Mullvad {
+	if err != nil {
-		return fmt.Errorf("%w: for VPN service provider %s",
+		return fmt.Errorf("for VPN service provider %s: %w", vpnServiceProvider, err)
-			ErrOwnedOnlyNotSupported, vpnServiceProvider)
 	}
 
-	if *ss.FreeOnly &&
+	err = validateFeatureFilters(*ss, vpnServiceProvider)
-		!helpers.IsOneOf(vpnServiceProvider,
+	if err != nil {
-			providers.Protonvpn,
+		return fmt.Errorf("for VPN service provider %s: %w", vpnServiceProvider, err)
-			providers.VPNUnlimited,
-		) {
-		return fmt.Errorf("%w: for VPN service provider %s",
-			ErrFreeOnlyNotSupported, vpnServiceProvider)
-	}
-
-	if *ss.PremiumOnly &&
-		!helpers.IsOneOf(vpnServiceProvider,
-			providers.VPNSecure,
-		) {
-		return fmt.Errorf("%w: for VPN service provider %s",
-			ErrPremiumOnlyNotSupported, vpnServiceProvider)
-	}
-
-	if *ss.FreeOnly && *ss.PremiumOnly {
-		return fmt.Errorf("%w", ErrFreePremiumBothSet)
-	}
-
-	if *ss.StreamOnly &&
-		!helpers.IsOneOf(vpnServiceProvider,
-			providers.Protonvpn,
-			providers.VPNUnlimited,
-		) {
-		return fmt.Errorf("%w: for VPN service provider %s",
-			ErrStreamOnlyNotSupported, vpnServiceProvider)
-	}
-
-	if *ss.MultiHopOnly &&
-		vpnServiceProvider != providers.Surfshark {
-		return fmt.Errorf("%w: for VPN service provider %s",
-			ErrMultiHopOnlyNotSupported, vpnServiceProvider)
 	}
 
 	if ss.VPN == vpn.OpenVPN {
@@ -159,11 +149,14 @@ func getLocationFilterChoices(vpnServiceProvider string,
 	if vpnServiceProvider == providers.Surfshark {
 		// // Retro compatibility
 		// TODO v4 remove
-		filterChoices.Regions = append(filterChoices.Regions, validation.SurfsharkRetroLocChoices()...)
+		newAndRetroRegions := append(filterChoices.Regions, validation.SurfsharkRetroLocChoices()...) //nolint:gocritic
-		if err := helpers.AreAllOneOf(ss.Regions, filterChoices.Regions); err != nil {
+		err := validate.AreAllOneOfCaseInsensitive(ss.Regions, newAndRetroRegions)
-			return models.FilterChoices{}, fmt.Errorf("%w: %s", ErrRegionNotValid, err)
+		if err != nil {
+			// Only return error comparing with newer regions, we don't want to confuse the user
+			// with the retro regions in the error message.
+			err = validate.AreAllOneOfCaseInsensitive(ss.Regions, filterChoices.Regions)
+			return models.FilterChoices{}, fmt.Errorf("%w: %w", ErrRegionNotValid, err)
 		}
-		*ss = surfsharkRetroRegion(*ss)
 	}
 
 	return filterChoices, nil
@@ -171,102 +164,152 @@ func getLocationFilterChoices(vpnServiceProvider string,
 
 // validateServerFilters validates filters against the choices given as arguments.
 // Set an argument to nil to pass the check for a particular filter.
-func validateServerFilters(settings ServerSelection, filterChoices models.FilterChoices) (err error) {
+func validateServerFilters(settings ServerSelection, filterChoices models.FilterChoices,
-	if err := helpers.AreAllOneOf(settings.Countries, filterChoices.Countries); err != nil {
+	vpnServiceProvider string) (err error) {
-		return fmt.Errorf("%w: %s", ErrCountryNotValid, err)
+	err = validate.AreAllOneOfCaseInsensitive(settings.Countries, filterChoices.Countries)
+	if err != nil {
+		return fmt.Errorf("%w: %w", ErrCountryNotValid, err)
 	}
 
-	if err := helpers.AreAllOneOf(settings.Regions, filterChoices.Regions); err != nil {
+	err = validate.AreAllOneOfCaseInsensitive(settings.Regions, filterChoices.Regions)
-		return fmt.Errorf("%w: %s", ErrRegionNotValid, err)
+	if err != nil {
+		return fmt.Errorf("%w: %w", ErrRegionNotValid, err)
 	}
 
-	if err := helpers.AreAllOneOf(settings.Cities, filterChoices.Cities); err != nil {
+	err = validate.AreAllOneOfCaseInsensitive(settings.Cities, filterChoices.Cities)
-		return fmt.Errorf("%w: %s", ErrCityNotValid, err)
+	if err != nil {
+		return fmt.Errorf("%w: %w", ErrCityNotValid, err)
 	}
 
-	if err := helpers.AreAllOneOf(settings.ISPs, filterChoices.ISPs); err != nil {
+	err = validate.AreAllOneOfCaseInsensitive(settings.ISPs, filterChoices.ISPs)
-		return fmt.Errorf("%w: %s", ErrISPNotValid, err)
+	if err != nil {
+		return fmt.Errorf("%w: %w", ErrISPNotValid, err)
 	}
 
-	if err := helpers.AreAllOneOf(settings.Hostnames, filterChoices.Hostnames); err != nil {
+	err = validate.AreAllOneOfCaseInsensitive(settings.Hostnames, filterChoices.Hostnames)
-		return fmt.Errorf("%w: %s", ErrHostnameNotValid, err)
+	if err != nil {
+		return fmt.Errorf("%w: %w", ErrHostnameNotValid, err)
 	}
 
-	if err := helpers.AreAllOneOf(settings.Names, filterChoices.Names); err != nil {
+	if vpnServiceProvider == providers.Custom && len(settings.Names) == 1 {
-		return fmt.Errorf("%w: %s", ErrNameNotValid, err)
+		// Allow a single name to be specified for the custom provider in case
+		// the user wants to use VPN server side port forwarding with PIA
+		// which requires a server name for TLS verification.
+		filterChoices.Names = settings.Names
+	}
+	err = validate.AreAllOneOfCaseInsensitive(settings.Names, filterChoices.Names)
+	if err != nil {
+		return fmt.Errorf("%w: %w", ErrNameNotValid, err)
+	}
+
+	err = validate.AreAllOneOfCaseInsensitive(settings.Categories, filterChoices.Categories)
+	if err != nil {
+		return fmt.Errorf("%w: %w", ErrCategoryNotValid, err)
 	}
 
 	return nil
 }
 
-func (ss *ServerSelection) copy() (copied ServerSelection) {
+func validateSubscriptionTierFilters(settings ServerSelection, vpnServiceProvider string) error {
-	return ServerSelection{
+	switch {
-		VPN:          ss.VPN,
+	case *settings.FreeOnly &&
-		TargetIP:     ss.TargetIP,
+		!helpers.IsOneOf(vpnServiceProvider, providers.Protonvpn, providers.VPNUnlimited):
-		Countries:    helpers.CopySlice(ss.Countries),
+		return fmt.Errorf("%w", ErrFreeOnlyNotSupported)
-		Regions:      helpers.CopySlice(ss.Regions),
+	case *settings.PremiumOnly &&
-		Cities:       helpers.CopySlice(ss.Cities),
+		!helpers.IsOneOf(vpnServiceProvider, providers.VPNSecure):
-		ISPs:         helpers.CopySlice(ss.ISPs),
+		return fmt.Errorf("%w", ErrPremiumOnlyNotSupported)
-		Hostnames:    helpers.CopySlice(ss.Hostnames),
+	case *settings.FreeOnly && *settings.PremiumOnly:
-		Names:        helpers.CopySlice(ss.Names),
+		return fmt.Errorf("%w", ErrFreePremiumBothSet)
-		Numbers:      helpers.CopySlice(ss.Numbers),
+	default:
-		OwnedOnly:    helpers.CopyPointer(ss.OwnedOnly),
+		return nil
-		FreeOnly:     helpers.CopyPointer(ss.FreeOnly),
-		PremiumOnly:  helpers.CopyPointer(ss.PremiumOnly),
-		StreamOnly:   helpers.CopyPointer(ss.StreamOnly),
-		MultiHopOnly: helpers.CopyPointer(ss.MultiHopOnly),
-		OpenVPN:      ss.OpenVPN.copy(),
-		Wireguard:    ss.Wireguard.copy(),
 	}
 }
 
-func (ss *ServerSelection) mergeWith(other ServerSelection) {
+func validateFeatureFilters(settings ServerSelection, vpnServiceProvider string) error {
-	ss.VPN = helpers.MergeWithString(ss.VPN, other.VPN)
+	switch {
-	ss.TargetIP = helpers.MergeWithIP(ss.TargetIP, other.TargetIP)
+	case *settings.OwnedOnly && vpnServiceProvider != providers.Mullvad:
-	ss.Countries = helpers.MergeSlices(ss.Countries, other.Countries)
+		return fmt.Errorf("%w", ErrOwnedOnlyNotSupported)
-	ss.Regions = helpers.MergeSlices(ss.Regions, other.Regions)
+	case *settings.StreamOnly &&
-	ss.Cities = helpers.MergeSlices(ss.Cities, other.Cities)
+		!helpers.IsOneOf(vpnServiceProvider, providers.Protonvpn, providers.VPNUnlimited):
-	ss.ISPs = helpers.MergeSlices(ss.ISPs, other.ISPs)
+		return fmt.Errorf("%w", ErrStreamOnlyNotSupported)
-	ss.Hostnames = helpers.MergeSlices(ss.Hostnames, other.Hostnames)
+	case *settings.MultiHopOnly && vpnServiceProvider != providers.Surfshark:
-	ss.Names = helpers.MergeSlices(ss.Names, other.Names)
+		return fmt.Errorf("%w", ErrMultiHopOnlyNotSupported)
-	ss.Numbers = helpers.MergeSlices(ss.Numbers, other.Numbers)
+	case *settings.PortForwardOnly &&
-	ss.OwnedOnly = helpers.MergeWithPointer(ss.OwnedOnly, other.OwnedOnly)
+		!helpers.IsOneOf(vpnServiceProvider, providers.PrivateInternetAccess, providers.Protonvpn):
-	ss.FreeOnly = helpers.MergeWithPointer(ss.FreeOnly, other.FreeOnly)
+		return fmt.Errorf("%w", ErrPortForwardOnlyNotSupported)
-	ss.PremiumOnly = helpers.MergeWithPointer(ss.PremiumOnly, other.PremiumOnly)
+	case *settings.SecureCoreOnly && vpnServiceProvider != providers.Protonvpn:
-	ss.StreamOnly = helpers.MergeWithPointer(ss.StreamOnly, other.StreamOnly)
+		return fmt.Errorf("%w", ErrSecureCoreOnlyNotSupported)
-	ss.MultiHopOnly = helpers.MergeWithPointer(ss.MultiHopOnly, other.MultiHopOnly)
+	case *settings.TorOnly && vpnServiceProvider != providers.Protonvpn:
+		return fmt.Errorf("%w", ErrTorOnlyNotSupported)
+	default:
+		return nil
+	}
+}
 
-	ss.OpenVPN.mergeWith(other.OpenVPN)
+func (ss *ServerSelection) copy() (copied ServerSelection) {
-	ss.Wireguard.mergeWith(other.Wireguard)
+	return ServerSelection{
+		VPN:             ss.VPN,
+		TargetIP:        ss.TargetIP,
+		Countries:       gosettings.CopySlice(ss.Countries),
+		Categories:      gosettings.CopySlice(ss.Categories),
+		Regions:         gosettings.CopySlice(ss.Regions),
+		Cities:          gosettings.CopySlice(ss.Cities),
+		ISPs:            gosettings.CopySlice(ss.ISPs),
+		Hostnames:       gosettings.CopySlice(ss.Hostnames),
+		Names:           gosettings.CopySlice(ss.Names),
+		Numbers:         gosettings.CopySlice(ss.Numbers),
+		OwnedOnly:       gosettings.CopyPointer(ss.OwnedOnly),
+		FreeOnly:        gosettings.CopyPointer(ss.FreeOnly),
+		PremiumOnly:     gosettings.CopyPointer(ss.PremiumOnly),
+		StreamOnly:      gosettings.CopyPointer(ss.StreamOnly),
+		SecureCoreOnly:  gosettings.CopyPointer(ss.SecureCoreOnly),
+		TorOnly:         gosettings.CopyPointer(ss.TorOnly),
+		PortForwardOnly: gosettings.CopyPointer(ss.PortForwardOnly),
+		MultiHopOnly:    gosettings.CopyPointer(ss.MultiHopOnly),
+		OpenVPN:         ss.OpenVPN.copy(),
+		Wireguard:       ss.Wireguard.copy(),
+	}
 }
 
 func (ss *ServerSelection) overrideWith(other ServerSelection) {
-	ss.VPN = helpers.OverrideWithString(ss.VPN, other.VPN)
+	ss.VPN = gosettings.OverrideWithComparable(ss.VPN, other.VPN)
-	ss.TargetIP = helpers.OverrideWithIP(ss.TargetIP, other.TargetIP)
+	ss.TargetIP = gosettings.OverrideWithValidator(ss.TargetIP, other.TargetIP)
-	ss.Countries = helpers.OverrideWithSlice(ss.Countries, other.Countries)
+	ss.Countries = gosettings.OverrideWithSlice(ss.Countries, other.Countries)
-	ss.Regions = helpers.OverrideWithSlice(ss.Regions, other.Regions)
+	ss.Categories = gosettings.OverrideWithSlice(ss.Categories, other.Categories)
-	ss.Cities = helpers.OverrideWithSlice(ss.Cities, other.Cities)
+	ss.Regions = gosettings.OverrideWithSlice(ss.Regions, other.Regions)
-	ss.ISPs = helpers.OverrideWithSlice(ss.ISPs, other.ISPs)
+	ss.Cities = gosettings.OverrideWithSlice(ss.Cities, other.Cities)
-	ss.Hostnames = helpers.OverrideWithSlice(ss.Hostnames, other.Hostnames)
+	ss.ISPs = gosettings.OverrideWithSlice(ss.ISPs, other.ISPs)
-	ss.Names = helpers.OverrideWithSlice(ss.Names, other.Names)
+	ss.Hostnames = gosettings.OverrideWithSlice(ss.Hostnames, other.Hostnames)
-	ss.Numbers = helpers.OverrideWithSlice(ss.Numbers, other.Numbers)
+	ss.Names = gosettings.OverrideWithSlice(ss.Names, other.Names)
-	ss.OwnedOnly = helpers.OverrideWithPointer(ss.OwnedOnly, other.OwnedOnly)
+	ss.Numbers = gosettings.OverrideWithSlice(ss.Numbers, other.Numbers)
-	ss.FreeOnly = helpers.OverrideWithPointer(ss.FreeOnly, other.FreeOnly)
+	ss.OwnedOnly = gosettings.OverrideWithPointer(ss.OwnedOnly, other.OwnedOnly)
-	ss.PremiumOnly = helpers.OverrideWithPointer(ss.PremiumOnly, other.PremiumOnly)
+	ss.FreeOnly = gosettings.OverrideWithPointer(ss.FreeOnly, other.FreeOnly)
-	ss.StreamOnly = helpers.OverrideWithPointer(ss.StreamOnly, other.StreamOnly)
+	ss.PremiumOnly = gosettings.OverrideWithPointer(ss.PremiumOnly, other.PremiumOnly)
-	ss.MultiHopOnly = helpers.OverrideWithPointer(ss.MultiHopOnly, other.MultiHopOnly)
+	ss.StreamOnly = gosettings.OverrideWithPointer(ss.StreamOnly, other.StreamOnly)
+	ss.SecureCoreOnly = gosettings.OverrideWithPointer(ss.SecureCoreOnly, other.SecureCoreOnly)
+	ss.TorOnly = gosettings.OverrideWithPointer(ss.TorOnly, other.TorOnly)
+	ss.MultiHopOnly = gosettings.OverrideWithPointer(ss.MultiHopOnly, other.MultiHopOnly)
+	ss.PortForwardOnly = gosettings.OverrideWithPointer(ss.PortForwardOnly, other.PortForwardOnly)
 	ss.OpenVPN.overrideWith(other.OpenVPN)
 	ss.Wireguard.overrideWith(other.Wireguard)
 }
 
-func (ss *ServerSelection) setDefaults(vpnProvider string) {
+func (ss *ServerSelection) setDefaults(vpnProvider string, portForwardingEnabled bool) {
-	ss.VPN = helpers.DefaultString(ss.VPN, vpn.OpenVPN)
+	ss.VPN = gosettings.DefaultComparable(ss.VPN, vpn.OpenVPN)
-	ss.TargetIP = helpers.DefaultIP(ss.TargetIP, netip.IPv4Unspecified())
+	ss.TargetIP = gosettings.DefaultValidator(ss.TargetIP, netip.IPv4Unspecified())
-	ss.OwnedOnly = helpers.DefaultPointer(ss.OwnedOnly, false)
+	ss.OwnedOnly = gosettings.DefaultPointer(ss.OwnedOnly, false)
-	ss.FreeOnly = helpers.DefaultPointer(ss.FreeOnly, false)
+	ss.FreeOnly = gosettings.DefaultPointer(ss.FreeOnly, false)
-	ss.PremiumOnly = helpers.DefaultPointer(ss.PremiumOnly, false)
+	ss.PremiumOnly = gosettings.DefaultPointer(ss.PremiumOnly, false)
-	ss.StreamOnly = helpers.DefaultPointer(ss.StreamOnly, false)
+	ss.StreamOnly = gosettings.DefaultPointer(ss.StreamOnly, false)
-	ss.MultiHopOnly = helpers.DefaultPointer(ss.MultiHopOnly, false)
+	ss.SecureCoreOnly = gosettings.DefaultPointer(ss.SecureCoreOnly, false)
+	ss.TorOnly = gosettings.DefaultPointer(ss.TorOnly, false)
+	ss.MultiHopOnly = gosettings.DefaultPointer(ss.MultiHopOnly, false)
+	defaultPortForwardOnly := false
+	if portForwardingEnabled && helpers.IsOneOf(vpnProvider,
+		providers.PrivateInternetAccess, providers.Protonvpn) {
+		defaultPortForwardOnly = true
+	}
+	ss.PortForwardOnly = gosettings.DefaultPointer(ss.PortForwardOnly, defaultPortForwardOnly)
 	ss.OpenVPN.setDefaults(vpnProvider)
 	ss.Wireguard.setDefaults()
 }
@@ -286,6 +329,10 @@ func (ss ServerSelection) toLinesNode() (node *gotree.Node) {
 		node.Appendf("Countries: %s", strings.Join(ss.Countries, ", "))
 	}
 
+	if len(ss.Categories) > 0 {
+		node.Appendf("Categories: %s", strings.Join(ss.Categories, ", "))
+	}
+
 	if len(ss.Regions) > 0 {
 		node.Appendf("Regions: %s", strings.Join(ss.Regions, ", "))
 	}
@@ -329,10 +376,22 @@ func (ss ServerSelection) toLinesNode() (node *gotree.Node) {
 		node.Appendf("Stream only servers: yes")
 	}
 
+	if *ss.SecureCoreOnly {
+		node.Appendf("Secure Core only servers: yes")
+	}
+
+	if *ss.TorOnly {
+		node.Appendf("Tor only servers: yes")
+	}
+
 	if *ss.MultiHopOnly {
 		node.Appendf("Multi-hop only servers: yes")
 	}
 
+	if *ss.PortForwardOnly {
+		node.Appendf("Port forwarding only servers: yes")
+	}
+
 	if ss.VPN == vpn.OpenVPN {
 		node.AppendNode(ss.OpenVPN.toLinesNode())
 	} else {
@@ -345,6 +404,95 @@ func (ss ServerSelection) toLinesNode() (node *gotree.Node) {
 // WithDefaults is a shorthand using setDefaults.
 // It's used in unit tests in other packages.
 func (ss ServerSelection) WithDefaults(provider string) ServerSelection {
-	ss.setDefaults(provider)
+	const portForwardingEnabled = false
+	ss.setDefaults(provider, portForwardingEnabled)
 	return ss
 }
+
+func (ss *ServerSelection) read(r *reader.Reader,
+	vpnProvider, vpnType string) (err error) {
+	ss.VPN = vpnType
+
+	ss.TargetIP, err = r.NetipAddr("OPENVPN_ENDPOINT_IP",
+		reader.RetroKeys("OPENVPN_TARGET_IP", "VPN_ENDPOINT_IP"))
+	if err != nil {
+		return err
+	}
+
+	countriesRetroKeys := []string{"COUNTRY"}
+	if vpnProvider == providers.Cyberghost {
+		countriesRetroKeys = append(countriesRetroKeys, "REGION")
+	}
+	ss.Countries = r.CSV("SERVER_COUNTRIES", reader.RetroKeys(countriesRetroKeys...))
+
+	ss.Regions = r.CSV("SERVER_REGIONS", reader.RetroKeys("REGION"))
+	ss.Cities = r.CSV("SERVER_CITIES", reader.RetroKeys("CITY"))
+	ss.ISPs = r.CSV("ISP")
+	ss.Hostnames = r.CSV("SERVER_HOSTNAMES", reader.RetroKeys("SERVER_HOSTNAME"))
+	ss.Names = r.CSV("SERVER_NAMES", reader.RetroKeys("SERVER_NAME"))
+	ss.Numbers, err = r.CSVUint16("SERVER_NUMBER")
+	ss.Categories = r.CSV("SERVER_CATEGORIES")
+	if err != nil {
+		return err
+	}
+
+	// Mullvad only
+	ss.OwnedOnly, err = r.BoolPtr("OWNED_ONLY", reader.RetroKeys("OWNED"))
+	if err != nil {
+		return err
+	}
+
+	// VPNUnlimited and ProtonVPN only
+	ss.FreeOnly, err = r.BoolPtr("FREE_ONLY")
+	if err != nil {
+		return err
+	}
+
+	// VPNSecure only
+	ss.PremiumOnly, err = r.BoolPtr("PREMIUM_ONLY")
+	if err != nil {
+		return err
+	}
+
+	// Surfshark only
+	ss.MultiHopOnly, err = r.BoolPtr("MULTIHOP_ONLY")
+	if err != nil {
+		return err
+	}
+
+	// VPNUnlimited and ProtonVPN only
+	ss.StreamOnly, err = r.BoolPtr("STREAM_ONLY")
+	if err != nil {
+		return err
+	}
+
+	// ProtonVPN only
+	ss.SecureCoreOnly, err = r.BoolPtr("SECURE_CORE_ONLY")
+	if err != nil {
+		return err
+	}
+
+	// ProtonVPN only
+	ss.TorOnly, err = r.BoolPtr("TOR_ONLY")
+	if err != nil {
+		return err
+	}
+
+	// PIA and ProtonVPN only
+	ss.PortForwardOnly, err = r.BoolPtr("PORT_FORWARD_ONLY")
+	if err != nil {
+		return err
+	}
+
+	err = ss.OpenVPN.read(r)
+	if err != nil {
+		return err
+	}
+
+	err = ss.Wireguard.read(r)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/configuration/settings/settings.go

@@ -2,13 +2,14 @@ package settings
 
 import (
 	"fmt"
+	"net/netip"
 
 	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
-	"github.com/qdm12/gluetun/internal/constants/openvpn"
 	"github.com/qdm12/gluetun/internal/constants/providers"
 	"github.com/qdm12/gluetun/internal/constants/vpn"
 	"github.com/qdm12/gluetun/internal/models"
 	"github.com/qdm12/gluetun/internal/pprof"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 )
 
@@ -82,22 +83,6 @@ func (s *Settings) copy() (copied Settings) {
 	}
 }
 
-func (s *Settings) MergeWith(other Settings) {
-	s.ControlServer.mergeWith(other.ControlServer)
-	s.DNS.mergeWith(other.DNS)
-	s.Firewall.mergeWith(other.Firewall)
-	s.Health.MergeWith(other.Health)
-	s.HTTPProxy.mergeWith(other.HTTPProxy)
-	s.Log.mergeWith(other.Log)
-	s.PublicIP.mergeWith(other.PublicIP)
-	s.Shadowsocks.mergeWith(other.Shadowsocks)
-	s.System.mergeWith(other.System)
-	s.Updater.mergeWith(other.Updater)
-	s.Version.mergeWith(other.Version)
-	s.VPN.mergeWith(other.VPN)
-	s.Pprof.MergeWith(other.Pprof)
-}
-
 func (s *Settings) OverrideWith(other Settings,
 	storage Storage, ipv6Supported bool) (err error) {
 	patchedSettings := s.copy()
@@ -134,7 +119,7 @@ func (s *Settings) SetDefaults() {
 	s.System.setDefaults()
 	s.Version.setDefaults()
 	s.VPN.setDefaults()
-	s.Updater.SetDefaults(*s.VPN.Provider.Name)
+	s.Updater.SetDefaults(s.VPN.Provider.Name)
 	s.Pprof.SetDefaults()
 }
 
@@ -163,35 +148,58 @@ func (s Settings) toLinesNode() (node *gotree.Node) {
 }
 
 func (s Settings) Warnings() (warnings []string) {
-	if *s.VPN.Provider.Name == providers.HideMyAss {
+	if s.VPN.Provider.Name == providers.HideMyAss {
 		warnings = append(warnings, "HideMyAss dropped support for Linux OpenVPN "+
 			" so this will likely not work anymore. See https://github.com/qdm12/gluetun/issues/1498.")
 	}
 
-	if helpers.IsOneOf(*s.VPN.Provider.Name, providers.SlickVPN) &&
+	if helpers.IsOneOf(s.VPN.Provider.Name, providers.SlickVPN) &&
 		s.VPN.Type == vpn.OpenVPN {
-		if s.VPN.OpenVPN.Version == openvpn.Openvpn24 {
+		warnings = append(warnings, "OpenVPN 2.5 and 2.6 use OpenSSL 3 "+
-			warnings = append(warnings, "OpenVPN 2.4 uses OpenSSL 1.1.1 "+
+			"which prohibits the usage of weak security in today's standards. "+
-				"which allows the usage of weak security in today's standards. "+
+			s.VPN.Provider.Name+" uses weak security which is out "+
-				"This can be ok if good security is enforced by the VPN provider. "+
+			"of Gluetun's control so the only workaround is to allow such weaknesses "+
-				"However, "+*s.VPN.Provider.Name+" uses weak security so you should use "+
+			`using the OpenVPN option tls-cipher "DEFAULT:@SECLEVEL=0". `+
-				"OpenVPN 2.5 to enforce good security practices.")
+			"You might want to reach to your provider so they upgrade their certificates. "+
-		} else {
+			"Once this is done, you will have to let the Gluetun maintainers know "+
-			warnings = append(warnings, "OpenVPN 2.5 uses OpenSSL 3 "+
+			"by creating an issue, attaching the new certificate and we will update Gluetun.")
-				"which prohibits the usage of weak security in today's standards. "+
-				*s.VPN.Provider.Name+" uses weak security which is out "+
-				"of Gluetun's control so the only workaround is to allow such weaknesses "+
-				`using the OpenVPN option tls-cipher "DEFAULT:@SECLEVEL=0". `+
-				"You might want to reach to your provider so they upgrade their certificates. "+
-				"Once this is done, you will have to let the Gluetun maintainers know "+
-				"by creating an issue, attaching the new certificate and we will update Gluetun.")
-		}
 	}
 
-	if s.VPN.OpenVPN.Version == openvpn.Openvpn24 {
+	// TODO remove in v4
-		warnings = append(warnings, "OpenVPN 2.4 will be removed in release v3.34.0 (around June 2023). "+
+	if s.DNS.ServerAddress.Unmap().Compare(netip.AddrFrom4([4]byte{127, 0, 0, 1})) != 0 {
-			"Please create an issue if you have a compelling reason to keep it.")
+		warnings = append(warnings, "DNS address is set to "+s.DNS.ServerAddress.String()+
+			" so the DNS over TLS (DoT) server will not be used."+
+			" The default value changed to 127.0.0.1 so it uses the internal DoT serves."+
+			" If the DoT server fails to start, the IPv4 address of the first plaintext DNS server"+
+			" corresponding to the first DoT provider chosen is used.")
 	}
 
 	return warnings
 }
+
+func (s *Settings) Read(r *reader.Reader) (err error) {
+	readFunctions := map[string]func(r *reader.Reader) error{
+		"control server": s.ControlServer.read,
+		"DNS":            s.DNS.read,
+		"firewall":       s.Firewall.read,
+		"health":         s.Health.Read,
+		"http proxy":     s.HTTPProxy.read,
+		"log":            s.Log.read,
+		"public ip":      s.PublicIP.read,
+		"shadowsocks":    s.Shadowsocks.read,
+		"system":         s.System.read,
+		"updater":        s.Updater.read,
+		"version":        s.Version.read,
+		"VPN":            s.VPN.read,
+		"profiling":      s.Pprof.Read,
+	}
+
+	for name, read := range readFunctions {
+		err = read(r)
+		if err != nil {
+			return fmt.Errorf("reading %s settings: %w", name, err)
+		}
+	}
+
+	return nil
+}

internal/configuration/settings/settings_test.go

@@ -30,7 +30,7 @@ func Test_Settings_String(t *testing.T) {
 |   |           ├── Protocol: UDP
 |   |           └── Private Internet Access encryption preset: strong
 |   └── OpenVPN settings:
-|       ├── OpenVPN version: 2.5
+|       ├── OpenVPN version: 2.6
 |       ├── User: [not set]
 |       ├── Password: [not set]
 |       ├── Private Internet Access encryption preset: strong
@@ -38,8 +38,8 @@ func Test_Settings_String(t *testing.T) {
 |       ├── Run OpenVPN as: root
 |       └── Verbosity level: 1
 ├── DNS settings:
-|   ├── DNS server address to use: 127.0.0.1
 |   ├── Keep existing nameserver(s): no
+|   ├── DNS server address to use: 127.0.0.1
 |   └── DNS over TLS settings:
 |       ├── Enabled: yes
 |       ├── Update period: every 24h0m0s
@@ -84,7 +84,8 @@ func Test_Settings_String(t *testing.T) {
 |   └── Process GID: 1000
 ├── Public IP settings:
 |   ├── Fetching: every 12h0m0s
-|   └── IP file path: /tmp/gluetun/ip
+|   ├── IP file path: /tmp/gluetun/ip
+|   └── Public IP data API: ipinfo
 └── Version settings:
     └── Enabled: yes`,
 		},

internal/configuration/settings/shadowsocks.go

@@ -1,7 +1,10 @@
 package settings
 
 import (
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"fmt"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 	"github.com/qdm12/ss-server/pkg/tcpudp"
 )
@@ -21,28 +24,21 @@ func (s Shadowsocks) validate() (err error) {
 
 func (s *Shadowsocks) copy() (copied Shadowsocks) {
 	return Shadowsocks{
-		Enabled:  helpers.CopyPointer(s.Enabled),
+		Enabled:  gosettings.CopyPointer(s.Enabled),
 		Settings: s.Settings.Copy(),
 	}
 }
 
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (s *Shadowsocks) mergeWith(other Shadowsocks) {
-	s.Enabled = helpers.MergeWithPointer(s.Enabled, other.Enabled)
-	s.Settings.MergeWith(other.Settings)
-}
-
 // overrideWith overrides fields of the receiver
 // settings object with any field set in the other
 // settings.
 func (s *Shadowsocks) overrideWith(other Shadowsocks) {
-	s.Enabled = helpers.OverrideWithPointer(s.Enabled, other.Enabled)
+	s.Enabled = gosettings.OverrideWithPointer(s.Enabled, other.Enabled)
 	s.Settings.OverrideWith(other.Settings)
 }
 
 func (s *Shadowsocks) setDefaults() {
-	s.Enabled = helpers.DefaultPointer(s.Enabled, false)
+	s.Enabled = gosettings.DefaultPointer(s.Enabled, false)
 	s.Settings.SetDefaults()
 }
 
@@ -53,16 +49,50 @@ func (s Shadowsocks) String() string {
 func (s Shadowsocks) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("Shadowsocks server settings:")
 
-	node.Appendf("Enabled: %s", helpers.BoolPtrToYesNo(s.Enabled))
+	node.Appendf("Enabled: %s", gosettings.BoolToYesNo(s.Enabled))
 	if !*s.Enabled {
 		return node
 	}
 
 	// TODO have ToLinesNode in qdm12/ss-server
-	node.Appendf("Listening address: %s", s.Address)
+	node.Appendf("Listening address: %s", *s.Settings.Address)
-	node.Appendf("Cipher: %s", s.CipherName)
+	node.Appendf("Cipher: %s", s.Settings.CipherName)
-	node.Appendf("Password: %s", helpers.ObfuscatePassword(*s.Password))
+	node.Appendf("Password: %s", gosettings.ObfuscateKey(*s.Settings.Password))
-	node.Appendf("Log addresses: %s", helpers.BoolPtrToYesNo(s.LogAddresses))
+	node.Appendf("Log addresses: %s", gosettings.BoolToYesNo(s.Settings.LogAddresses))
 
 	return node
 }
+
+func (s *Shadowsocks) read(r *reader.Reader) (err error) {
+	s.Enabled, err = r.BoolPtr("SHADOWSOCKS")
+	if err != nil {
+		return err
+	}
+
+	s.Settings.Address, err = readShadowsocksAddress(r)
+	if err != nil {
+		return err
+	}
+	s.Settings.LogAddresses, err = r.BoolPtr("SHADOWSOCKS_LOG")
+	if err != nil {
+		return err
+	}
+	s.Settings.CipherName = r.String("SHADOWSOCKS_CIPHER",
+		reader.RetroKeys("SHADOWSOCKS_METHOD"))
+	s.Settings.Password = r.Get("SHADOWSOCKS_PASSWORD",
+		reader.ForceLowercase(false))
+
+	return nil
+}
+
+func readShadowsocksAddress(r *reader.Reader) (address *string, err error) {
+	const currentKey = "SHADOWSOCKS_LISTENING_ADDRESS"
+	port, err := r.Uint16Ptr("SHADOWSOCKS_PORT", reader.IsRetro(currentKey)) // retro-compatibility
+	if err != nil {
+		return nil, err
+	} else if port != nil {
+		return ptrTo(fmt.Sprintf(":%d", *port)), nil
+	}
+
+	return r.Get(currentKey), nil
+}

internal/configuration/settings/system.go

@@ -1,7 +1,8 @@
 package settings
 
 import (
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 )
 
@@ -19,28 +20,22 @@ func (s System) validate() (err error) {
 
 func (s *System) copy() (copied System) {
 	return System{
-		PUID:     helpers.CopyPointer(s.PUID),
+		PUID:     gosettings.CopyPointer(s.PUID),
-		PGID:     helpers.CopyPointer(s.PGID),
+		PGID:     gosettings.CopyPointer(s.PGID),
 		Timezone: s.Timezone,
 	}
 }
 
-func (s *System) mergeWith(other System) {
-	s.PUID = helpers.MergeWithPointer(s.PUID, other.PUID)
-	s.PGID = helpers.MergeWithPointer(s.PGID, other.PGID)
-	s.Timezone = helpers.MergeWithString(s.Timezone, other.Timezone)
-}
-
 func (s *System) overrideWith(other System) {
-	s.PUID = helpers.OverrideWithPointer(s.PUID, other.PUID)
+	s.PUID = gosettings.OverrideWithPointer(s.PUID, other.PUID)
-	s.PGID = helpers.OverrideWithPointer(s.PGID, other.PGID)
+	s.PGID = gosettings.OverrideWithPointer(s.PGID, other.PGID)
-	s.Timezone = helpers.OverrideWithString(s.Timezone, other.Timezone)
+	s.Timezone = gosettings.OverrideWithComparable(s.Timezone, other.Timezone)
 }
 
 func (s *System) setDefaults() {
 	const defaultID = 1000
-	s.PUID = helpers.DefaultPointer(s.PUID, defaultID)
+	s.PUID = gosettings.DefaultPointer(s.PUID, defaultID)
-	s.PGID = helpers.DefaultPointer(s.PGID, defaultID)
+	s.PGID = gosettings.DefaultPointer(s.PGID, defaultID)
 }
 
 func (s System) String() string {
@@ -59,3 +54,18 @@ func (s System) toLinesNode() (node *gotree.Node) {
 
 	return node
 }
+
+func (s *System) read(r *reader.Reader) (err error) {
+	s.PUID, err = r.Uint32Ptr("PUID", reader.RetroKeys("UID"))
+	if err != nil {
+		return err
+	}
+
+	s.PGID, err = r.Uint32Ptr("PGID", reader.RetroKeys("GID"))
+	if err != nil {
+		return err
+	}
+
+	s.Timezone = r.String("TZ")
+	return nil
+}

internal/configuration/settings/unbound.go

@@ -7,20 +7,21 @@ import (
 
 	"github.com/qdm12/dns/pkg/provider"
 	"github.com/qdm12/dns/pkg/unbound"
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 )
 
 // Unbound is settings for the Unbound program.
 type Unbound struct {
-	Providers             []string
+	Providers             []string       `json:"providers"`
-	Caching               *bool
+	Caching               *bool          `json:"caching"`
-	IPv6                  *bool
+	IPv6                  *bool          `json:"ipv6"`
-	VerbosityLevel        *uint8
+	VerbosityLevel        *uint8         `json:"verbosity_level"`
-	VerbosityDetailsLevel *uint8
+	VerbosityDetailsLevel *uint8         `json:"verbosity_details_level"`
-	ValidationLogLevel    *uint8
+	ValidationLogLevel    *uint8         `json:"validation_log_level"`
-	Username              string
+	Username              string         `json:"username"`
-	Allowed               []netip.Prefix
+	Allowed               []netip.Prefix `json:"allowed"`
 }
 
 func (u *Unbound) setDefaults() {
@@ -30,17 +31,17 @@ func (u *Unbound) setDefaults() {
 		}
 	}
 
-	u.Caching = helpers.DefaultPointer(u.Caching, true)
+	u.Caching = gosettings.DefaultPointer(u.Caching, true)
-	u.IPv6 = helpers.DefaultPointer(u.IPv6, false)
+	u.IPv6 = gosettings.DefaultPointer(u.IPv6, false)
 
 	const defaultVerbosityLevel = 1
-	u.VerbosityLevel = helpers.DefaultPointer(u.VerbosityLevel, defaultVerbosityLevel)
+	u.VerbosityLevel = gosettings.DefaultPointer(u.VerbosityLevel, defaultVerbosityLevel)
 
 	const defaultVerbosityDetailsLevel = 0
-	u.VerbosityDetailsLevel = helpers.DefaultPointer(u.VerbosityDetailsLevel, defaultVerbosityDetailsLevel)
+	u.VerbosityDetailsLevel = gosettings.DefaultPointer(u.VerbosityDetailsLevel, defaultVerbosityDetailsLevel)
 
 	const defaultValidationLogLevel = 0
-	u.ValidationLogLevel = helpers.DefaultPointer(u.ValidationLogLevel, defaultValidationLogLevel)
+	u.ValidationLogLevel = gosettings.DefaultPointer(u.ValidationLogLevel, defaultValidationLogLevel)
 
 	if u.Allowed == nil {
 		u.Allowed = []netip.Prefix{
@@ -49,7 +50,7 @@ func (u *Unbound) setDefaults() {
 		}
 	}
 
-	u.Username = helpers.DefaultString(u.Username, "root")
+	u.Username = gosettings.DefaultComparable(u.Username, "root")
 }
 
 var (
@@ -94,37 +95,26 @@ func (u Unbound) validate() (err error) {
 
 func (u Unbound) copy() (copied Unbound) {
 	return Unbound{
-		Providers:             helpers.CopySlice(u.Providers),
+		Providers:             gosettings.CopySlice(u.Providers),
-		Caching:               helpers.CopyPointer(u.Caching),
+		Caching:               gosettings.CopyPointer(u.Caching),
-		IPv6:                  helpers.CopyPointer(u.IPv6),
+		IPv6:                  gosettings.CopyPointer(u.IPv6),
-		VerbosityLevel:        helpers.CopyPointer(u.VerbosityLevel),
+		VerbosityLevel:        gosettings.CopyPointer(u.VerbosityLevel),
-		VerbosityDetailsLevel: helpers.CopyPointer(u.VerbosityDetailsLevel),
+		VerbosityDetailsLevel: gosettings.CopyPointer(u.VerbosityDetailsLevel),
-		ValidationLogLevel:    helpers.CopyPointer(u.ValidationLogLevel),
+		ValidationLogLevel:    gosettings.CopyPointer(u.ValidationLogLevel),
 		Username:              u.Username,
-		Allowed:               helpers.CopySlice(u.Allowed),
+		Allowed:               gosettings.CopySlice(u.Allowed),
 	}
 }
 
-func (u *Unbound) mergeWith(other Unbound) {
-	u.Providers = helpers.MergeSlices(u.Providers, other.Providers)
-	u.Caching = helpers.MergeWithPointer(u.Caching, other.Caching)
-	u.IPv6 = helpers.MergeWithPointer(u.IPv6, other.IPv6)
-	u.VerbosityLevel = helpers.MergeWithPointer(u.VerbosityLevel, other.VerbosityLevel)
-	u.VerbosityDetailsLevel = helpers.MergeWithPointer(u.VerbosityDetailsLevel, other.VerbosityDetailsLevel)
-	u.ValidationLogLevel = helpers.MergeWithPointer(u.ValidationLogLevel, other.ValidationLogLevel)
-	u.Username = helpers.MergeWithString(u.Username, other.Username)
-	u.Allowed = helpers.MergeSlices(u.Allowed, other.Allowed)
-}
-
 func (u *Unbound) overrideWith(other Unbound) {
-	u.Providers = helpers.OverrideWithSlice(u.Providers, other.Providers)
+	u.Providers = gosettings.OverrideWithSlice(u.Providers, other.Providers)
-	u.Caching = helpers.OverrideWithPointer(u.Caching, other.Caching)
+	u.Caching = gosettings.OverrideWithPointer(u.Caching, other.Caching)
-	u.IPv6 = helpers.OverrideWithPointer(u.IPv6, other.IPv6)
+	u.IPv6 = gosettings.OverrideWithPointer(u.IPv6, other.IPv6)
-	u.VerbosityLevel = helpers.OverrideWithPointer(u.VerbosityLevel, other.VerbosityLevel)
+	u.VerbosityLevel = gosettings.OverrideWithPointer(u.VerbosityLevel, other.VerbosityLevel)
-	u.VerbosityDetailsLevel = helpers.OverrideWithPointer(u.VerbosityDetailsLevel, other.VerbosityDetailsLevel)
+	u.VerbosityDetailsLevel = gosettings.OverrideWithPointer(u.VerbosityDetailsLevel, other.VerbosityDetailsLevel)
-	u.ValidationLogLevel = helpers.OverrideWithPointer(u.ValidationLogLevel, other.ValidationLogLevel)
+	u.ValidationLogLevel = gosettings.OverrideWithPointer(u.ValidationLogLevel, other.ValidationLogLevel)
-	u.Username = helpers.OverrideWithString(u.Username, other.Username)
+	u.Username = gosettings.OverrideWithComparable(u.Username, other.Username)
-	u.Allowed = helpers.OverrideWithSlice(u.Allowed, other.Allowed)
+	u.Allowed = gosettings.OverrideWithSlice(u.Allowed, other.Allowed)
 }
 
 func (u Unbound) ToUnboundFormat() (settings unbound.Settings, err error) {
@@ -186,8 +176,8 @@ func (u Unbound) toLinesNode() (node *gotree.Node) {
 		authServers.Appendf(provider)
 	}
 
-	node.Appendf("Caching: %s", helpers.BoolPtrToYesNo(u.Caching))
+	node.Appendf("Caching: %s", gosettings.BoolToYesNo(u.Caching))
-	node.Appendf("IPv6: %s", helpers.BoolPtrToYesNo(u.IPv6))
+	node.Appendf("IPv6: %s", gosettings.BoolToYesNo(u.IPv6))
 	node.Appendf("Verbosity level: %d", *u.VerbosityLevel)
 	node.Appendf("Verbosity details level: %d", *u.VerbosityDetailsLevel)
 	node.Appendf("Validation log level: %d", *u.ValidationLogLevel)
@@ -200,3 +190,34 @@ func (u Unbound) toLinesNode() (node *gotree.Node) {
 
 	return node
 }
+
+func (u *Unbound) read(reader *reader.Reader) (err error) {
+	u.Providers = reader.CSV("DOT_PROVIDERS")
+
+	u.Caching, err = reader.BoolPtr("DOT_CACHING")
+	if err != nil {
+		return err
+	}
+
+	u.IPv6, err = reader.BoolPtr("DOT_IPV6")
+	if err != nil {
+		return err
+	}
+
+	u.VerbosityLevel, err = reader.Uint8Ptr("DOT_VERBOSITY")
+	if err != nil {
+		return err
+	}
+
+	u.VerbosityDetailsLevel, err = reader.Uint8Ptr("DOT_VERBOSITY_DETAILS")
+	if err != nil {
+		return err
+	}
+
+	u.ValidationLogLevel, err = reader.Uint8Ptr("DOT_VALIDATION_LOGLEVEL")
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/configuration/settings/unbound_test.go

@@ -29,9 +29,9 @@ func Test_Unbound_JSON(t *testing.T) {
 	b, err := json.Marshal(settings)
 	require.NoError(t, err)
 
-	const expected = `{"Providers":["cloudflare"],"Caching":true,"IPv6":false,` +
+	const expected = `{"providers":["cloudflare"],"caching":true,"ipv6":false,` +
-		`"VerbosityLevel":1,"VerbosityDetailsLevel":null,"ValidationLogLevel":0,` +
+		`"verbosity_level":1,"verbosity_details_level":null,"validation_log_level":0,` +
-		`"Username":"user","Allowed":["0.0.0.0/0","::/0"]}`
+		`"username":"user","allowed":["0.0.0.0/0","::/0"]}`
 
 	assert.Equal(t, expected, string(b))
 

internal/configuration/settings/updater.go

@@ -5,8 +5,10 @@ import (
 	"strings"
 	"time"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
 	"github.com/qdm12/gluetun/internal/constants/providers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
 	"github.com/qdm12/gotree"
 )
 
@@ -45,16 +47,9 @@ func (u Updater) Validate() (err error) {
 
 	validProviders := providers.All()
 	for _, provider := range u.Providers {
-		valid := false
+		err = validate.IsOneOf(provider, validProviders...)
-		for _, validProvider := range validProviders {
+		if err != nil {
-			if provider == validProvider {
+			return fmt.Errorf("%w: %w", ErrVPNProviderNameNotValid, err)
-				valid = true
-				break
-			}
-		}
-		if !valid {
-			return fmt.Errorf("%w: %q can only be one of %s",
-				ErrVPNProviderNameNotValid, provider, helpers.ChoicesOrString(validProviders))
 		}
 	}
 
@@ -63,35 +58,26 @@ func (u Updater) Validate() (err error) {
 
 func (u *Updater) copy() (copied Updater) {
 	return Updater{
-		Period:     helpers.CopyPointer(u.Period),
+		Period:     gosettings.CopyPointer(u.Period),
 		DNSAddress: u.DNSAddress,
 		MinRatio:   u.MinRatio,
-		Providers:  helpers.CopySlice(u.Providers),
+		Providers:  gosettings.CopySlice(u.Providers),
 	}
 }
 
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (u *Updater) mergeWith(other Updater) {
-	u.Period = helpers.MergeWithPointer(u.Period, other.Period)
-	u.DNSAddress = helpers.MergeWithString(u.DNSAddress, other.DNSAddress)
-	u.MinRatio = helpers.MergeWithNumber(u.MinRatio, other.MinRatio)
-	u.Providers = helpers.MergeSlices(u.Providers, other.Providers)
-}
-
 // overrideWith overrides fields of the receiver
 // settings object with any field set in the other
 // settings.
 func (u *Updater) overrideWith(other Updater) {
-	u.Period = helpers.OverrideWithPointer(u.Period, other.Period)
+	u.Period = gosettings.OverrideWithPointer(u.Period, other.Period)
-	u.DNSAddress = helpers.OverrideWithString(u.DNSAddress, other.DNSAddress)
+	u.DNSAddress = gosettings.OverrideWithComparable(u.DNSAddress, other.DNSAddress)
-	u.MinRatio = helpers.OverrideWithNumber(u.MinRatio, other.MinRatio)
+	u.MinRatio = gosettings.OverrideWithComparable(u.MinRatio, other.MinRatio)
-	u.Providers = helpers.OverrideWithSlice(u.Providers, other.Providers)
+	u.Providers = gosettings.OverrideWithSlice(u.Providers, other.Providers)
 }
 
 func (u *Updater) SetDefaults(vpnProvider string) {
-	u.Period = helpers.DefaultPointer(u.Period, 0)
+	u.Period = gosettings.DefaultPointer(u.Period, 0)
-	u.DNSAddress = helpers.DefaultString(u.DNSAddress, "1.1.1.1:53")
+	u.DNSAddress = gosettings.DefaultComparable(u.DNSAddress, "1.1.1.1:53")
 
 	if u.MinRatio == 0 {
 		const defaultMinRatio = 0.8
@@ -120,3 +106,33 @@ func (u Updater) toLinesNode() (node *gotree.Node) {
 
 	return node
 }
+
+func (u *Updater) read(r *reader.Reader) (err error) {
+	u.Period, err = r.DurationPtr("UPDATER_PERIOD")
+	if err != nil {
+		return err
+	}
+
+	u.DNSAddress, err = readUpdaterDNSAddress()
+	if err != nil {
+		return err
+	}
+
+	u.MinRatio, err = r.Float64("UPDATER_MIN_RATIO")
+	if err != nil {
+		return err
+	}
+
+	u.Providers = r.CSV("UPDATER_VPN_SERVICE_PROVIDERS")
+
+	return nil
+}
+
+func readUpdaterDNSAddress() (address string, err error) {
+	// TODO this is currently using Cloudflare in
+	// plaintext to not be blocked by DNS over TLS by default.
+	// If a plaintext address is set in the DNS settings, this one will be used.
+	// use custom future encrypted DNS written in Go without blocking
+	// as it's too much trouble to start another parallel unbound instance for now.
+	return "", nil
+}

internal/configuration/settings/validation/servers.go

@@ -33,6 +33,28 @@ func ExtractCountries(servers []models.Server) (values []string) {
 	return values
 }
 
+func ExtractCategories(servers []models.Server) (values []string) {
+	seen := make(map[string]struct{}, len(servers))
+	values = make([]string, 0, len(servers))
+	for _, server := range servers {
+		categories := server.Categories
+		if len(categories) == 0 {
+			continue
+		}
+
+		for _, value := range categories {
+			_, alreadySeen := seen[value]
+			if alreadySeen {
+				continue
+			}
+			seen[value] = struct{}{}
+
+			values = sortedInsert(values, value)
+		}
+	}
+	return values
+}
+
 func ExtractRegions(servers []models.Server) (values []string) {
 	seen := make(map[string]struct{}, len(servers))
 	values = make([]string, 0, len(servers))

internal/configuration/settings/validation/surfshark.go

@@ -10,6 +10,9 @@ func SurfsharkRetroLocChoices() (choices []string) {
 	choices = make([]string, 0, len(locationData))
 	seen := make(map[string]struct{}, len(locationData))
 	for _, data := range locationData {
+		if data.RetroLoc == "" {
+			continue
+		}
 		if _, ok := seen[data.RetroLoc]; ok {
 			continue
 		}

internal/configuration/settings/version.go

@@ -1,7 +1,8 @@
 package settings
 
 import (
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
 	"github.com/qdm12/gotree"
 )
 
@@ -19,25 +20,19 @@ func (v Version) validate() (err error) {
 
 func (v *Version) copy() (copied Version) {
 	return Version{
-		Enabled: helpers.CopyPointer(v.Enabled),
+		Enabled: gosettings.CopyPointer(v.Enabled),
 	}
 }
 
-// mergeWith merges the other settings into any
-// unset field of the receiver settings object.
-func (v *Version) mergeWith(other Version) {
-	v.Enabled = helpers.MergeWithPointer(v.Enabled, other.Enabled)
-}
-
 // overrideWith overrides fields of the receiver
 // settings object with any field set in the other
 // settings.
 func (v *Version) overrideWith(other Version) {
-	v.Enabled = helpers.OverrideWithPointer(v.Enabled, other.Enabled)
+	v.Enabled = gosettings.OverrideWithPointer(v.Enabled, other.Enabled)
 }
 
 func (v *Version) setDefaults() {
-	v.Enabled = helpers.DefaultPointer(v.Enabled, true)
+	v.Enabled = gosettings.DefaultPointer(v.Enabled, true)
 }
 
 func (v Version) String() string {
@@ -47,7 +42,16 @@ func (v Version) String() string {
 func (v Version) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("Version settings:")
 
-	node.Appendf("Enabled: %s", helpers.BoolPtrToYesNo(v.Enabled))
+	node.Appendf("Enabled: %s", gosettings.BoolToYesNo(v.Enabled))
 
 	return node
 }
+
+func (v *Version) read(r *reader.Reader) (err error) {
+	v.Enabled, err = r.BoolPtr("VERSION_INFORMATION")
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/configuration/settings/vpn.go

@@ -2,10 +2,11 @@ package settings
 
 import (
 	"fmt"
-	"strings"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
 	"github.com/qdm12/gluetun/internal/constants/vpn"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
 	"github.com/qdm12/gotree"
 )
 
@@ -13,19 +14,18 @@ type VPN struct {
 	// Type is the VPN type and can only be
 	// 'openvpn' or 'wireguard'. It cannot be the
 	// empty string in the internal state.
-	Type      string
+	Type      string    `json:"type"`
-	Provider  Provider
+	Provider  Provider  `json:"provider"`
-	OpenVPN   OpenVPN
+	OpenVPN   OpenVPN   `json:"openvpn"`
-	Wireguard Wireguard
+	Wireguard Wireguard `json:"wireguard"`
 }
 
 // TODO v4 remove pointer for receiver (because of Surfshark).
 func (v *VPN) Validate(storage Storage, ipv6Supported bool) (err error) {
 	// Validate Type
 	validVPNTypes := []string{vpn.OpenVPN, vpn.Wireguard}
-	if !helpers.IsOneOf(v.Type, validVPNTypes...) {
+	if err = validate.IsOneOf(v.Type, validVPNTypes...); err != nil {
-		return fmt.Errorf("%w: %q and can only be one of %s",
+		return fmt.Errorf("%w: %w", ErrVPNTypeNotValid, err)
-			ErrVPNTypeNotValid, v.Type, strings.Join(validVPNTypes, ", "))
 	}
 
 	err = v.Provider.validate(v.Type, storage)
@@ -34,12 +34,12 @@ func (v *VPN) Validate(storage Storage, ipv6Supported bool) (err error) {
 	}
 
 	if v.Type == vpn.OpenVPN {
-		err := v.OpenVPN.validate(*v.Provider.Name)
+		err := v.OpenVPN.validate(v.Provider.Name)
 		if err != nil {
 			return fmt.Errorf("OpenVPN settings: %w", err)
 		}
 	} else {
-		err := v.Wireguard.validate(*v.Provider.Name, ipv6Supported)
+		err := v.Wireguard.validate(v.Provider.Name, ipv6Supported)
 		if err != nil {
 			return fmt.Errorf("Wireguard settings: %w", err)
 		}
@@ -57,25 +57,18 @@ func (v *VPN) Copy() (copied VPN) {
 	}
 }
 
-func (v *VPN) mergeWith(other VPN) {
-	v.Type = helpers.MergeWithString(v.Type, other.Type)
-	v.Provider.mergeWith(other.Provider)
-	v.OpenVPN.mergeWith(other.OpenVPN)
-	v.Wireguard.mergeWith(other.Wireguard)
-}
-
 func (v *VPN) OverrideWith(other VPN) {
-	v.Type = helpers.OverrideWithString(v.Type, other.Type)
+	v.Type = gosettings.OverrideWithComparable(v.Type, other.Type)
 	v.Provider.overrideWith(other.Provider)
 	v.OpenVPN.overrideWith(other.OpenVPN)
 	v.Wireguard.overrideWith(other.Wireguard)
 }
 
 func (v *VPN) setDefaults() {
-	v.Type = helpers.DefaultString(v.Type, vpn.OpenVPN)
+	v.Type = gosettings.DefaultComparable(v.Type, vpn.OpenVPN)
 	v.Provider.setDefaults()
-	v.OpenVPN.setDefaults(*v.Provider.Name)
+	v.OpenVPN.setDefaults(v.Provider.Name)
-	v.Wireguard.setDefaults()
+	v.Wireguard.setDefaults(v.Provider.Name)
 }
 
 func (v VPN) String() string {
@@ -95,3 +88,24 @@ func (v VPN) toLinesNode() (node *gotree.Node) {
 
 	return node
 }
+
+func (v *VPN) read(r *reader.Reader) (err error) {
+	v.Type = r.String("VPN_TYPE")
+
+	err = v.Provider.read(r, v.Type)
+	if err != nil {
+		return fmt.Errorf("VPN provider: %w", err)
+	}
+
+	err = v.OpenVPN.read(r)
+	if err != nil {
+		return fmt.Errorf("OpenVPN: %w", err)
+	}
+
+	err = v.Wireguard.read(r)
+	if err != nil {
+		return fmt.Errorf("wireguard: %w", err)
+	}
+
+	return nil
+}

internal/configuration/settings/wireguard.go

@@ -4,9 +4,14 @@ import (
 	"fmt"
 	"net/netip"
 	"regexp"
+	"strings"
+	"time"
 
 	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
 	"github.com/qdm12/gluetun/internal/constants/providers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
 	"github.com/qdm12/gotree"
 	"golang.zx2c4.com/wireguard/wgctrl/wgtypes"
 )
@@ -15,23 +20,34 @@ import (
 type Wireguard struct {
 	// PrivateKey is the Wireguard client peer private key.
 	// It cannot be nil in the internal state.
-	PrivateKey *string
+	PrivateKey *string `json:"private_key"`
 	// PreSharedKey is the Wireguard pre-shared key.
 	// It can be the empty string to indicate there
 	// is no pre-shared key.
 	// It cannot be nil in the internal state.
-	PreSharedKey *string
+	PreSharedKey *string `json:"pre_shared_key"`
 	// Addresses are the Wireguard interface addresses.
-	Addresses []netip.Prefix
+	Addresses []netip.Prefix `json:"addresses"`
+	// AllowedIPs are the Wireguard allowed IPs.
+	// If left unset, they default to "0.0.0.0/0"
+	// and, if IPv6 is supported, "::0".
+	AllowedIPs []netip.Prefix `json:"allowed_ips"`
 	// Interface is the name of the Wireguard interface
 	// to create. It cannot be the empty string in the
 	// internal state.
-	Interface string
+	Interface                   string         `json:"interface"`
+	PersistentKeepaliveInterval *time.Duration `json:"persistent_keep_alive_interval"`
+	// Maximum Transmission Unit (MTU) of the Wireguard interface.
+	// It cannot be zero in the internal state, and defaults to
+	// 1400. Note it is not the wireguard-go MTU default of 1420
+	// because this impacts bandwidth a lot on some VPN providers,
+	// see https://github.com/qdm12/gluetun/issues/1650.
+	MTU uint16 `json:"mtu"`
 	// Implementation is the Wireguard implementation to use.
 	// It can be "auto", "userspace" or "kernelspace".
 	// It defaults to "auto" and cannot be the empty string
 	// in the internal state.
-	Implementation string
+	Implementation string `json:"implementation"`
 }
 
 var regexpInterfaceName = regexp.MustCompile(`^[a-zA-Z0-9_]+$`)
@@ -40,9 +56,13 @@ var regexpInterfaceName = regexp.MustCompile(`^[a-zA-Z0-9_]+$`)
 // It should only be ran if the VPN type chosen is Wireguard.
 func (w Wireguard) validate(vpnProvider string, ipv6Supported bool) (err error) {
 	if !helpers.IsOneOf(vpnProvider,
+		providers.Airvpn,
 		providers.Custom,
+		providers.Fastestvpn,
 		providers.Ivpn,
 		providers.Mullvad,
+		providers.Nordvpn,
+		providers.Protonvpn,
 		providers.Surfshark,
 		providers.Windscribe,
 	) {
@@ -56,7 +76,12 @@ func (w Wireguard) validate(vpnProvider string, ipv6Supported bool) (err error)
 	}
 	_, err = wgtypes.ParseKey(*w.PrivateKey)
 	if err != nil {
-		return fmt.Errorf("private key is not valid: %w", err)
+		err = fmt.Errorf("private key is not valid: %w", err)
+		if vpnProvider == providers.Nordvpn &&
+			err.Error() == "wgtypes: incorrect key size: 48" {
+			err = fmt.Errorf("%w - you might be using your access token instead of the Wireguard private key", err)
+		}
+		return err
 	}
 
 	if vpnProvider == providers.Airvpn {
@@ -79,16 +104,34 @@ func (w Wireguard) validate(vpnProvider string, ipv6Supported bool) (err error)
 	}
 	for i, ipNet := range w.Addresses {
 		if !ipNet.IsValid() {
-			return fmt.Errorf("%w: for address at index %d: %s",
+			return fmt.Errorf("%w: for address at index %d",
-				ErrWireguardInterfaceAddressNotSet, i, ipNet.String())
+				ErrWireguardInterfaceAddressNotSet, i)
 		}
 
 		if !ipv6Supported && ipNet.Addr().Is6() {
 			return fmt.Errorf("%w: address %s",
-				ErrWireguardInterfaceAddressIPv6, ipNet)
+				ErrWireguardInterfaceAddressIPv6, ipNet.String())
 		}
 	}
 
+	// Validate AllowedIPs
+	// WARNING: do not check for IPv6 networks in the allowed IPs,
+	// the wireguard code will take care to ignore it.
+	if len(w.AllowedIPs) == 0 {
+		return fmt.Errorf("%w", ErrWireguardAllowedIPsNotSet)
+	}
+	for i, allowedIP := range w.AllowedIPs {
+		if !allowedIP.IsValid() {
+			return fmt.Errorf("%w: for allowed ip %d of %d",
+				ErrWireguardAllowedIPNotSet, i+1, len(w.AllowedIPs))
+		}
+	}
+
+	if *w.PersistentKeepaliveInterval < 0 {
+		return fmt.Errorf("%w: %s", ErrWireguardKeepAliveNegative,
+			*w.PersistentKeepaliveInterval)
+	}
+
 	// Validate interface
 	if !regexpInterfaceName.MatchString(w.Interface) {
 		return fmt.Errorf("%w: '%s' does not match regex '%s'",
@@ -96,9 +139,8 @@ func (w Wireguard) validate(vpnProvider string, ipv6Supported bool) (err error)
 	}
 
 	validImplementations := []string{"auto", "userspace", "kernelspace"}
-	if !helpers.IsOneOf(w.Implementation, validImplementations...) {
+	if err := validate.IsOneOf(w.Implementation, validImplementations...); err != nil {
-		return fmt.Errorf("%w: %s must be one of %s", ErrWireguardImplementationNotValid,
+		return fmt.Errorf("%w: %w", ErrWireguardImplementationNotValid, err)
-			w.Implementation, helpers.ChoicesOrString(validImplementations))
 	}
 
 	return nil
@@ -106,35 +148,52 @@ func (w Wireguard) validate(vpnProvider string, ipv6Supported bool) (err error)
 
 func (w *Wireguard) copy() (copied Wireguard) {
 	return Wireguard{
-		PrivateKey:     helpers.CopyPointer(w.PrivateKey),
+		PrivateKey:                  gosettings.CopyPointer(w.PrivateKey),
-		PreSharedKey:   helpers.CopyPointer(w.PreSharedKey),
+		PreSharedKey:                gosettings.CopyPointer(w.PreSharedKey),
-		Addresses:      helpers.CopySlice(w.Addresses),
+		Addresses:                   gosettings.CopySlice(w.Addresses),
-		Interface:      w.Interface,
+		AllowedIPs:                  gosettings.CopySlice(w.AllowedIPs),
-		Implementation: w.Implementation,
+		PersistentKeepaliveInterval: gosettings.CopyPointer(w.PersistentKeepaliveInterval),
+		Interface:                   w.Interface,
+		MTU:                         w.MTU,
+		Implementation:              w.Implementation,
 	}
 }
 
-func (w *Wireguard) mergeWith(other Wireguard) {
-	w.PrivateKey = helpers.MergeWithPointer(w.PrivateKey, other.PrivateKey)
-	w.PreSharedKey = helpers.MergeWithPointer(w.PreSharedKey, other.PreSharedKey)
-	w.Addresses = helpers.MergeSlices(w.Addresses, other.Addresses)
-	w.Interface = helpers.MergeWithString(w.Interface, other.Interface)
-	w.Implementation = helpers.MergeWithString(w.Implementation, other.Implementation)
-}
-
 func (w *Wireguard) overrideWith(other Wireguard) {
-	w.PrivateKey = helpers.OverrideWithPointer(w.PrivateKey, other.PrivateKey)
+	w.PrivateKey = gosettings.OverrideWithPointer(w.PrivateKey, other.PrivateKey)
-	w.PreSharedKey = helpers.OverrideWithPointer(w.PreSharedKey, other.PreSharedKey)
+	w.PreSharedKey = gosettings.OverrideWithPointer(w.PreSharedKey, other.PreSharedKey)
-	w.Addresses = helpers.OverrideWithSlice(w.Addresses, other.Addresses)
+	w.Addresses = gosettings.OverrideWithSlice(w.Addresses, other.Addresses)
-	w.Interface = helpers.OverrideWithString(w.Interface, other.Interface)
+	w.AllowedIPs = gosettings.OverrideWithSlice(w.AllowedIPs, other.AllowedIPs)
-	w.Implementation = helpers.OverrideWithString(w.Implementation, other.Implementation)
+	w.PersistentKeepaliveInterval = gosettings.OverrideWithPointer(w.PersistentKeepaliveInterval,
+		other.PersistentKeepaliveInterval)
+	w.Interface = gosettings.OverrideWithComparable(w.Interface, other.Interface)
+	w.MTU = gosettings.OverrideWithComparable(w.MTU, other.MTU)
+	w.Implementation = gosettings.OverrideWithComparable(w.Implementation, other.Implementation)
 }
 
-func (w *Wireguard) setDefaults() {
+func (w *Wireguard) setDefaults(vpnProvider string) {
-	w.PrivateKey = helpers.DefaultPointer(w.PrivateKey, "")
+	w.PrivateKey = gosettings.DefaultPointer(w.PrivateKey, "")
-	w.PreSharedKey = helpers.DefaultPointer(w.PreSharedKey, "")
+	w.PreSharedKey = gosettings.DefaultPointer(w.PreSharedKey, "")
-	w.Interface = helpers.DefaultString(w.Interface, "wg0")
+	switch vpnProvider {
-	w.Implementation = helpers.DefaultString(w.Implementation, "auto")
+	case providers.Nordvpn:
+		defaultNordVPNAddress := netip.AddrFrom4([4]byte{10, 5, 0, 2})
+		defaultNordVPNPrefix := netip.PrefixFrom(defaultNordVPNAddress, defaultNordVPNAddress.BitLen())
+		w.Addresses = gosettings.DefaultSlice(w.Addresses, []netip.Prefix{defaultNordVPNPrefix})
+	case providers.Protonvpn:
+		defaultAddress := netip.AddrFrom4([4]byte{10, 2, 0, 2})
+		defaultPrefix := netip.PrefixFrom(defaultAddress, defaultAddress.BitLen())
+		w.Addresses = gosettings.DefaultSlice(w.Addresses, []netip.Prefix{defaultPrefix})
+	}
+	defaultAllowedIPs := []netip.Prefix{
+		netip.PrefixFrom(netip.IPv4Unspecified(), 0),
+		netip.PrefixFrom(netip.IPv6Unspecified(), 0),
+	}
+	w.AllowedIPs = gosettings.DefaultSlice(w.AllowedIPs, defaultAllowedIPs)
+	w.PersistentKeepaliveInterval = gosettings.DefaultPointer(w.PersistentKeepaliveInterval, 0)
+	w.Interface = gosettings.DefaultComparable(w.Interface, "wg0")
+	const defaultMTU = 1400
+	w.MTU = gosettings.DefaultComparable(w.MTU, defaultMTU)
+	w.Implementation = gosettings.DefaultComparable(w.Implementation, "auto")
 }
 
 func (w Wireguard) String() string {
@@ -145,12 +204,12 @@ func (w Wireguard) toLinesNode() (node *gotree.Node) {
 	node = gotree.New("Wireguard settings:")
 
 	if *w.PrivateKey != "" {
-		s := helpers.ObfuscateWireguardKey(*w.PrivateKey)
+		s := gosettings.ObfuscateKey(*w.PrivateKey)
 		node.Appendf("Private key: %s", s)
 	}
 
 	if *w.PreSharedKey != "" {
-		s := helpers.ObfuscateWireguardKey(*w.PreSharedKey)
+		s := gosettings.ObfuscateKey(*w.PreSharedKey)
 		node.Appendf("Pre-shared key: %s", s)
 	}
 
@@ -159,7 +218,17 @@ func (w Wireguard) toLinesNode() (node *gotree.Node) {
 		addressesNode.Appendf(address.String())
 	}
 
-	node.Appendf("Network interface: %s", w.Interface)
+	allowedIPsNode := node.Appendf("Allowed IPs:")
+	for _, allowedIP := range w.AllowedIPs {
+		allowedIPsNode.Appendf(allowedIP.String())
+	}
+
+	if *w.PersistentKeepaliveInterval > 0 {
+		node.Appendf("Persistent keepalive interval: %s", w.PersistentKeepaliveInterval)
+	}
+
+	interfaceNode := node.Appendf("Network interface: %s", w.Interface)
+	interfaceNode.Appendf("MTU: %d", w.MTU)
 
 	if w.Implementation != "auto" {
 		node.Appendf("Implementation: %s", w.Implementation)
@@ -167,3 +236,44 @@ func (w Wireguard) toLinesNode() (node *gotree.Node) {
 
 	return node
 }
+
+func (w *Wireguard) read(r *reader.Reader) (err error) {
+	w.PrivateKey = r.Get("WIREGUARD_PRIVATE_KEY", reader.ForceLowercase(false))
+	w.PreSharedKey = r.Get("WIREGUARD_PRESHARED_KEY", reader.ForceLowercase(false))
+	w.Interface = r.String("VPN_INTERFACE",
+		reader.RetroKeys("WIREGUARD_INTERFACE"), reader.ForceLowercase(false))
+	w.Implementation = r.String("WIREGUARD_IMPLEMENTATION")
+
+	addressStrings := r.CSV("WIREGUARD_ADDRESSES", reader.RetroKeys("WIREGUARD_ADDRESS"))
+	// WARNING: do not initialize w.Addresses to an empty slice
+	// or the defaults for nordvpn will not work.
+	for _, addressString := range addressStrings {
+		if !strings.ContainsRune(addressString, '/') {
+			addressString += "/32"
+		}
+		addressString = strings.TrimSpace(addressString)
+		address, err := netip.ParsePrefix(addressString)
+		if err != nil {
+			return fmt.Errorf("parsing address: %w", err)
+		}
+		w.Addresses = append(w.Addresses, address)
+	}
+
+	w.AllowedIPs, err = r.CSVNetipPrefixes("WIREGUARD_ALLOWED_IPS")
+	if err != nil {
+		return err // already wrapped
+	}
+
+	w.PersistentKeepaliveInterval, err = r.DurationPtr("WIREGUARD_PERSISTENT_KEEPALIVE_INTERVAL")
+	if err != nil {
+		return err
+	}
+
+	mtuPtr, err := r.Uint16Ptr("WIREGUARD_MTU")
+	if err != nil {
+		return err
+	} else if mtuPtr != nil {
+		w.MTU = *mtuPtr
+	}
+	return nil
+}

internal/configuration/settings/wireguardselection.go

@@ -4,8 +4,10 @@ import (
 	"fmt"
 	"net/netip"
 
-	"github.com/qdm12/gluetun/internal/configuration/settings/helpers"
 	"github.com/qdm12/gluetun/internal/constants/providers"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
 	"github.com/qdm12/gotree"
 	"golang.zx2c4.com/wireguard/wgctrl/wgtypes"
 )
@@ -15,20 +17,20 @@ type WireguardSelection struct {
 	// It is only used with VPN providers generating Wireguard
 	// configurations specific to each server and user.
 	// To indicate it should not be used, it should be set
-	// to netaddr.IPv4Unspecified(). It can never be the zero value
+	// to netip.IPv4Unspecified(). It can never be the zero value
 	// in the internal state.
-	EndpointIP netip.Addr
+	EndpointIP netip.Addr `json:"endpoint_ip"`
 	// EndpointPort is a the server port to use for the VPN server.
 	// It is optional for VPN providers IVPN, Mullvad, Surfshark
 	// and Windscribe, and compulsory for the others.
 	// When optional, it can be set to 0 to indicate not use
 	// a custom endpoint port. It cannot be nil in the internal
 	// state.
-	EndpointPort *uint16
+	EndpointPort *uint16 `json:"endpoint_port"`
 	// PublicKey is the server public key.
 	// It is only used with VPN providers generating Wireguard
 	// configurations specific to each server and user.
-	PublicKey string
+	PublicKey string `json:"public_key"`
 }
 
 // Validate validates WireguardSelection settings.
@@ -36,7 +38,8 @@ type WireguardSelection struct {
 func (w WireguardSelection) validate(vpnProvider string) (err error) {
 	// Validate EndpointIP
 	switch vpnProvider {
-	case providers.Airvpn, providers.Ivpn, providers.Mullvad,
+	case providers.Airvpn, providers.Fastestvpn, providers.Ivpn,
+		providers.Mullvad, providers.Nordvpn, providers.Protonvpn,
 		providers.Surfshark, providers.Windscribe:
 		// endpoint IP addresses are baked in
 	case providers.Custom:
@@ -54,7 +57,8 @@ func (w WireguardSelection) validate(vpnProvider string) (err error) {
 			return fmt.Errorf("%w", ErrWireguardEndpointPortNotSet)
 		}
 	// EndpointPort cannot be set
-	case providers.Surfshark:
+	case providers.Fastestvpn, providers.Nordvpn,
+		providers.Protonvpn, providers.Surfshark:
 		if *w.EndpointPort != 0 {
 			return fmt.Errorf("%w", ErrWireguardEndpointPortSet)
 		}
@@ -76,18 +80,18 @@ func (w WireguardSelection) validate(vpnProvider string) (err error) {
 			allowed = []uint16{53, 80, 123, 443, 1194, 65142}
 		}
 
-		if helpers.Uint16IsOneOf(*w.EndpointPort, allowed) {
+		err = validate.IsOneOf(*w.EndpointPort, allowed...)
+		if err == nil {
 			break
 		}
-		return fmt.Errorf("%w: %d for VPN service provider %s; %s",
+		return fmt.Errorf("%w: for VPN service provider %s: %w",
-			ErrWireguardEndpointPortNotAllowed, w.EndpointPort, vpnProvider,
+			ErrWireguardEndpointPortNotAllowed, vpnProvider, err)
-			helpers.PortChoicesOrString(allowed))
 	default: // Providers not supporting Wireguard
 	}
 
 	// Validate PublicKey
 	switch vpnProvider {
-	case providers.Ivpn, providers.Mullvad,
+	case providers.Fastestvpn, providers.Ivpn, providers.Mullvad,
 		providers.Surfshark, providers.Windscribe:
 		// public keys are baked in
 	case providers.Custom:
@@ -110,26 +114,20 @@ func (w WireguardSelection) validate(vpnProvider string) (err error) {
 func (w *WireguardSelection) copy() (copied WireguardSelection) {
 	return WireguardSelection{
 		EndpointIP:   w.EndpointIP,
-		EndpointPort: helpers.CopyPointer(w.EndpointPort),
+		EndpointPort: gosettings.CopyPointer(w.EndpointPort),
 		PublicKey:    w.PublicKey,
 	}
 }
 
-func (w *WireguardSelection) mergeWith(other WireguardSelection) {
-	w.EndpointIP = helpers.MergeWithIP(w.EndpointIP, other.EndpointIP)
-	w.EndpointPort = helpers.MergeWithPointer(w.EndpointPort, other.EndpointPort)
-	w.PublicKey = helpers.MergeWithString(w.PublicKey, other.PublicKey)
-}
-
 func (w *WireguardSelection) overrideWith(other WireguardSelection) {
-	w.EndpointIP = helpers.OverrideWithIP(w.EndpointIP, other.EndpointIP)
+	w.EndpointIP = gosettings.OverrideWithValidator(w.EndpointIP, other.EndpointIP)
-	w.EndpointPort = helpers.OverrideWithPointer(w.EndpointPort, other.EndpointPort)
+	w.EndpointPort = gosettings.OverrideWithPointer(w.EndpointPort, other.EndpointPort)
-	w.PublicKey = helpers.OverrideWithString(w.PublicKey, other.PublicKey)
+	w.PublicKey = gosettings.OverrideWithComparable(w.PublicKey, other.PublicKey)
 }
 
 func (w *WireguardSelection) setDefaults() {
-	w.EndpointIP = helpers.DefaultIP(w.EndpointIP, netip.IPv4Unspecified())
+	w.EndpointIP = gosettings.DefaultValidator(w.EndpointIP, netip.IPv4Unspecified())
-	w.EndpointPort = helpers.DefaultPointer(w.EndpointPort, 0)
+	w.EndpointPort = gosettings.DefaultPointer(w.EndpointPort, 0)
 }
 
 func (w WireguardSelection) String() string {
@@ -153,3 +151,18 @@ func (w WireguardSelection) toLinesNode() (node *gotree.Node) {
 
 	return node
 }
+
+func (w *WireguardSelection) read(r *reader.Reader) (err error) {
+	w.EndpointIP, err = r.NetipAddr("WIREGUARD_ENDPOINT_IP", reader.RetroKeys("VPN_ENDPOINT_IP"))
+	if err != nil {
+		return err
+	}
+
+	w.EndpointPort, err = r.Uint16Ptr("WIREGUARD_ENDPOINT_PORT", reader.RetroKeys("VPN_ENDPOINT_PORT"))
+	if err != nil {
+		return err
+	}
+
+	w.PublicKey = r.String("WIREGUARD_PUBLIC_KEY", reader.ForceLowercase(false))
+	return nil
+}

internal/configuration/sources/env/dns.go

@@ -1,50 +0,0 @@
-package env
-
-import (
-	"fmt"
-	"net/netip"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-func (s *Source) readDNS() (dns settings.DNS, err error) {
-	dns.ServerAddress, err = s.readDNSServerAddress()
-	if err != nil {
-		return dns, err
-	}
-
-	dns.KeepNameserver, err = envToBoolPtr("DNS_KEEP_NAMESERVER")
-	if err != nil {
-		return dns, fmt.Errorf("environment variable DNS_KEEP_NAMESERVER: %w", err)
-	}
-
-	dns.DoT, err = s.readDoT()
-	if err != nil {
-		return dns, fmt.Errorf("DoT settings: %w", err)
-	}
-
-	return dns, nil
-}
-
-func (s *Source) readDNSServerAddress() (address netip.Addr, err error) {
-	key, value := s.getEnvWithRetro("DNS_ADDRESS", "DNS_PLAINTEXT_ADDRESS")
-	if value == "" {
-		return address, nil
-	}
-
-	address, err = netip.ParseAddr(value)
-	if err != nil {
-		return address, fmt.Errorf("environment variable %s: %w", key, err)
-	}
-
-	// TODO remove in v4
-	if address.Unmap().Compare(netip.AddrFrom4([4]byte{127, 0, 0, 1})) != 0 {
-		s.warner.Warn(key + " is set to " + value +
-			" so the DNS over TLS (DoT) server will not be used." +
-			" The default value changed to 127.0.0.1 so it uses the internal DoT serves." +
-			" If the DoT server fails to start, the IPv4 address of the first plaintext DNS server" +
-			" corresponding to the first DoT provider chosen is used.")
-	}
-
-	return address, nil
-}

internal/configuration/sources/env/dnsblacklist.go

@@ -1,87 +0,0 @@
-package env
-
-import (
-	"errors"
-	"fmt"
-	"net/netip"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-	"github.com/qdm12/govalid/binary"
-)
-
-func (s *Source) readDNSBlacklist() (blacklist settings.DNSBlacklist, err error) {
-	blacklist.BlockMalicious, err = envToBoolPtr("BLOCK_MALICIOUS")
-	if err != nil {
-		return blacklist, fmt.Errorf("environment variable BLOCK_MALICIOUS: %w", err)
-	}
-
-	blacklist.BlockSurveillance, err = s.readBlockSurveillance()
-	if err != nil {
-		return blacklist, err
-	}
-
-	blacklist.BlockAds, err = envToBoolPtr("BLOCK_ADS")
-	if err != nil {
-		return blacklist, fmt.Errorf("environment variable BLOCK_ADS: %w", err)
-	}
-
-	blacklist.AddBlockedIPs, blacklist.AddBlockedIPPrefixes,
-		err = readDoTPrivateAddresses() // TODO v4 split in 2
-	if err != nil {
-		return blacklist, err
-	}
-
-	blacklist.AllowedHosts = envToCSV("UNBLOCK") // TODO v4 change name
-
-	return blacklist, nil
-}
-
-func (s *Source) readBlockSurveillance() (blocked *bool, err error) {
-	key, value := s.getEnvWithRetro("BLOCK_SURVEILLANCE", "BLOCK_NSA")
-	if value == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	blocked = new(bool)
-	*blocked, err = binary.Validate(value)
-	if err != nil {
-		return nil, fmt.Errorf("environment variable %s: %w", key, err)
-	}
-
-	return blocked, nil
-}
-
-var (
-	ErrPrivateAddressNotValid = errors.New("private address is not a valid IP or CIDR range")
-)
-
-func readDoTPrivateAddresses() (ips []netip.Addr,
-	ipPrefixes []netip.Prefix, err error) {
-	privateAddresses := envToCSV("DOT_PRIVATE_ADDRESS")
-	if len(privateAddresses) == 0 {
-		return nil, nil, nil
-	}
-
-	ips = make([]netip.Addr, 0, len(privateAddresses))
-	ipPrefixes = make([]netip.Prefix, 0, len(privateAddresses))
-
-	for _, privateAddress := range privateAddresses {
-		ip, err := netip.ParseAddr(privateAddress)
-		if err == nil {
-			ips = append(ips, ip)
-			continue
-		}
-
-		ipPrefix, err := netip.ParsePrefix(privateAddress)
-		if err == nil {
-			ipPrefixes = append(ipPrefixes, ipPrefix)
-			continue
-		}
-
-		return nil, nil, fmt.Errorf(
-			"environment variable DOT_PRIVATE_ADDRESS: %w: %s",
-			ErrPrivateAddressNotValid, privateAddress)
-	}
-
-	return ips, ipPrefixes, nil
-}

internal/configuration/sources/env/dot.go

@@ -1,31 +0,0 @@
-package env
-
-import (
-	"fmt"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-func (s *Source) readDoT() (dot settings.DoT, err error) {
-	dot.Enabled, err = envToBoolPtr("DOT")
-	if err != nil {
-		return dot, fmt.Errorf("environment variable DOT: %w", err)
-	}
-
-	dot.UpdatePeriod, err = envToDurationPtr("DNS_UPDATE_PERIOD")
-	if err != nil {
-		return dot, fmt.Errorf("environment variable DNS_UPDATE_PERIOD: %w", err)
-	}
-
-	dot.Unbound, err = readUnbound()
-	if err != nil {
-		return dot, err
-	}
-
-	dot.Blacklist, err = s.readDNSBlacklist()
-	if err != nil {
-		return dot, err
-	}
-
-	return dot, nil
-}

internal/configuration/sources/env/firewall.go

@@ -1,80 +0,0 @@
-package env
-
-import (
-	"errors"
-	"fmt"
-	"net/netip"
-	"strconv"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-func (s *Source) readFirewall() (firewall settings.Firewall, err error) {
-	vpnInputPortStrings := envToCSV("FIREWALL_VPN_INPUT_PORTS")
-	firewall.VPNInputPorts, err = stringsToPorts(vpnInputPortStrings)
-	if err != nil {
-		return firewall, fmt.Errorf("environment variable FIREWALL_VPN_INPUT_PORTS: %w", err)
-	}
-
-	inputPortStrings := envToCSV("FIREWALL_INPUT_PORTS")
-	firewall.InputPorts, err = stringsToPorts(inputPortStrings)
-	if err != nil {
-		return firewall, fmt.Errorf("environment variable FIREWALL_INPUT_PORTS: %w", err)
-	}
-
-	outboundSubnetsKey, _ := s.getEnvWithRetro("FIREWALL_OUTBOUND_SUBNETS", "EXTRA_SUBNETS")
-	outboundSubnetStrings := envToCSV(outboundSubnetsKey)
-	firewall.OutboundSubnets, err = stringsToNetipPrefixes(outboundSubnetStrings)
-	if err != nil {
-		return firewall, fmt.Errorf("environment variable %s: %w", outboundSubnetsKey, err)
-	}
-
-	firewall.Enabled, err = envToBoolPtr("FIREWALL")
-	if err != nil {
-		return firewall, fmt.Errorf("environment variable FIREWALL: %w", err)
-	}
-
-	firewall.Debug, err = envToBoolPtr("FIREWALL_DEBUG")
-	if err != nil {
-		return firewall, fmt.Errorf("environment variable FIREWALL_DEBUG: %w", err)
-	}
-
-	return firewall, nil
-}
-
-var (
-	ErrPortParsing = errors.New("cannot parse port")
-	ErrPortValue   = errors.New("port value is not valid")
-)
-
-func stringsToPorts(ss []string) (ports []uint16, err error) {
-	if len(ss) == 0 {
-		return nil, nil
-	}
-	ports = make([]uint16, len(ss))
-	for i, s := range ss {
-		port, err := strconv.Atoi(s)
-		if err != nil {
-			return nil, fmt.Errorf("%w: %s: %s", ErrPortParsing, s, err)
-		} else if port < 1 || port > 65535 {
-			return nil, fmt.Errorf("%w: must be between 1 and 65535: %d",
-				ErrPortValue, port)
-		}
-		ports[i] = uint16(port)
-	}
-	return ports, nil
-}
-
-func stringsToNetipPrefixes(ss []string) (ipPrefixes []netip.Prefix, err error) {
-	if len(ss) == 0 {
-		return nil, nil
-	}
-	ipPrefixes = make([]netip.Prefix, len(ss))
-	for i, s := range ss {
-		ipPrefixes[i], err = netip.ParsePrefix(s)
-		if err != nil {
-			return nil, fmt.Errorf("parsing IP network %q: %w", s, err)
-		}
-	}
-	return ipPrefixes, nil
-}

internal/configuration/sources/env/health.go

@@ -1,51 +0,0 @@
-package env
-
-import (
-	"fmt"
-	"time"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-func (s *Source) ReadHealth() (health settings.Health, err error) {
-	health.ServerAddress = getCleanedEnv("HEALTH_SERVER_ADDRESS")
-	_, health.TargetAddress = s.getEnvWithRetro("HEALTH_TARGET_ADDRESS", "HEALTH_ADDRESS_TO_PING")
-
-	successWaitPtr, err := envToDurationPtr("HEALTH_SUCCESS_WAIT_DURATION")
-	if err != nil {
-		return health, fmt.Errorf("environment variable HEALTH_SUCCESS_WAIT_DURATION: %w", err)
-	} else if successWaitPtr != nil {
-		health.SuccessWait = *successWaitPtr
-	}
-
-	health.VPN.Initial, err = s.readDurationWithRetro(
-		"HEALTH_VPN_DURATION_INITIAL",
-		"HEALTH_OPENVPN_DURATION_INITIAL")
-	if err != nil {
-		return health, err
-	}
-
-	health.VPN.Addition, err = s.readDurationWithRetro(
-		"HEALTH_VPN_DURATION_ADDITION",
-		"HEALTH_OPENVPN_DURATION_ADDITION")
-	if err != nil {
-		return health, err
-	}
-
-	return health, nil
-}
-
-func (s *Source) readDurationWithRetro(envKey, retroEnvKey string) (d *time.Duration, err error) {
-	envKey, value := s.getEnvWithRetro(envKey, retroEnvKey)
-	if value == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	d = new(time.Duration)
-	*d, err = time.ParseDuration(value)
-	if err != nil {
-		return nil, fmt.Errorf("environment variable %s: %w", envKey, err)
-	}
-
-	return d, nil
-}

internal/configuration/sources/env/helpers.go

@@ -1,140 +0,0 @@
-package env
-
-import (
-	"fmt"
-	"os"
-	"strconv"
-	"strings"
-	"time"
-
-	"github.com/qdm12/govalid/binary"
-	"github.com/qdm12/govalid/integer"
-)
-
-// getCleanedEnv returns an environment variable value with
-// surrounding spaces and trailing new line characters removed.
-func getCleanedEnv(envKey string) (value string) {
-	value = os.Getenv(envKey)
-	value = strings.TrimSpace(value)
-	value = strings.TrimSuffix(value, "\r\n")
-	value = strings.TrimSuffix(value, "\n")
-	return value
-}
-
-func envToCSV(envKey string) (values []string) {
-	csv := getCleanedEnv(envKey)
-	if csv == "" {
-		return nil
-	}
-	return lowerAndSplit(csv)
-}
-
-func envToFloat64(envKey string) (f float64, err error) {
-	s := getCleanedEnv(envKey)
-	if s == "" {
-		return 0, nil
-	}
-	const bits = 64
-	return strconv.ParseFloat(s, bits)
-}
-
-func envToStringPtr(envKey string) (stringPtr *string) {
-	s := getCleanedEnv(envKey)
-	if s == "" {
-		return nil
-	}
-	return &s
-}
-
-func envToBoolPtr(envKey string) (boolPtr *bool, err error) {
-	s := getCleanedEnv(envKey)
-	if s == "" {
-		return nil, nil //nolint:nilnil
-	}
-	value, err := binary.Validate(s)
-	if err != nil {
-		return nil, err
-	}
-	return &value, nil
-}
-
-func envToIntPtr(envKey string) (intPtr *int, err error) {
-	s := getCleanedEnv(envKey)
-	if s == "" {
-		return nil, nil //nolint:nilnil
-	}
-	value, err := strconv.Atoi(s)
-	if err != nil {
-		return nil, err
-	}
-	return &value, nil
-}
-
-func envToUint8Ptr(envKey string) (uint8Ptr *uint8, err error) {
-	s := getCleanedEnv(envKey)
-	if s == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	const min, max = 0, 255
-	value, err := integer.Validate(s, integer.OptionRange(min, max))
-	if err != nil {
-		return nil, err
-	}
-
-	uint8Ptr = new(uint8)
-	*uint8Ptr = uint8(value)
-	return uint8Ptr, nil
-}
-
-func envToUint16Ptr(envKey string) (uint16Ptr *uint16, err error) {
-	s := getCleanedEnv(envKey)
-	if s == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	const min, max = 0, 65535
-	value, err := integer.Validate(s, integer.OptionRange(min, max))
-	if err != nil {
-		return nil, err
-	}
-
-	uint16Ptr = new(uint16)
-	*uint16Ptr = uint16(value)
-	return uint16Ptr, nil
-}
-
-func envToDurationPtr(envKey string) (durationPtr *time.Duration, err error) {
-	s := getCleanedEnv(envKey)
-	if s == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	durationPtr = new(time.Duration)
-	*durationPtr, err = time.ParseDuration(s)
-	if err != nil {
-		return nil, err
-	}
-
-	return durationPtr, nil
-}
-
-func lowerAndSplit(csv string) (values []string) {
-	csv = strings.ToLower(csv)
-	return strings.Split(csv, ",")
-}
-
-func unsetEnvKeys(envKeys []string, err error) (newErr error) {
-	newErr = err
-	for _, envKey := range envKeys {
-		unsetErr := os.Unsetenv(envKey)
-		if unsetErr != nil && newErr == nil {
-			newErr = fmt.Errorf("unsetting environment variable %s: %w", envKey, unsetErr)
-		}
-	}
-	return newErr
-}
-
-func stringPtr(s string) *string { return &s }
-func uint32Ptr(n uint32) *uint32 { return &n }
-func boolPtr(b bool) *bool       { return &b }

internal/configuration/sources/env/helpers_test.go

@@ -1,22 +0,0 @@
-package env
-
-import (
-	"os"
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-)
-
-// setTestEnv is used to set environment variables in
-// parallel tests.
-func setTestEnv(t *testing.T, key, value string) {
-	t.Helper()
-	existing := os.Getenv(key)
-	err := os.Setenv(key, value) //nolint:tenv
-	t.Cleanup(func() {
-		err = os.Setenv(key, existing)
-		assert.NoError(t, err)
-	})
-	require.NoError(t, err)
-}

internal/configuration/sources/env/httproxy.go

@@ -1,91 +0,0 @@
-package env
-
-import (
-	"fmt"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-	"github.com/qdm12/govalid/binary"
-)
-
-func (s *Source) readHTTPProxy() (httpProxy settings.HTTPProxy, err error) {
-	httpProxy.User = s.readHTTProxyUser()
-	httpProxy.Password = s.readHTTProxyPassword()
-	httpProxy.ListeningAddress = s.readHTTProxyListeningAddress()
-
-	httpProxy.Enabled, err = s.readHTTProxyEnabled()
-	if err != nil {
-		return httpProxy, err
-	}
-
-	httpProxy.Stealth, err = envToBoolPtr("HTTPPROXY_STEALTH")
-	if err != nil {
-		return httpProxy, fmt.Errorf("environment variable HTTPPROXY_STEALTH: %w", err)
-	}
-
-	httpProxy.Log, err = s.readHTTProxyLog()
-	if err != nil {
-		return httpProxy, err
-	}
-
-	return httpProxy, nil
-}
-
-func (s *Source) readHTTProxyUser() (user *string) {
-	_, value := s.getEnvWithRetro("HTTPPROXY_USER", "PROXY_USER", "TINYPROXY_USER")
-	if value != "" {
-		return &value
-	}
-	return nil
-}
-
-func (s *Source) readHTTProxyPassword() (user *string) {
-	_, value := s.getEnvWithRetro("HTTPPROXY_PASSWORD", "PROXY_PASSWORD", "TINYPROXY_PASSWORD")
-	if value != "" {
-		return &value
-	}
-	return nil
-}
-
-func (s *Source) readHTTProxyListeningAddress() (listeningAddress string) {
-	key, value := s.getEnvWithRetro("HTTPPROXY_LISTENING_ADDRESS", "PROXY_PORT", "TINYPROXY_PORT", "HTTPPROXY_PORT")
-	if key == "HTTPPROXY_LISTENING_ADDRESS" {
-		return value
-	}
-	return ":" + value
-}
-
-func (s *Source) readHTTProxyEnabled() (enabled *bool, err error) {
-	key, value := s.getEnvWithRetro("HTTPPROXY", "PROXY", "TINYPROXY")
-	if value == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	enabled = new(bool)
-	*enabled, err = binary.Validate(value)
-	if err != nil {
-		return nil, fmt.Errorf("environment variable %s: %w", key, err)
-	}
-
-	return enabled, nil
-}
-
-func (s *Source) readHTTProxyLog() (enabled *bool, err error) {
-	key, value := s.getEnvWithRetro("HTTPPROXY_LOG", "PROXY_LOG_LEVEL", "TINYPROXY_LOG")
-	if value == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	var binaryOptions []binary.Option
-	if key != "HTTPROXY_LOG" {
-		retroOption := binary.OptionEnabled("on", "info", "connect", "notice")
-		binaryOptions = append(binaryOptions, retroOption)
-	}
-
-	enabled = new(bool)
-	*enabled, err = binary.Validate(value, binaryOptions...)
-	if err != nil {
-		return nil, fmt.Errorf("environment variable %s: %w", key, err)
-	}
-
-	return enabled, nil
-}

internal/configuration/sources/env/log.go

@@ -1,53 +0,0 @@
-package env
-
-import (
-	"errors"
-	"fmt"
-	"strings"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-	"github.com/qdm12/log"
-)
-
-func readLog() (log settings.Log, err error) {
-	log.Level, err = readLogLevel()
-	if err != nil {
-		return log, err
-	}
-
-	return log, nil
-}
-
-func readLogLevel() (level *log.Level, err error) {
-	s := getCleanedEnv("LOG_LEVEL")
-	if s == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	level = new(log.Level)
-	*level, err = parseLogLevel(s)
-	if err != nil {
-		return nil, fmt.Errorf("environment variable LOG_LEVEL: %w", err)
-	}
-
-	return level, nil
-}
-
-var ErrLogLevelUnknown = errors.New("log level is unknown")
-
-func parseLogLevel(s string) (level log.Level, err error) {
-	switch strings.ToLower(s) {
-	case "debug":
-		return log.LevelDebug, nil
-	case "info":
-		return log.LevelInfo, nil
-	case "warning":
-		return log.LevelWarn, nil
-	case "error":
-		return log.LevelError, nil
-	default:
-		return level, fmt.Errorf(
-			"%w: %q is not valid and can be one of debug, info, warning or error",
-			ErrLogLevelUnknown, s)
-	}
-}

internal/configuration/sources/env/openvpn.go

@@ -1,127 +0,0 @@
-package env
-
-import (
-	"fmt"
-	"strings"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-	"github.com/qdm12/govalid/binary"
-)
-
-func (s *Source) readOpenVPN() (
-	openVPN settings.OpenVPN, err error) {
-	defer func() {
-		err = unsetEnvKeys([]string{"OPENVPN_KEY", "OPENVPN_CERT",
-			"OPENVPN_KEY_PASSPHRASE", "OPENVPN_ENCRYPTED_KEY"}, err)
-	}()
-
-	openVPN.Version = getCleanedEnv("OPENVPN_VERSION")
-	openVPN.User = s.readOpenVPNUser()
-	openVPN.Password = s.readOpenVPNPassword()
-	confFile := getCleanedEnv("OPENVPN_CUSTOM_CONFIG")
-	if confFile != "" {
-		openVPN.ConfFile = &confFile
-	}
-
-	ciphersKey, _ := s.getEnvWithRetro("OPENVPN_CIPHERS", "OPENVPN_CIPHER")
-	openVPN.Ciphers = envToCSV(ciphersKey)
-
-	auth := getCleanedEnv("OPENVPN_AUTH")
-	if auth != "" {
-		openVPN.Auth = &auth
-	}
-
-	openVPN.Cert = envToStringPtr("OPENVPN_CERT")
-	openVPN.Key = envToStringPtr("OPENVPN_KEY")
-	openVPN.EncryptedKey = envToStringPtr("OPENVPN_ENCRYPTED_KEY")
-
-	openVPN.KeyPassphrase = s.readOpenVPNKeyPassphrase()
-
-	openVPN.PIAEncPreset = s.readPIAEncryptionPreset()
-
-	openVPN.MSSFix, err = envToUint16Ptr("OPENVPN_MSSFIX")
-	if err != nil {
-		return openVPN, fmt.Errorf("environment variable OPENVPN_MSSFIX: %w", err)
-	}
-
-	_, openVPN.Interface = s.getEnvWithRetro("VPN_INTERFACE", "OPENVPN_INTERFACE")
-
-	openVPN.ProcessUser, err = s.readOpenVPNProcessUser()
-	if err != nil {
-		return openVPN, err
-	}
-
-	openVPN.Verbosity, err = envToIntPtr("OPENVPN_VERBOSITY")
-	if err != nil {
-		return openVPN, fmt.Errorf("environment variable OPENVPN_VERBOSITY: %w", err)
-	}
-
-	flagsStr := getCleanedEnv("OPENVPN_FLAGS")
-	if flagsStr != "" {
-		openVPN.Flags = strings.Fields(flagsStr)
-	}
-
-	return openVPN, nil
-}
-
-func (s *Source) readOpenVPNUser() (user *string) {
-	user = new(string)
-	_, *user = s.getEnvWithRetro("OPENVPN_USER", "USER")
-	if *user == "" {
-		return nil
-	}
-
-	// Remove spaces in user ID to simplify user's life, thanks @JeordyR
-	*user = strings.ReplaceAll(*user, " ", "")
-	return user
-}
-
-func (s *Source) readOpenVPNPassword() (password *string) {
-	password = new(string)
-	_, *password = s.getEnvWithRetro("OPENVPN_PASSWORD", "PASSWORD")
-	if *password == "" {
-		return nil
-	}
-
-	return password
-}
-
-func (s *Source) readOpenVPNKeyPassphrase() (passphrase *string) {
-	passphrase = new(string)
-	*passphrase = getCleanedEnv("OPENVPN_KEY_PASSPHRASE")
-	if *passphrase == "" {
-		return nil
-	}
-	return passphrase
-}
-
-func (s *Source) readPIAEncryptionPreset() (presetPtr *string) {
-	_, preset := s.getEnvWithRetro(
-		"PRIVATE_INTERNET_ACCESS_OPENVPN_ENCRYPTION_PRESET",
-		"PIA_ENCRYPTION", "ENCRYPTION")
-	if preset != "" {
-		return &preset
-	}
-	return nil
-}
-
-func (s *Source) readOpenVPNProcessUser() (processUser string, err error) {
-	key, value := s.getEnvWithRetro("OPENVPN_PROCESS_USER", "OPENVPN_ROOT")
-	if key == "OPENVPN_PROCESS_USER" {
-		return value, nil
-	}
-
-	// Retro-compatibility
-	if value == "" {
-		return "", nil
-	}
-	root, err := binary.Validate(value)
-	if err != nil {
-		return "", fmt.Errorf("environment variable %s: %w", key, err)
-	}
-	if root {
-		return "root", nil
-	}
-	const defaultNonRootUser = "nonrootuser"
-	return defaultNonRootUser, nil
-}

internal/configuration/sources/env/openvpnselection.go

@@ -1,66 +0,0 @@
-package env
-
-import (
-	"errors"
-	"fmt"
-	"strings"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-	"github.com/qdm12/gluetun/internal/constants"
-	"github.com/qdm12/govalid/port"
-)
-
-func (s *Source) readOpenVPNSelection() (
-	selection settings.OpenVPNSelection, err error) {
-	confFile := getCleanedEnv("OPENVPN_CUSTOM_CONFIG")
-	if confFile != "" {
-		selection.ConfFile = &confFile
-	}
-
-	selection.TCP, err = s.readOpenVPNProtocol()
-	if err != nil {
-		return selection, err
-	}
-
-	selection.CustomPort, err = s.readOpenVPNCustomPort()
-	if err != nil {
-		return selection, err
-	}
-
-	selection.PIAEncPreset = s.readPIAEncryptionPreset()
-
-	return selection, nil
-}
-
-var ErrOpenVPNProtocolNotValid = errors.New("OpenVPN protocol is not valid")
-
-func (s *Source) readOpenVPNProtocol() (tcp *bool, err error) {
-	envKey, protocol := s.getEnvWithRetro("OPENVPN_PROTOCOL", "PROTOCOL")
-
-	switch strings.ToLower(protocol) {
-	case "":
-		return nil, nil //nolint:nilnil
-	case constants.UDP:
-		return boolPtr(false), nil
-	case constants.TCP:
-		return boolPtr(true), nil
-	default:
-		return nil, fmt.Errorf("environment variable %s: %w: %s",
-			envKey, ErrOpenVPNProtocolNotValid, protocol)
-	}
-}
-
-func (s *Source) readOpenVPNCustomPort() (customPort *uint16, err error) {
-	key, value := s.getEnvWithRetro("VPN_ENDPOINT_PORT", "PORT", "OPENVPN_PORT")
-	if value == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	customPort = new(uint16)
-	*customPort, err = port.Validate(value)
-	if err != nil {
-		return nil, fmt.Errorf("environment variable %s: %w", key, err)
-	}
-
-	return customPort, nil
-}

internal/configuration/sources/env/portforward.go

@@ -1,29 +0,0 @@
-package env
-
-import (
-	"fmt"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-func (s *Source) readPortForward() (
-	portForwarding settings.PortForwarding, err error) {
-	key, _ := s.getEnvWithRetro(
-		"VPN_PORT_FORWARDING",
-		"PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING",
-		"PORT_FORWARDING")
-	portForwarding.Enabled, err = envToBoolPtr(key)
-	if err != nil {
-		return portForwarding, fmt.Errorf("environment variable %s: %w", key, err)
-	}
-
-	_, value := s.getEnvWithRetro(
-		"VPN_PORT_FORWARDING_STATUS_FILE",
-		"PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING_STATUS_FILE",
-		"PORT_FORWARDING_STATUS_FILE")
-	if value != "" {
-		portForwarding.Filepath = stringPtr(value)
-	}
-
-	return portForwarding, nil
-}

internal/configuration/sources/env/pprof.go

@@ -1,28 +0,0 @@
-package env
-
-import (
-	"fmt"
-
-	"github.com/qdm12/gluetun/internal/pprof"
-)
-
-func readPprof() (settings pprof.Settings, err error) {
-	settings.Enabled, err = envToBoolPtr("PPROF_ENABLED")
-	if err != nil {
-		return settings, fmt.Errorf("environment variable PPROF_ENABLED: %w", err)
-	}
-
-	settings.BlockProfileRate, err = envToIntPtr("PPROF_BLOCK_PROFILE_RATE")
-	if err != nil {
-		return settings, fmt.Errorf("environment variable PPROF_BLOCK_PROFILE_RATE: %w", err)
-	}
-
-	settings.MutexProfileRate, err = envToIntPtr("PPROF_MUTEX_PROFILE_RATE")
-	if err != nil {
-		return settings, fmt.Errorf("environment variable PPROF_MUTEX_PROFILE_RATE: %w", err)
-	}
-
-	settings.HTTPServer.Address = getCleanedEnv("PPROF_HTTP_SERVER_ADDRESS")
-
-	return settings, nil
-}

internal/configuration/sources/env/provider.go

@@ -1,48 +0,0 @@
-package env
-
-import (
-	"fmt"
-	"strings"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-	"github.com/qdm12/gluetun/internal/constants/providers"
-	"github.com/qdm12/gluetun/internal/constants/vpn"
-)
-
-func (s *Source) readProvider(vpnType string) (provider settings.Provider, err error) {
-	provider.Name = s.readVPNServiceProvider(vpnType)
-	var providerName string
-	if provider.Name != nil {
-		providerName = *provider.Name
-	}
-
-	provider.ServerSelection, err = s.readServerSelection(providerName, vpnType)
-	if err != nil {
-		return provider, fmt.Errorf("server selection: %w", err)
-	}
-
-	provider.PortForwarding, err = s.readPortForward()
-	if err != nil {
-		return provider, fmt.Errorf("port forwarding: %w", err)
-	}
-
-	return provider, nil
-}
-
-func (s *Source) readVPNServiceProvider(vpnType string) (vpnProviderPtr *string) {
-	_, value := s.getEnvWithRetro("VPN_SERVICE_PROVIDER", "VPNSP")
-	if value == "" {
-		if vpnType != vpn.Wireguard && getCleanedEnv("OPENVPN_CUSTOM_CONFIG") != "" {
-			// retro compatibility
-			return stringPtr(providers.Custom)
-		}
-		return nil
-	}
-
-	value = strings.ToLower(value)
-	if value == "pia" { // retro compatibility
-		return stringPtr(providers.PrivateInternetAccess)
-	}
-
-	return stringPtr(value)
-}

internal/configuration/sources/env/publicip.go

@@ -1,42 +0,0 @@
-package env
-
-import (
-	"fmt"
-	"time"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-func (s *Source) readPublicIP() (publicIP settings.PublicIP, err error) {
-	publicIP.Period, err = readPublicIPPeriod()
-	if err != nil {
-		return publicIP, err
-	}
-
-	publicIP.IPFilepath = s.readPublicIPFilepath()
-
-	return publicIP, nil
-}
-
-func readPublicIPPeriod() (period *time.Duration, err error) {
-	s := getCleanedEnv("PUBLICIP_PERIOD")
-	if s == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	period = new(time.Duration)
-	*period, err = time.ParseDuration(s)
-	if err != nil {
-		return nil, fmt.Errorf("environment variable PUBLICIP_PERIOD: %w", err)
-	}
-
-	return period, nil
-}
-
-func (s *Source) readPublicIPFilepath() (filepath *string) {
-	_, value := s.getEnvWithRetro("PUBLICIP_FILE", "IP_STATUS_FILE")
-	if value != "" {
-		return &value
-	}
-	return nil
-}

internal/configuration/sources/env/reader.go

@@ -1,117 +0,0 @@
-package env
-
-import (
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-type Source struct {
-	warner Warner
-}
-
-type Warner interface {
-	Warn(s string)
-}
-
-func New(warner Warner) *Source {
-	return &Source{
-		warner: warner,
-	}
-}
-
-func (s *Source) String() string { return "environment variables" }
-
-func (s *Source) Read() (settings settings.Settings, err error) {
-	settings.VPN, err = s.readVPN()
-	if err != nil {
-		return settings, err
-	}
-
-	settings.Firewall, err = s.readFirewall()
-	if err != nil {
-		return settings, err
-	}
-
-	settings.System, err = s.readSystem()
-	if err != nil {
-		return settings, err
-	}
-
-	settings.Health, err = s.ReadHealth()
-	if err != nil {
-		return settings, err
-	}
-
-	settings.HTTPProxy, err = s.readHTTPProxy()
-	if err != nil {
-		return settings, err
-	}
-
-	settings.Log, err = readLog()
-	if err != nil {
-		return settings, err
-	}
-
-	settings.PublicIP, err = s.readPublicIP()
-	if err != nil {
-		return settings, err
-	}
-
-	settings.Updater, err = readUpdater()
-	if err != nil {
-		return settings, err
-	}
-
-	settings.Version, err = readVersion()
-	if err != nil {
-		return settings, err
-	}
-
-	settings.Shadowsocks, err = s.readShadowsocks()
-	if err != nil {
-		return settings, err
-	}
-
-	settings.DNS, err = s.readDNS()
-	if err != nil {
-		return settings, err
-	}
-
-	settings.ControlServer, err = s.readControlServer()
-	if err != nil {
-		return settings, err
-	}
-
-	settings.Pprof, err = readPprof()
-	if err != nil {
-		return settings, err
-	}
-
-	return settings, nil
-}
-
-func (s *Source) onRetroActive(oldKey, newKey string) {
-	s.warner.Warn(
-		"You are using the old environment variable " + oldKey +
-			", please consider changing it to " + newKey)
-}
-
-// getEnvWithRetro returns the first environment variable
-// key and corresponding non empty value from the environment
-// variable keys given. It first goes through the retroKeys
-// and end on returning the value corresponding to the currentKey.
-// Note retroKeys should be in order from oldest to most
-// recent retro-compatibility key.
-func (s *Source) getEnvWithRetro(currentKey string,
-	retroKeys ...string) (key, value string) {
-	// We check retro-compatibility keys first since
-	// the current key might be set in the Dockerfile.
-	for _, key = range retroKeys {
-		value = getCleanedEnv(key)
-		if value != "" {
-			s.onRetroActive(key, currentKey)
-			return key, value
-		}
-	}
-
-	return currentKey, getCleanedEnv(currentKey)
-}

internal/configuration/sources/env/server.go

@@ -1,48 +0,0 @@
-package env
-
-import (
-	"fmt"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-	"github.com/qdm12/govalid/binary"
-)
-
-func (s *Source) readControlServer() (controlServer settings.ControlServer, err error) {
-	controlServer.Log, err = readControlServerLog()
-	if err != nil {
-		return controlServer, err
-	}
-
-	controlServer.Address = s.readControlServerAddress()
-
-	return controlServer, nil
-}
-
-func readControlServerLog() (enabled *bool, err error) {
-	s := getCleanedEnv("HTTP_CONTROL_SERVER_LOG")
-	if s == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	log, err := binary.Validate(s)
-	if err != nil {
-		return nil, fmt.Errorf("environment variable HTTP_CONTROL_SERVER_LOG: %w", err)
-	}
-
-	return &log, nil
-}
-
-func (s *Source) readControlServerAddress() (address *string) {
-	key, value := s.getEnvWithRetro("HTTP_CONTROL_SERVER_ADDRESS", "HTTP_CONTROL_SERVER_PORT")
-	if value == "" {
-		return nil
-	}
-
-	if key == "HTTP_CONTROL_SERVER_ADDRESS" {
-		return &value
-	}
-
-	address = new(string)
-	*address = ":" + value
-	return address
-}

internal/configuration/sources/env/serverselection.go

@@ -1,137 +0,0 @@
-package env
-
-import (
-	"errors"
-	"fmt"
-	"net/netip"
-	"strconv"
-	"strings"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-	"github.com/qdm12/gluetun/internal/constants/providers"
-)
-
-var (
-	ErrServerNumberNotValid = errors.New("server number is not valid")
-)
-
-func (s *Source) readServerSelection(vpnProvider, vpnType string) (
-	ss settings.ServerSelection, err error) {
-	ss.VPN = vpnType
-
-	ss.TargetIP, err = s.readOpenVPNTargetIP()
-	if err != nil {
-		return ss, err
-	}
-
-	countriesKey, _ := s.getEnvWithRetro("SERVER_COUNTRIES", "COUNTRY")
-	ss.Countries = envToCSV(countriesKey)
-	if vpnProvider == providers.Cyberghost && len(ss.Countries) == 0 {
-		// Retro-compatibility for Cyberghost using the REGION variable
-		ss.Countries = envToCSV("REGION")
-		if len(ss.Countries) > 0 {
-			s.onRetroActive("REGION", "SERVER_COUNTRIES")
-		}
-	}
-
-	regionsKey, _ := s.getEnvWithRetro("SERVER_REGIONS", "REGION")
-	ss.Regions = envToCSV(regionsKey)
-
-	citiesKey, _ := s.getEnvWithRetro("SERVER_CITIES", "CITY")
-	ss.Cities = envToCSV(citiesKey)
-
-	ss.ISPs = envToCSV("ISP")
-
-	hostnamesKey, _ := s.getEnvWithRetro("SERVER_HOSTNAMES", "SERVER_HOSTNAME")
-	ss.Hostnames = envToCSV(hostnamesKey)
-
-	serverNamesKey, _ := s.getEnvWithRetro("SERVER_NAMES", "SERVER_NAME")
-	ss.Names = envToCSV(serverNamesKey)
-
-	if csv := getCleanedEnv("SERVER_NUMBER"); csv != "" {
-		numbersStrings := strings.Split(csv, ",")
-		numbers := make([]uint16, len(numbersStrings))
-		for i, numberString := range numbersStrings {
-			const base, bitSize = 10, 16
-			number, err := strconv.ParseInt(numberString, base, bitSize)
-			if err != nil {
-				return ss, fmt.Errorf("%w: %s",
-					ErrServerNumberNotValid, numberString)
-			} else if number < 0 || number > 65535 {
-				return ss, fmt.Errorf("%w: %d must be between 0 and 65535",
-					ErrServerNumberNotValid, number)
-			}
-			numbers[i] = uint16(number)
-		}
-		ss.Numbers = numbers
-	}
-
-	// Mullvad only
-	ss.OwnedOnly, err = s.readOwnedOnly()
-	if err != nil {
-		return ss, err
-	}
-
-	// VPNUnlimited and ProtonVPN only
-	ss.FreeOnly, err = envToBoolPtr("FREE_ONLY")
-	if err != nil {
-		return ss, fmt.Errorf("environment variable FREE_ONLY: %w", err)
-	}
-
-	// VPNSecure only
-	ss.PremiumOnly, err = envToBoolPtr("PREMIUM_ONLY")
-	if err != nil {
-		return ss, fmt.Errorf("environment variable PREMIUM_ONLY: %w", err)
-	}
-
-	// VPNUnlimited only
-	ss.MultiHopOnly, err = envToBoolPtr("MULTIHOP_ONLY")
-	if err != nil {
-		return ss, fmt.Errorf("environment variable MULTIHOP_ONLY: %w", err)
-	}
-
-	// VPNUnlimited only
-	ss.MultiHopOnly, err = envToBoolPtr("STREAM_ONLY")
-	if err != nil {
-		return ss, fmt.Errorf("environment variable STREAM_ONLY: %w", err)
-	}
-
-	ss.OpenVPN, err = s.readOpenVPNSelection()
-	if err != nil {
-		return ss, err
-	}
-
-	ss.Wireguard, err = s.readWireguardSelection()
-	if err != nil {
-		return ss, err
-	}
-
-	return ss, nil
-}
-
-var (
-	ErrInvalidIP = errors.New("invalid IP address")
-)
-
-func (s *Source) readOpenVPNTargetIP() (ip netip.Addr, err error) {
-	envKey, value := s.getEnvWithRetro("VPN_ENDPOINT_IP", "OPENVPN_TARGET_IP")
-	if value == "" {
-		return ip, nil
-	}
-
-	ip, err = netip.ParseAddr(value)
-	if err != nil {
-		return ip, fmt.Errorf("environment variable %s: %w", envKey, err)
-	}
-
-	return ip, nil
-}
-
-func (s *Source) readOwnedOnly() (ownedOnly *bool, err error) {
-	envKey, _ := s.getEnvWithRetro("OWNED_ONLY", "OWNED")
-	ownedOnly, err = envToBoolPtr(envKey)
-	if err != nil {
-		return nil, fmt.Errorf("environment variable %s: %w", envKey, err)
-	}
-	return ownedOnly, nil
-}

internal/configuration/sources/env/shadowsocks.go

@@ -1,44 +0,0 @@
-package env
-
-import (
-	"fmt"
-	"strings"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-func (s *Source) readShadowsocks() (shadowsocks settings.Shadowsocks, err error) {
-	shadowsocks.Enabled, err = envToBoolPtr("SHADOWSOCKS")
-	if err != nil {
-		return shadowsocks, fmt.Errorf("environment variable SHADOWSOCKS: %w", err)
-	}
-
-	shadowsocks.Address = s.readShadowsocksAddress()
-	shadowsocks.LogAddresses, err = envToBoolPtr("SHADOWSOCKS_LOG")
-	if err != nil {
-		return shadowsocks, fmt.Errorf("environment variable SHADOWSOCKS_LOG: %w", err)
-	}
-	shadowsocks.CipherName = s.readShadowsocksCipher()
-	shadowsocks.Password = envToStringPtr("SHADOWSOCKS_PASSWORD")
-
-	return shadowsocks, nil
-}
-
-func (s *Source) readShadowsocksAddress() (address string) {
-	key, value := s.getEnvWithRetro("SHADOWSOCKS_LISTENING_ADDRESS", "SHADOWSOCKS_PORT")
-	if value == "" {
-		return ""
-	}
-
-	if key == "SHADOWSOCKS_LISTENING_ADDRESS" {
-		return value
-	}
-
-	// Retro-compatibility
-	return ":" + value
-}
-
-func (s *Source) readShadowsocksCipher() (cipher string) {
-	_, cipher = s.getEnvWithRetro("SHADOWSOCKS_CIPHER", "SHADOWSOCKS_METHOD")
-	return strings.ToLower(cipher)
-}

internal/configuration/sources/env/system.go

@@ -1,55 +0,0 @@
-package env
-
-import (
-	"errors"
-	"fmt"
-	"strconv"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-var (
-	ErrSystemPUIDNotValid     = errors.New("PUID is not valid")
-	ErrSystemPGIDNotValid     = errors.New("PGID is not valid")
-	ErrSystemTimezoneNotValid = errors.New("timezone is not valid")
-)
-
-func (s *Source) readSystem() (system settings.System, err error) {
-	system.PUID, err = s.readID("PUID", "UID")
-	if err != nil {
-		return system, err
-	}
-
-	system.PGID, err = s.readID("PGID", "GID")
-	if err != nil {
-		return system, err
-	}
-
-	system.Timezone = getCleanedEnv("TZ")
-
-	return system, nil
-}
-
-var ErrSystemIDNotValid = errors.New("system ID is not valid")
-
-func (s *Source) readID(key, retroKey string) (
-	id *uint32, err error) {
-	idEnvKey, idString := s.getEnvWithRetro(key, retroKey)
-	if idString == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	const base = 10
-	const bitSize = 64
-	const max = uint64(^uint32(0))
-	idUint64, err := strconv.ParseUint(idString, base, bitSize)
-	if err != nil {
-		return nil, fmt.Errorf("environment variable %s: %w: %s",
-			idEnvKey, ErrSystemIDNotValid, err)
-	} else if idUint64 > max {
-		return nil, fmt.Errorf("environment variable %s: %w: %d: must be between 0 and %d",
-			idEnvKey, ErrSystemIDNotValid, idUint64, max)
-	}
-
-	return uint32Ptr(uint32(idUint64)), nil
-}

internal/configuration/sources/env/system_test.go

@@ -1,88 +0,0 @@
-package env
-
-import (
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-)
-
-func Test_Reader_readID(t *testing.T) {
-	t.Parallel()
-
-	testCases := map[string]struct {
-		keyPrefix      string
-		keyValue       string
-		retroKeyPrefix string
-		retroValue     string
-		id             *uint32
-		errWrapped     error
-		errMessage     string
-	}{
-		"empty string": {
-			keyPrefix:      "ID",
-			retroKeyPrefix: "RETRO_ID",
-		},
-		"invalid string": {
-			keyPrefix:      "ID",
-			keyValue:       "invalid",
-			retroKeyPrefix: "RETRO_ID",
-			errWrapped:     ErrSystemIDNotValid,
-			errMessage: `environment variable IDTest_Reader_readID/invalid_string: ` +
-				`system ID is not valid: ` +
-				`strconv.ParseUint: parsing "invalid": invalid syntax`,
-		},
-		"negative number": {
-			keyPrefix:      "ID",
-			keyValue:       "-1",
-			retroKeyPrefix: "RETRO_ID",
-			errWrapped:     ErrSystemIDNotValid,
-			errMessage: `environment variable IDTest_Reader_readID/negative_number: ` +
-				`system ID is not valid: ` +
-				`strconv.ParseUint: parsing "-1": invalid syntax`,
-		},
-		"id 1000": {
-			keyPrefix:      "ID",
-			keyValue:       "1000",
-			retroKeyPrefix: "RETRO_ID",
-			id:             uint32Ptr(1000),
-		},
-		"max id": {
-			keyPrefix:      "ID",
-			keyValue:       "4294967295",
-			retroKeyPrefix: "RETRO_ID",
-			id:             uint32Ptr(4294967295),
-		},
-		"above max id": {
-			keyPrefix:      "ID",
-			keyValue:       "4294967296",
-			retroKeyPrefix: "RETRO_ID",
-			errWrapped:     ErrSystemIDNotValid,
-			errMessage: `environment variable IDTest_Reader_readID/above_max_id: ` +
-				`system ID is not valid: 4294967296: must be between 0 and 4294967295`,
-		},
-	}
-
-	for name, testCase := range testCases {
-		testCase := testCase
-		t.Run(name, func(t *testing.T) {
-			t.Parallel()
-
-			suffix := t.Name()
-			key := testCase.keyPrefix + suffix
-			retroKey := testCase.retroKeyPrefix + suffix
-
-			setTestEnv(t, key, testCase.keyValue)
-			setTestEnv(t, retroKey, testCase.retroValue)
-
-			source := &Source{}
-			id, err := source.readID(key, retroKey)
-
-			assert.ErrorIs(t, err, testCase.errWrapped)
-			if err != nil {
-				assert.EqualError(t, err, testCase.errMessage)
-			}
-
-			assert.Equal(t, testCase.id, id)
-		})
-	}
-}

internal/configuration/sources/env/unbound.go

@@ -1,38 +0,0 @@
-package env
-
-import (
-	"fmt"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-func readUnbound() (unbound settings.Unbound, err error) {
-	unbound.Providers = envToCSV("DOT_PROVIDERS")
-
-	unbound.Caching, err = envToBoolPtr("DOT_CACHING")
-	if err != nil {
-		return unbound, fmt.Errorf("environment variable DOT_CACHING: %w", err)
-	}
-
-	unbound.IPv6, err = envToBoolPtr("DOT_IPV6")
-	if err != nil {
-		return unbound, fmt.Errorf("environment variable DOT_IPV6: %w", err)
-	}
-
-	unbound.VerbosityLevel, err = envToUint8Ptr("DOT_VERBOSITY")
-	if err != nil {
-		return unbound, fmt.Errorf("environment variable DOT_VERBOSITY: %w", err)
-	}
-
-	unbound.VerbosityDetailsLevel, err = envToUint8Ptr("DOT_VERBOSITY_DETAILS")
-	if err != nil {
-		return unbound, fmt.Errorf("environment variable DOT_VERBOSITY_DETAILS: %w", err)
-	}
-
-	unbound.ValidationLogLevel, err = envToUint8Ptr("DOT_VALIDATION_LOGLEVEL")
-	if err != nil {
-		return unbound, fmt.Errorf("environment variable DOT_VALIDATION_LOGLEVEL: %w", err)
-	}
-
-	return unbound, nil
-}

internal/configuration/sources/env/updater.go

@@ -1,51 +0,0 @@
-package env
-
-import (
-	"fmt"
-	"time"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-func readUpdater() (updater settings.Updater, err error) {
-	updater.Period, err = readUpdaterPeriod()
-	if err != nil {
-		return updater, err
-	}
-
-	updater.DNSAddress, err = readUpdaterDNSAddress()
-	if err != nil {
-		return updater, err
-	}
-
-	updater.MinRatio, err = envToFloat64("UPDATER_MIN_RATIO")
-	if err != nil {
-		return updater, fmt.Errorf("environment variable UPDATER_MIN_RATIO: %w", err)
-	}
-
-	updater.Providers = envToCSV("UPDATER_VPN_SERVICE_PROVIDERS")
-
-	return updater, nil
-}
-
-func readUpdaterPeriod() (period *time.Duration, err error) {
-	s := getCleanedEnv("UPDATER_PERIOD")
-	if s == "" {
-		return nil, nil //nolint:nilnil
-	}
-	period = new(time.Duration)
-	*period, err = time.ParseDuration(s)
-	if err != nil {
-		return nil, fmt.Errorf("environment variable UPDATER_PERIOD: %w", err)
-	}
-	return period, nil
-}
-
-func readUpdaterDNSAddress() (address string, err error) {
-	// TODO this is currently using Cloudflare in
-	// plaintext to not be blocked by DNS over TLS by default.
-	// If a plaintext address is set in the DNS settings, this one will be used.
-	// use custom future encrypted DNS written in Go without blocking
-	// as it's too much trouble to start another parallel unbound instance for now.
-	return "", nil
-}

internal/configuration/sources/env/version.go

@@ -1,32 +0,0 @@
-package env
-
-import (
-	"fmt"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-	"github.com/qdm12/govalid/binary"
-)
-
-func readVersion() (version settings.Version, err error) {
-	version.Enabled, err = readVersionEnabled()
-	if err != nil {
-		return version, err
-	}
-
-	return version, nil
-}
-
-func readVersionEnabled() (enabled *bool, err error) {
-	s := getCleanedEnv("VERSION_INFORMATION")
-	if s == "" {
-		return nil, nil //nolint:nilnil
-	}
-
-	enabled = new(bool)
-	*enabled, err = binary.Validate(s)
-	if err != nil {
-		return nil, fmt.Errorf("environment variable VERSION_INFORMATION: %w", err)
-	}
-
-	return enabled, nil
-}

internal/configuration/sources/env/vpn.go

@@ -1,29 +0,0 @@
-package env
-
-import (
-	"fmt"
-	"strings"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-func (s *Source) readVPN() (vpn settings.VPN, err error) {
-	vpn.Type = strings.ToLower(getCleanedEnv("VPN_TYPE"))
-
-	vpn.Provider, err = s.readProvider(vpn.Type)
-	if err != nil {
-		return vpn, fmt.Errorf("VPN provider: %w", err)
-	}
-
-	vpn.OpenVPN, err = s.readOpenVPN()
-	if err != nil {
-		return vpn, fmt.Errorf("OpenVPN: %w", err)
-	}
-
-	vpn.Wireguard, err = s.readWireguard()
-	if err != nil {
-		return vpn, fmt.Errorf("wireguard: %w", err)
-	}
-
-	return vpn, nil
-}

internal/configuration/sources/env/wireguard.go

@@ -1,44 +0,0 @@
-package env
-
-import (
-	"fmt"
-	"net/netip"
-	"os"
-	"strings"
-
-	"github.com/qdm12/gluetun/internal/configuration/settings"
-)
-
-func (s *Source) readWireguard() (wireguard settings.Wireguard, err error) {
-	defer func() {
-		err = unsetEnvKeys([]string{"WIREGUARD_PRIVATE_KEY", "WIREGUARD_PRESHARED_KEY"}, err)
-	}()
-	wireguard.PrivateKey = envToStringPtr("WIREGUARD_PRIVATE_KEY")
-	wireguard.PreSharedKey = envToStringPtr("WIREGUARD_PRESHARED_KEY")
-	_, wireguard.Interface = s.getEnvWithRetro("VPN_INTERFACE", "WIREGUARD_INTERFACE")
-	wireguard.Implementation = os.Getenv("WIREGUARD_IMPLEMENTATION")
-	wireguard.Addresses, err = s.readWireguardAddresses()
-	if err != nil {
-		return wireguard, err // already wrapped
-	}
-	return wireguard, nil
-}
-
-func (s *Source) readWireguardAddresses() (addresses []netip.Prefix, err error) {
-	key, addressesCSV := s.getEnvWithRetro("WIREGUARD_ADDRESSES", "WIREGUARD_ADDRESS")
-	if addressesCSV == "" {
-		return nil, nil
-	}
-
-	addressStrings := strings.Split(addressesCSV, ",")
-	addresses = make([]netip.Prefix, len(addressStrings))
-	for i, addressString := range addressStrings {
-		addressString = strings.TrimSpace(addressString)
-		addresses[i], err = netip.ParsePrefix(addressString)
-		if err != nil {
-			return nil, fmt.Errorf("environment variable %s: %w", key, err)
-		}
-	}
-
-	return addresses, nil
-}