Fix: FastestVPN new OpenVPN config

- Add required `comp-lzo`
- Add `reneg-sec 0` to match their config
- Do not filter `auth-token`
- Set UDP options only when using UDP

.devcontainer/.dockerignore

@@ -0,0 +1,5 @@
+.dockerignore
+devcontainer.json
+docker-compose.yml
+Dockerfile
+README.md

.devcontainer/Dockerfile

@@ -0,0 +1,2 @@
+FROM qmcgaw/godevcontainer
+RUN apk add wireguard-tools

.devcontainer/README.md

@@ -0,0 +1,69 @@
+# Development container
+
+Development container that can be used with VSCode.
+
+It works on Linux, Windows and OSX.
+
+## Requirements
+
+- [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. 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
+
+### Customize the image
+
+You can make changes to the [Dockerfile](Dockerfile) and then rebuild the image. For example, your Dockerfile could be:
+
+```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`
+- With a terminal, go to this directory and `docker-compose build`
+
+### Customize VS code settings
+
+You can customize **settings** and **extensions** in the [devcontainer.json](devcontainer.json) definition file.
+
+### Entrypoint script
+
+You can bind mount a shell script to `/home/vscode/.welcome.sh` to replace the [current welcome script](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).
+
+### Run other services
+
+1. Modify [docker-compose.yml](docker-compose.yml) to launch other services at the same time as this development container, such as a test database:
+
+    ```yml
+      database:
+        image: postgres
+        restart: always
+        environment:
+          POSTGRES_PASSWORD: password
+    ```
+
+1. In [devcontainer.json](devcontainer.json), change the line `"runServices": ["vscode"],` to `"runServices": ["vscode", "database"],`.
+1. In the VS code command palette, rebuild the container.

.devcontainer/devcontainer.json

@@ -1,5 +1,5 @@
 {
-    "name": "pia-dev",
+    "name": "gluetun-dev",
     "dockerComposeFile": [
         "docker-compose.yml"
     ],
@@ -8,108 +8,74 @@
         "vscode"
     ],
     "shutdownAction": "stopCompose",
-    "postCreateCommand": "go mod download",
+    "postCreateCommand": "source ~/.windows.sh && go mod download && go mod tidy",
     "workspaceFolder": "/workspace",
     "extensions": [
         "golang.go",
-        "IBM.output-colorizer",
-        "eamodio.gitlens",
-        "mhutchie.git-graph",
+        "eamodio.gitlens", // IDE Git information
         "davidanson.vscode-markdownlint",
-        "shardulm94.trailing-spaces",
-        "alefragnani.Bookmarks",
-        "Gruntfuggly.todo-tree",
-        "mohsen1.prettify-json",
-        "quicktype.quicktype",
-        "spikespaz.vscode-smoothtype",
-        "stkb.rewrap",
-        "vscode-icons-team.vscode-icons"
+        "ms-azuretools.vscode-docker", // Docker integration and linting
+        "shardulm94.trailing-spaces", // Show trailing spaces
+        "Gruntfuggly.todo-tree", // Highlights TODO comments
+        "bierner.emojisense", // Emoji sense for markdown
+        "stkb.rewrap", // rewrap comments after n characters on one line
+        "vscode-icons-team.vscode-icons", // Better file extension icons
+        "github.vscode-pull-request-github", // Github interaction
+        "redhat.vscode-yaml", // Kubernetes, Drone syntax highlighting
+        "bajdzis.vscode-database", // Supports connections to mysql or postgres, over SSL, socked
+        "IBM.output-colorizer", // Colorize your output/test logs
+        "mohsen1.prettify-json", // Prettify JSON data
     ],
     "settings": {
-        // General settings
         "files.eol": "\n",
-        // Docker
         "remote.extensionKind": {
             "ms-azuretools.vscode-docker": "workspace"
         },
-        // Golang general settings
+        "editor.codeActionsOnSaveTimeout": 3000,
         "go.useLanguageServer": true,
+        "[go]": {
+            "editor.formatOnSave": true,
+            "editor.codeActionsOnSave": {
+                "source.organizeImports": true,
+            },
+            // Optional: Disable snippets, as they conflict with completion ranking.
+            "editor.snippetSuggestions": "none"
+        },
+        "[go.mod]": {
+            "editor.formatOnSave": true,
+            "editor.codeActionsOnSave": {
+                "source.organizeImports": true,
+            },
+        },
+        "gopls": {
+            "usePlaceholders": false,
+            "staticcheck": true
+        },
         "go.autocompleteUnimportedPackages": true,
         "go.gotoSymbol.includeImports": true,
         "go.gotoSymbol.includeGoroot": true,
-        "gopls": {
-            "completeUnimported": true,
-            "deepCompletion": true,
-            "usePlaceholders": false
-        },
         "go.lintTool": "golangci-lint",
-        "go.lintFlags": [
-            "--fast",
-            "--enable",
-            "staticcheck",
-            "--enable",
-            "bodyclose",
-            "--enable",
-            "dogsled",
-            "--enable",
-            "gochecknoglobals",
-            "--enable",
-            "gochecknoinits",
-            "--enable",
-            "gocognit",
-            "--enable",
-            "goconst",
-            "--enable",
-            "gocritic",
-            "--enable",
-            "gocyclo",
-            "--enable",
-            "golint",
-            "--enable",
-            "gosec",
-            "--enable",
-            "interfacer",
-            "--enable",
-            "maligned",
-            "--enable",
-            "misspell",
-            "--enable",
-            "nakedret",
-            "--enable",
-            "prealloc",
-            "--enable",
-            "scopelint",
-            "--enable",
-            "unconvert",
-            "--enable",
-            "unparam",
-            "--enable",
-            "whitespace"
-        ],
-        // Golang on save
         "go.buildOnSave": "workspace",
         "go.lintOnSave": "workspace",
         "go.vetOnSave": "workspace",
         "editor.formatOnSave": true,
-        "[go]": {
-            "editor.codeActionsOnSave": {
-                "source.organizeImports": true
-            }
-        },
-        // Golang testing
         "go.toolsEnvVars": {
-            "GOFLAGS": "-tags=integration"
+            "GOFLAGS": "-tags=",
+            // "CGO_ENABLED": 1 // for the race detector
         },
         "gopls.env": {
-            "GOFLAGS": "-tags=integration"
+            "GOFLAGS": "-tags="
+        },
+        "go.testEnvVars": {
+            "": ""
         },
-        "go.testEnvVars": {},
         "go.testFlags": [
             "-v",
             // "-race"
         ],
-        "go.testTimeout": "600s",
+        "go.testTimeout": "10s",
+        "go.coverOnSingleTest": true,
         "go.coverOnSingleTestFile": true,
-        "go.coverOnSingleTest": true
+        "go.coverOnTestPackage": true
     }
 }

.devcontainer/docker-compose.yml

@@ -2,14 +2,32 @@ version: "3.7"
 
 services:
   vscode:
-    image: qmcgaw/godevcontainer
+    build: .
+    image: godevcontainer
+    devices:
+      - /dev/net/tun:/dev/net/tun
     volumes:
       - ../:/workspace
-      - ~/.ssh:/home/vscode/.ssh:ro
-      - ~/.ssh:/root/.ssh:ro
+      # Docker socket to access Docker server
       - /var/run/docker.sock:/var/run/docker.sock
+      # Docker configuration
+      - ~/.docker:/root/.docker:z
+      # SSH directory for Linux, OSX and WSL
+      - ~/.ssh:/root/.ssh:z
+      # For Windows without WSL, a copy will be made
+      # from /tmp/.ssh to ~/.ssh to fix permissions
+      #- ~/.ssh:/tmp/.ssh:ro
+      # Shell history persistence
+      - ~/.zsh_history:/root/.zsh_history:z
+      # Git config
+      - ~/.gitconfig:/root/.gitconfig:z
+    environment:
+      - TZ=
     cap_add:
-      - SYS_PTRACE
+      # For debugging with dlv
+      # - SYS_PTRACE
+      - NET_ADMIN
     security_opt:
+      # For debugging with dlv
       - seccomp:unconfined
     entrypoint: zsh -c "while sleep 1000; do :; done"

.dockerignore

@@ -1,11 +1,9 @@
 .devcontainer
 .git
 .github
-.vscode
-cmd
-!cmd/gluetun
 doc
 docker-compose.yml
+Dockerfile
 LICENSE
 README.md
 title.svg

.github/CONTRIBUTING.md

@@ -4,26 +4,15 @@ Contributions are [released](https://help.github.com/articles/github-terms-of-se
 
 ## Submitting a pull request
 
-1. [Fork](https://github.com/qdm12/private-internet-access-docker/fork) and clone the repository
+1. [Fork](https://github.com/qdm12/gluetun/fork) and clone the repository
 1. Create a new branch `git checkout -b my-branch-name`
 1. Modify the code
-1. Ensure the docker build succeeds `docker build .`
+1. Ensure the docker build succeeds `docker build .` (you might need `export DOCKER_BUILDKIT=1`)
 1. Commit your modifications
-1. Push to your fork and [submit a pull request](https://github.com/qdm12/private-internet-access-docker/compare)
+1. Push to your fork and [submit a pull request](https://github.com/qdm12/gluetun/compare)
 
 ## Resources
 
+- [Gluetun guide on development](https://github.com/qdm12/gluetun/wiki/Development)
 - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
 - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
-
-## Contributors
-
-Thanks for all the contributions, whether small or not so small!
-
-- [@JeordyR](https://github.com/JeordyR) for testing the Mullvad version and opening a [PR with a few fixes](https://github.com/qdm12/private-internet-access-docker/pull/84/files) 👍
-- [@rorph](https://github.com/rorph) for a [PR to pick a random region for PIA](https://github.com/qdm12/private-internet-access-docker/pull/70) and a [PR to make the container work with kubernetes](https://github.com/qdm12/private-internet-access-docker/pull/69)
-- [@JesterEE](https://github.com/JesterEE) for a [PR to fix silly line endings in block lists back then](https://github.com/qdm12/private-internet-access-docker/pull/55) 📎
-- [@elmerfdz](https://github.com/elmerfdz) for a [PR to add timezone information to have correct log timestampts](https://github.com/qdm12/private-internet-access-docker/pull/51) 🕙
-- [@Juggels](https://github.com/Juggels) for a [PR to write the PIA forwarded port to a file](https://github.com/qdm12/private-internet-access-docker/pull/43)
-- [@gdlx](https://github.com/gdlx) for a [PR to fix and improve PIA port forwarding script](https://github.com/qdm12/private-internet-access-docker/pull/32)
-- [@janaz](https://github.com/janaz) for keeping an eye on [updating things in the Dockerfile](https://github.com/qdm12/private-internet-access-docker/pull/8)

.github/ISSUE_TEMPLATE/bug.md

@@ -1,55 +0,0 @@
----
-name: Bug
-about: Report a bug
-title: 'Bug: ...'
-labels: ":bug: bug"
-assignees: qdm12
-
----
-
-**TLDR**: *Describe your issue in a one liner here*
-
-1. Is this urgent?
-
-    - [ ] Yes
-    - [x] No
-
-2. What VPN service provider are you using?
-
-    - [x] PIA
-    - [ ] Mullvad
-    - [ ] Windscribe
-    - [ ] Surfshark
-    - [ ] Cyberghost
-
-3. What's the version of the program?
-
-    **See the line at the top of your logs**
-
-    `Running version latest built on 2020-03-13T01:30:06Z (commit d0f678c)`
-
-4. What are you using to run the container?
-
-    - [ ] Docker run
-    - [x] Docker Compose
-    - [ ] Kubernetes
-    - [ ] Docker stack
-    - [ ] Docker swarm
-    - [ ] Podman
-    - [ ] Other:
-
-5. Extra information
-
-Logs:
-
-```log
-
-```
-
-Configuration file:
-
-```yml
-
-```
-
-Host OS:

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,104 @@
+name: Bug
+description: Report a bug
+title: "Bug: "
+labels: [":bug: bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: dropdown
+    id: urgent
+    attributes:
+      label: Is this urgent?
+      description: Is this a critical bug, or do you need this fixed urgently?
+      options:
+        - "No"
+        - "Yes"
+  - type: input
+    id: host-os
+    attributes:
+      label: Host OS
+      description: What is your host OS?
+      placeholder: "Debian Buster"
+  - type: dropdown
+    id: cpu-arch
+    attributes:
+      label: CPU arch
+      description: You can find it on Linux with `uname -m`.
+      options:
+        - x86_64
+        - aarch64
+        - armv7l
+        - "386"
+        - s390x
+        - ppc64le
+  - type: dropdown
+    id: vpn-service-provider
+    attributes:
+      label: VPN service provider
+      options:
+        - Cyberghost
+        - ExpressVPN
+        - FastestVPN
+        - HideMyAss
+        - IPVanish
+        - IVPN
+        - Mullvad
+        - NordVPN
+        - Privado
+        - Private Internet Access
+        - PrivateVPN
+        - ProtonVPN
+        - PureVPN
+        - Surfshark
+        - TorGuard
+        - VPNUnlimited
+        - VyprVPN
+        - WeVPN
+        - Windscribe
+    validations:
+      required: true
+  - type: dropdown
+    id: docker
+    attributes:
+      label: What are you using to run the container
+      options:
+        - docker run
+        - docker-compose
+        - Portainer
+        - Kubernetes
+        - Podman
+        - Other
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      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)`.
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: "What's the problem 🤔"
+      placeholder: "That feature does not work..."
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Share your logs
+      description: No sensitive information is logged out except when running with `LOG_LEVEL=debug`.
+      render: log
+    validations:
+      required: true
+  - type: textarea
+    id: config
+    attributes:
+      label: Share your configuration
+      description: Share your configuration such as `docker-compose.yml`. Ensure to remove credentials.
+      render: yml

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+contact_links:
+  - name: Configuration help?
+    url: https://github.com/qdm12/gluetun/discussions/new
+    about: Please create a Github discussion.
+  - name: Unraid template issue
+    url: https://github.com/qdm12/gluetun/discussions/550
+    about: Please read the relevant Github discussion.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,14 +0,0 @@
----
-name: Feature request
-about: Suggest a feature to add to this project
-title: 'Feature request: ...'
-labels: ":bulb: feature request"
-assignees: qdm12
-
----
-
-1. What's the feature?
-
-2. Why do you need this feature?
-
-3. Extra information?

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,19 @@
+name: Feature request
+description: Suggest a feature to add to Gluetun
+title: "Feature request: "
+labels: [":bulb: feature request"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: "What's the feature 🧐"
+      placeholder: "Make the tunnel resistant to earth quakes"
+    validations:
+      required: true
+  - type: textarea
+    id: extra
+    attributes:
+      label: "Extra information and references"
+      placeholder: |
+        - I tried `docker run something` and it doesn't work
+        - That [url](https://github.com/qdm12/gluetun) is interesting

.github/ISSUE_TEMPLATE/help.md

@@ -1,55 +0,0 @@
----
-name: Help
-about: Ask for help
-title: 'Help: ...'
-labels: ":pray: help wanted"
-assignees:
-
----
-
-**TLDR**: *Describe your issue in a one liner here*
-
-1. Is this urgent?
-
-    - [ ] Yes
-    - [x] No
-
-2. What VPN service provider are you using?
-
-    - [x] PIA
-    - [ ] Mullvad
-    - [ ] Windscribe
-    - [ ] Surfshark
-    - [ ] Cyberghost
-
-3. What's the version of the program?
-
-    **See the line at the top of your logs**
-
-    `Running version latest built on 2020-03-13T01:30:06Z (commit d0f678c)`
-
-4. What are you using to run the container?
-
-    - [ ] Docker run
-    - [x] Docker Compose
-    - [ ] Kubernetes
-    - [ ] Docker stack
-    - [ ] Docker swarm
-    - [ ] Podman
-    - [ ] Other:
-
-5. Extra information
-
-Logs:
-
-```log
-
-```
-
-Configuration file:
-
-```yml
-
-```
-
-Host OS:

.github/ISSUE_TEMPLATE/provider.md

@@ -0,0 +1,17 @@
+---
+name: Support a VPN provider
+about: Suggest a VPN provider to be supported
+title: 'VPN provider support: NAME OF THE PROVIDER'
+labels: ":bulb: New provider"
+
+---
+
+One of the following is required:
+
+- Publicly accessible URL to a zip file containing the Openvpn configuration files
+- Publicly accessible URL to a structured (JSON etc.) list of servers **and attach** an example Openvpn configuration file for both TCP and UDP
+- Publicly accessible URL to the list of servers **and attach** an example Openvpn configuration file for both TCP and UDP
+
+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.

.github/ISSUE_TEMPLATE/wiki issue.yml

@@ -0,0 +1,18 @@
+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/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: docker
+    directory: /
+    schedule:
+      interval: "daily"
+  - package-ecosystem: gomod
+    directory: /
+    schedule:
+      interval: "daily"

.github/labels.yml

@@ -1,51 +1,99 @@
-- name: ":robot: bot"
-  color: "69cde9"
-  description: ""
-- name: ":bug: bug"
+- name: "Bug :bug:"
   color: "b60205"
   description: ""
-- name: ":game_die: dependencies"
-  color: "0366d6"
-  description: ""
-- name: ":memo: documentation"
-  color: "c5def5"
-  description: ""
-- name: ":busts_in_silhouette: duplicate"
-  color: "cccccc"
-  description: ""
-- name: ":sparkles: enhancement"
-  color: "0054ca"
-  description: ""
-- name: ":bulb: feature request"
+- name: "Feature request :bulb:"
   color: "0e8a16"
   description: ""
-- name: ":mega: feedback"
-  color: "03a9f4"
-  description: ""
-- name: ":rocket: future maybe"
-  color: "fef2c0"
-  description: ""
-- name: ":hatching_chick: good first issue"
-  color: "7057ff"
-  description: ""
-- name: ":pray: help wanted"
+- name: "Help wanted :pray:"
   color: "4caf50"
   description: ""
-- name: ":hand: hold"
-  color: "24292f"
+- name: "Documentation :memo:"
+  color: "c5def5"
   description: ""
-- name: ":no_entry_sign: invalid"
-  color: "e6e6e6"
-  description: ""
-- name: ":interrobang: maybe bug"
-  color: "ff5722"
-  description: ""
-- name: ":thinking: needs more info"
+- name: "Needs more info :thinking:"
   color: "795548"
   description: ""
-- name: ":question: question"
-  color: "3f51b5"
+
+# VPN providers
+- name: ":cloud: Cyberghost"
+  color: "cfe8d4"
   description: ""
-- name: ":coffin: wontfix"
-  color: "ffffff"
+- name: ":cloud: HideMyAss"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: IPVanish"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: IVPN"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: ExpressVPN"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: FastestVPN"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: Mullvad"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: NordVPN"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: PIA"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: Privado"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: PrivateVPN"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: ProtonVPN"
+  color: "cfe8d4"
+- name: ":cloud: PureVPN"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: Surfshark"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: Torguard"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: VPNUnlimited"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: Vyprvpn"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: WeVPN"
+  color: "cfe8d4"
+  description: ""
+- name: ":cloud: Windscribe"
+  color: "cfe8d4"
+  description: ""
+
+# Problem category
+- name: "Openvpn"
+  color: "ffc7ea"
+  description: ""
+- name: "Wireguard"
+  color: "ffc7ea"
+  description: ""
+- name: "Unbound (DNS over TLS)"
+  color: "ffc7ea"
+  description: ""
+- name: "Firewall"
+  color: "ffc7ea"
+  description: ""
+- name: "HTTP proxy"
+  color: "ffc7ea"
+  description: ""
+- name: "Shadowsocks"
+  color: "ffc7ea"
+  description: ""
+- name: "Healthcheck server"
+  color: "ffc7ea"
+  description: ""
+- name: "Control server"
+  color: "ffc7ea"
   description: ""

.github/workflows/build.yml

@@ -1,34 +0,0 @@
-name: Docker build
-on:
-  pull_request:
-    branches: [master]
-    paths-ignore:
-      - .devcontainer
-      - .github/ISSUE_TEMPLATE
-      - .github/workflows/buildx-release.yml
-      - .github/workflows/buildx-branch.yml
-      - .github/workflows/buildx-latest.yml
-      - .github/workflows/dockerhub-description.yml
-      - .github/workflows/labels.yml
-      - .github/workflows/misspell.yml
-      - .github/CODEOWNERS
-      - .github/CONTRIBUTING.md
-      - .github/FUNDING.yml
-      - .github/labels.yml
-      - .vscode
-      - cmd/ovpnparser
-      - cmd/resolver
-      - doc
-      - .gitignore
-      - docker-compose.yml
-      - LICENSE
-      - README.md
-      - title.svg
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Build image
-        run: docker build .

.github/workflows/buildx-branch.yml

@@ -1,50 +0,0 @@
-name: Buildx branch
-on:
-  push:
-    branches:
-      - '*'
-      - '*/*'
-      - '!master'
-    paths-ignore:
-      - .devcontainer
-      - .github/ISSUE_TEMPLATE
-      - .github/workflows/build.yml
-      - .github/workflows/buildx-release.yml
-      - .github/workflows/buildx-latest.yml
-      - .github/workflows/dockerhub-description.yml
-      - .github/workflows/labels.yml
-      - .github/workflows/misspell.yml
-      - .github/CODEOWNERS
-      - .github/CONTRIBUTING.md
-      - .github/FUNDING.yml
-      - .github/labels.yml
-      - .vscode
-      - cmd/ovpnparser
-      - cmd/resolver
-      - doc
-      - .gitignore
-      - docker-compose.yml
-      - LICENSE
-      - README.md
-      - title.svg
-jobs:
-  buildx:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Buildx setup
-        uses: crazy-max/ghaction-docker-buildx@v1
-      - name: Dockerhub login
-        run: echo ${{ secrets.DOCKERHUB_PASSWORD }} | docker login -u qmcgaw --password-stdin 2>&1
-      - name: Run Buildx
-        run: |
-          docker buildx build \
-            --progress plain \
-            --platform=linux/amd64 \
-            --build-arg BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` \
-            --build-arg VCS_REF=`git rev-parse --short HEAD` \
-            --build-arg VERSION=${GITHUB_REF##*/} \
-            -t qmcgaw/private-internet-access:${GITHUB_REF##*/} \
-            --push \
-            .
-      - run: curl -X POST https://hooks.microbadger.com/images/qmcgaw/private-internet-access/tQFy7AxtSUNANPe6aoVChYdsI_I= || exit 0

.github/workflows/buildx-latest.yml

@@ -1,47 +0,0 @@
-name: Buildx latest
-on:
-  push:
-    branches: [master]
-    paths-ignore:
-      - .devcontainer
-      - .github/ISSUE_TEMPLATE
-      - .github/workflows/build.yml
-      - .github/workflows/buildx-branch.yml
-      - .github/workflows/buildx-release.yml
-      - .github/workflows/dockerhub-description.yml
-      - .github/workflows/labels.yml
-      - .github/workflows/misspell.yml
-      - .github/CODEOWNERS
-      - .github/CONTRIBUTING.md
-      - .github/FUNDING.yml
-      - .github/labels.yml
-      - .vscode
-      - cmd/ovpnparser
-      - cmd/resolver
-      - doc
-      - .gitignore
-      - docker-compose.yml
-      - LICENSE
-      - README.md
-      - title.svg
-jobs:
-  buildx:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Buildx setup
-        uses: crazy-max/ghaction-docker-buildx@v1
-      - name: Dockerhub login
-        run: echo ${{ secrets.DOCKERHUB_PASSWORD }} | docker login -u qmcgaw --password-stdin 2>&1
-      - name: Run Buildx
-        run: |
-          docker buildx build \
-            --progress plain \
-            --platform=linux/amd64,linux/386,linux/arm64,linux/arm/v7,linux/arm/v6 \
-            --build-arg BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` \
-            --build-arg VCS_REF=`git rev-parse --short HEAD` \
-            --build-arg VERSION=latest \
-            -t qmcgaw/private-internet-access:latest \
-            --push \
-            .
-      - run: curl -X POST https://hooks.microbadger.com/images/qmcgaw/private-internet-access/tQFy7AxtSUNANPe6aoVChYdsI_I= || exit 0

.github/workflows/buildx-release.yml

@@ -1,47 +0,0 @@
-name: Buildx release
-on:
-  release:
-    types: [published]
-    paths-ignore:
-      - .devcontainer
-      - .github/ISSUE_TEMPLATE
-      - .github/workflows/build.yml
-      - .github/workflows/buildx-branch.yml
-      - .github/workflows/buildx-latest.yml
-      - .github/workflows/dockerhub-description.yml
-      - .github/workflows/labels.yml
-      - .github/workflows/misspell.yml
-      - .github/CODEOWNERS
-      - .github/CONTRIBUTING.md
-      - .github/FUNDING.yml
-      - .github/labels.yml
-      - .vscode
-      - cmd/ovpnparser
-      - cmd/resolver
-      - doc
-      - .gitignore
-      - docker-compose.yml
-      - LICENSE
-      - README.md
-      - title.svg
-jobs:
-  buildx:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Buildx setup
-        uses: crazy-max/ghaction-docker-buildx@v1
-      - name: Dockerhub login
-        run: echo ${{ secrets.DOCKERHUB_PASSWORD }} | docker login -u qmcgaw --password-stdin 2>&1
-      - name: Run Buildx
-        run: |
-          docker buildx build \
-            --progress plain \
-            --platform=linux/amd64,linux/386,linux/arm64,linux/arm/v7,linux/arm/v6 \
-            --build-arg BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` \
-            --build-arg VCS_REF=`git rev-parse --short HEAD` \
-            --build-arg VERSION=${GITHUB_REF##*/} \
-            -t qmcgaw/private-internet-access:${GITHUB_REF##*/} \
-            --push \
-            .
-      - run: curl -X POST https://hooks.microbadger.com/images/qmcgaw/private-internet-access/tQFy7AxtSUNANPe6aoVChYdsI_I= || exit 0

.github/workflows/ci.yml

@@ -0,0 +1,99 @@
+name: CI
+on:
+  push:
+    paths:
+      - .github/workflows/ci.yml
+      - cmd/**
+      - internal/**
+      - pkg/**
+      - .dockerignore
+      - .golangci.yml
+      - Dockerfile
+      - go.mod
+      - go.sum
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    env:
+      DOCKER_BUILDKIT: "1"
+    steps:
+      - uses: actions/checkout@v2.3.4
+
+      - name: Linting
+        run: docker build --target lint .
+
+      - name: Go mod tidy check
+        run: docker build --target tidy .
+
+      - name: Build test image
+        run: docker build --target test -t test-container .
+
+      - name: Run tests in test container
+        run: |
+          touch coverage.txt
+          docker run --rm \
+          -v "$(pwd)/coverage.txt:/tmp/gobuild/coverage.txt" \
+          test-container
+
+      - name: Code security analysis
+        uses: snyk/actions/golang@master
+        env:
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+
+      - name: Build final image
+        run: docker build -t final-image .
+
+      - name: Image security analysis
+        uses: snyk/actions/docker@master
+        env:
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+        with:
+          image: final-image
+
+  publish:
+    needs: [verify]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.3.4
+
+      - uses: docker/setup-qemu-action@v1
+      - uses: docker/setup-buildx-action@v1
+
+      - uses: docker/login-action@v1
+        with:
+          username: qmcgaw
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Set variables
+        id: vars
+        env:
+          EVENT_NAME: ${{ github.event_name }}
+        run: |
+          BRANCH=${GITHUB_REF#refs/heads/}
+          TAG=${GITHUB_REF#refs/tags/}
+          echo ::set-output name=commit::$(git rev-parse --short HEAD)
+          echo ::set-output name=created::$(date -u +%Y-%m-%dT%H:%M:%SZ)
+          if [ "$TAG" != "$GITHUB_REF" ]; then
+            echo ::set-output name=version::$TAG
+            echo ::set-output name=platforms::linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/ppc64le
+          elif [ "$BRANCH" = "master" ]; then
+            echo ::set-output name=version::latest
+            echo ::set-output name=platforms::linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/ppc64le
+          else
+            echo ::set-output name=version::$BRANCH
+            echo ::set-output name=platforms::linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/ppc64le
+          fi
+
+      - name: Build and push final image
+        uses: docker/build-push-action@v2.6.1
+        with:
+          platforms: ${{ steps.vars.outputs.platforms }}
+          build-args: |
+            CREATED=${{ steps.vars.outputs.created }}
+            COMMIT=${{ steps.vars.outputs.commit }}
+            VERSION=${{ steps.vars.outputs.version }}
+          tags: |
+            qmcgaw/gluetun:${{ steps.vars.outputs.version }}
+            qmcgaw/private-internet-access:${{ steps.vars.outputs.version }}
+          push: true

.github/workflows/dockerhub-description.yml

@@ -10,10 +10,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v2.3.4
       - name: Docker Hub Description
-        uses: peter-evans/dockerhub-description@v2.1.0
-        env:
-          DOCKERHUB_USERNAME: qmcgaw
-          DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
-          DOCKERHUB_REPOSITORY: qmcgaw/private-internet-access
+        uses: peter-evans/dockerhub-description@v2
+        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

@@ -1,18 +1,15 @@
 name: labels
 on:
   push:
-    branches: ["master"]
+    branches: [master]
     paths:
-      - '.github/labels.yml'
-      - '.github/workflows/labels.yml'
+      - .github/labels.yml
+      - .github/workflows/labels.yml
 jobs:
   labeler:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Labeler
-        if: success()
-        uses: crazy-max/ghaction-github-labeler@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v2.3.4
+      - uses: crazy-max/ghaction-github-labeler@v3
+        with:
+          yaml-file: .github/labels.yml

.github/workflows/misspell.yml

@@ -8,9 +8,8 @@ jobs:
   misspell:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: reviewdog/action-misspell@master
+      - uses: actions/checkout@v2.3.4
+      - uses: reviewdog/action-misspell@v1
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
           locale: "US"
           level: error

.gitignore

@@ -0,0 +1 @@
+scratch.txt

.golangci.yml

@@ -1,50 +1,87 @@
 linters-settings:
-  maligned:
-    suggest-new: true
   misspell:
     locale: US
 
+issues:
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - dupl
+        - maligned
+        - goerr113
+    - path: internal/server/
+      linters:
+        - dupl
+    - path: internal/configuration/
+      linters:
+        - dupl
+    - path: internal/constants/
+      linters:
+        - dupl
+    - text: "exported: exported var Err*"
+      linters:
+        - revive
+    - text: "mnd: Magic number: 0644*"
+      linters:
+        - gomnd
+    - text: "mnd: Magic number: 0400*"
+      linters:
+        - gomnd
 linters:
-  disable-all: true
   enable:
+    # - cyclop
+    # - errorlint
+    # - wrapcheck
+    - asciicheck
     - bodyclose
-    - deadcode
     - dogsled
     - dupl
-    - errcheck
+    - durationcheck
+    - errname
+    - exhaustive
+    - exportloopref
+    - forcetypeassert
+    - gci
     - gochecknoglobals
     - gochecknoinits
     - gocognit
     - goconst
     - gocritic
     - gocyclo
+    - godot
+    - goerr113
+    - goheader
     - goimports
-    - golint
+    - gomnd
+    - gomoddirectives
+    - goprintffuncname
     - gosec
-    - gosimple
-    - govet
-    - ineffassign
-    - interfacer
-    - maligned
+    - importas
+    - importas
+    - lll
+    - makezero
     - misspell
     - nakedret
+    - nestif
+    - nilerr
+    - noctx
+    - nolintlint
     - prealloc
+    - predeclared
+    - predeclared
+    - promlinter
+    - revive
     - rowserrcheck
-    - scopelint
-    - staticcheck
-    - structcheck
-    - typecheck
+    - sqlclosecheck
+    - thelper
+    - tparallel
     - unconvert
     - unparam
-    - unused
-    - varcheck
+    - wastedassign
     - whitespace
 
 run:
   skip-dirs:
     - .devcontainer
     - .github
-    - postgres
-
-service:
-  golangci-lint-version: 1.27.x # use the fixed version to not introduce new linters unexpectedly
+    - doc

.vscode/extensions.json

@@ -1,9 +0,0 @@
-{
-    "recommendations": [
-        "shardulm94.trailing-spaces",
-        "ms-azuretools.vscode-docker",
-        "davidanson.vscode-markdownlint",
-        "IBM.output-colorizer",
-        "golang.go"
-    ]
-}

.vscode/settings.json

@@ -1,91 +0,0 @@
-{
-    // General settings
-    "files.eol": "\n",
-    // Docker
-    "remote.extensionKind": {
-        "ms-azuretools.vscode-docker": "workspace"
-    },
-    // Golang general settings
-    "go.useLanguageServer": true,
-    "go.autocompleteUnimportedPackages": true,
-    "go.gotoSymbol.includeImports": true,
-    "go.gotoSymbol.includeGoroot": true,
-    "gopls": {
-        "completeUnimported": true,
-        "deepCompletion": true,
-        "usePlaceholders": false
-    },
-    "go.lintTool": "golangci-lint",
-    "go.lintFlags": [
-        "--fast",
-        "--enable",
-        "rowserrcheck",
-        "--enable",
-        "bodyclose",
-        "--enable",
-        "dogsled",
-        "--enable",
-        "dupl",
-        "--enable",
-        "gochecknoglobals",
-        "--enable",
-        "gochecknoinits",
-        "--enable",
-        "gocognit",
-        "--enable",
-        "goconst",
-        "--enable",
-        "gocritic",
-        "--enable",
-        "gocyclo",
-        "--enable",
-        "goimports",
-        "--enable",
-        "golint",
-        "--enable",
-        "gosec",
-        "--enable",
-        "interfacer",
-        "--enable",
-        "maligned",
-        "--enable",
-        "misspell",
-        "--enable",
-        "nakedret",
-        "--enable",
-        "prealloc",
-        "--enable",
-        "scopelint",
-        "--enable",
-        "unconvert",
-        "--enable",
-        "unparam",
-        "--enable",
-        "whitespace"
-    ],
-    // Golang on save
-    "go.buildOnSave": "workspace",
-    "go.lintOnSave": "workspace",
-    "go.vetOnSave": "workspace",
-    "editor.formatOnSave": true,
-    "[go]": {
-        "editor.codeActionsOnSave": {
-            "source.organizeImports": true
-        }
-    },
-    // Golang testing
-    "go.toolsEnvVars": {
-        "GOFLAGS": "-tags="
-    },
-    "gopls.env": {
-        "GOFLAGS": "-tags="
-    },
-    "go.testEnvVars": {},
-    "go.testFlags": [
-        "-v",
-        // "-race"
-    ],
-    "go.testTimeout": "600s",
-    "go.coverOnSingleTestFile": true,
-    "go.coverOnSingleTest": true
-}

Dockerfile

@@ -1,110 +1,186 @@
-ARG ALPINE_VERSION=3.12
-ARG GO_VERSION=1.14
-
-FROM golang:${GO_VERSION}-alpine${ALPINE_VERSION} AS builder
-RUN apk --update add git
-ENV CGO_ENABLED=0
-ARG GOLANGCI_LINT_VERSION=v1.27.0
-RUN wget -O- -nv https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s ${GOLANGCI_LINT_VERSION}
-WORKDIR /tmp/gobuild
-COPY .golangci.yml .
-COPY go.mod go.sum ./
-RUN go mod download 2>&1
-COPY cmd/gluetun/main.go .
-COPY internal/ ./internal/
-RUN go test ./...
-RUN golangci-lint run --timeout=10m
-RUN go build -ldflags="-s -w" -o entrypoint main.go
-
-FROM alpine:${ALPINE_VERSION}
-ARG VERSION
-ARG BUILD_DATE
-ARG VCS_REF
-ENV VERSION=$VERSION \
-    BUILD_DATE=$BUILD_DATE \
-    VCS_REF=$VCS_REF
-LABEL \
-    org.opencontainers.image.authors="quentin.mcgaw@gmail.com" \
-    org.opencontainers.image.created=$BUILD_DATE \
-    org.opencontainers.image.version=$VERSION \
-    org.opencontainers.image.revision=$VCS_REF \
-    org.opencontainers.image.url="https://github.com/qdm12/private-internet-access-docker" \
-    org.opencontainers.image.documentation="https://github.com/qdm12/private-internet-access-docker" \
-    org.opencontainers.image.source="https://github.com/qdm12/private-internet-access-docker" \
-    org.opencontainers.image.title="VPN client for PIA, Mullvad, Windscribe, Surfshark and Cyberghost" \
-    org.opencontainers.image.description="VPN client to tunnel to PIA, Mullvad, Windscribe, Surfshark and Cyberghost servers using OpenVPN, IPtables, DNS over TLS and Alpine Linux"
-ENV VPNSP=pia \
-    PROTOCOL=udp \
-    OPENVPN_VERBOSITY=1 \
-    OPENVPN_ROOT=no \
-    OPENVPN_TARGET_IP= \
-    TZ= \
-    UID=1000 \
-    GID=1000 \
-    IP_STATUS_FILE="/ip" \
-    # PIA, Windscribe, Surfshark, Cyberghost, Vyprvpn, NordVPN, PureVPN only
-    USER= \
-    PASSWORD= \
-    REGION= \
-    # PIA only
-    PIA_ENCRYPTION=strong \
-    PORT_FORWARDING=off \
-    PORT_FORWARDING_STATUS_FILE="/forwarded_port" \
-    # Mullvad and PureVPN only
-    COUNTRY= \
-    CITY= \
-    # Mullvad only
-    ISP= \
-    # Mullvad and Windscribe only
-    PORT= \
-    # Cyberghost only
-    CYBERGHOST_GROUP="Premium UDP Europe" \
-    # NordVPN only
-    SERVER_NUMBER= \
-    # Openvpn
-    OPENVPN_CIPHER= \
-    OPENVPN_AUTH= \
-    # DNS over TLS
-    DOT=on \
-    DOT_PROVIDERS=cloudflare \
-    DOT_PRIVATE_ADDRESS=127.0.0.1/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,169.254.0.0/16,::1/128,fc00::/7,fe80::/10,::ffff:0:0/96 \
-    DOT_VERBOSITY=1 \
-    DOT_VERBOSITY_DETAILS=0 \
-    DOT_VALIDATION_LOGLEVEL=0 \
-    DOT_CACHING=on \
-    DOT_IPV6=off \
-    BLOCK_MALICIOUS=on \
-    BLOCK_SURVEILLANCE=off \
-    BLOCK_ADS=off \
-    UNBLOCK= \
-    DNS_UPDATE_PERIOD=24h \
-    DNS_PLAINTEXT_ADDRESS=1.1.1.1 \
-    DNS_KEEP_NAMESERVER=off \
-    # Firewall
-    FIREWALL=on \
-    EXTRA_SUBNETS= \
-    FIREWALL_VPN_INPUT_PORTS= \
-    FIREWALL_DEBUG=off \
-    # Tinyproxy
-    TINYPROXY=off \
-    TINYPROXY_LOG=Info \
-    TINYPROXY_PORT=8888 \
-    TINYPROXY_USER= \
-    TINYPROXY_PASSWORD= \
-    # Shadowsocks
-    SHADOWSOCKS=off \
-    SHADOWSOCKS_LOG=off \
-    SHADOWSOCKS_PORT=8388 \
-    SHADOWSOCKS_PASSWORD= \
-    SHADOWSOCKS_METHOD=chacha20-ietf-poly1305
-ENTRYPOINT ["/entrypoint"]
-EXPOSE 8000/tcp 8888/tcp 8388/tcp 8388/udp
-HEALTHCHECK --interval=10m --timeout=10s --start-period=30s --retries=2 CMD /entrypoint healthcheck
-RUN apk add -q --progress --no-cache --update openvpn ca-certificates iptables ip6tables unbound tinyproxy tzdata && \
-    echo "http://nl.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories && \
-    apk add -q --progress --no-cache --update shadowsocks-libev && \
-    rm -rf /var/cache/apk/* /etc/unbound/* /usr/sbin/unbound-* /etc/tinyproxy/tinyproxy.conf && \
-    deluser openvpn && \
-    deluser tinyproxy && \
-    deluser unbound
-COPY --from=builder /tmp/gobuild/entrypoint /entrypoint
+ARG ALPINE_VERSION=3.14
+ARG GO_ALPINE_VERSION=3.14
+ARG GO_VERSION=1.17
+ARG XCPUTRANSLATE_VERSION=v0.6.0
+ARG GOLANGCI_LINT_VERSION=v1.42.1
+ARG BUILDPLATFORM=linux/amd64
+
+FROM --platform=${BUILDPLATFORM} qmcgaw/xcputranslate:${XCPUTRANSLATE_VERSION} AS xcputranslate
+FROM --platform=${BUILDPLATFORM} qmcgaw/binpot:golangci-lint-${GOLANGCI_LINT_VERSION} AS golangci-lint
+
+FROM --platform=${BUILDPLATFORM} golang:${GO_VERSION}-alpine${GO_ALPINE_VERSION} AS base
+COPY --from=xcputranslate /xcputranslate /usr/local/bin/xcputranslate
+RUN apk --update add git g++
+ENV CGO_ENABLED=0
+COPY --from=golangci-lint /bin /go/bin/golangci-lint
+WORKDIR /tmp/gobuild
+COPY go.mod go.sum ./
+RUN go mod download
+COPY cmd/ ./cmd/
+COPY internal/ ./internal/
+
+FROM --platform=${BUILDPLATFORM} base AS test
+# Note on the go race detector:
+# - we set CGO_ENABLED=1 to have it enabled
+# - we installed g++ to support the race detector
+ENV CGO_ENABLED=1
+ENTRYPOINT go test -race -coverpkg=./... -coverprofile=coverage.txt -covermode=atomic ./...
+
+FROM --platform=${BUILDPLATFORM} base AS lint
+COPY .golangci.yml ./
+RUN golangci-lint run --timeout=10m
+
+FROM --platform=${BUILDPLATFORM} base AS tidy
+RUN git init && \
+    git config user.email ci@localhost && \
+    git config user.name ci && \
+    git add -A && git commit -m ci && \
+    sed -i '/\/\/ indirect/d' go.mod && \
+    go mod tidy && \
+    git diff --exit-code -- go.mod
+
+FROM --platform=${BUILDPLATFORM} base AS build
+ARG TARGETPLATFORM
+ARG VERSION=unknown
+ARG CREATED="an unknown date"
+ARG COMMIT=unknown
+RUN GOARCH="$(xcputranslate translate -field arch -targetplatform ${TARGETPLATFORM})" \
+    GOARM="$(xcputranslate translate -field arm -targetplatform ${TARGETPLATFORM})" \
+    go build -trimpath -ldflags="-s -w \
+    -X 'main.version=$VERSION' \
+    -X 'main.created=$CREATED' \
+    -X 'main.commit=$COMMIT' \
+    " -o entrypoint cmd/gluetun/main.go
+
+FROM alpine:${ALPINE_VERSION}
+ARG VERSION=unknown
+ARG CREATED="an unknown date"
+ARG COMMIT=unknown
+LABEL \
+    org.opencontainers.image.authors="quentin.mcgaw@gmail.com" \
+    org.opencontainers.image.created=$CREATED \
+    org.opencontainers.image.version=$VERSION \
+    org.opencontainers.image.revision=$COMMIT \
+    org.opencontainers.image.url="https://github.com/qdm12/gluetun" \
+    org.opencontainers.image.documentation="https://github.com/qdm12/gluetun" \
+    org.opencontainers.image.source="https://github.com/qdm12/gluetun" \
+    org.opencontainers.image.title="VPN swiss-knife like client for multiple VPN providers" \
+    org.opencontainers.image.description="VPN swiss-knife like client to tunnel to multiple VPN servers using OpenVPN, IPtables, DNS over TLS, Shadowsocks, an HTTP proxy and Alpine Linux"
+ENV VPNSP=pia \
+    VPN_TYPE=openvpn \
+    # OpenVPN
+    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_VERBOSITY=1 \
+    OPENVPN_FLAGS= \
+    OPENVPN_CIPHER= \
+    OPENVPN_AUTH= \
+    OPENVPN_ROOT=yes \
+    OPENVPN_TARGET_IP= \
+    OPENVPN_IPV6=off \
+    OPENVPN_CUSTOM_CONFIG= \
+    OPENVPN_INTERFACE=tun0 \
+    OPENVPN_PORT= \
+    # Wireguard
+    WIREGUARD_PRIVATE_KEY= \
+    WIREGUARD_PRESHARED_KEY= \
+    WIREGUARD_PUBLIC_KEY= \
+    WIREGUARD_ADDRESS= \
+    WIREGUARD_ENDPOINT_IP= \
+    WIREGUARD_ENDPOINT_PORT= \
+    WIREGUARD_INTERFACE=wg0 \
+    # VPN server filtering
+    REGION= \
+    COUNTRY= \
+    CITY= \
+    SERVER_HOSTNAME= \
+    # # Mullvad only:
+    ISP= \
+    OWNED=no \
+    # # Private Internet Access only:
+    PIA_ENCRYPTION=strong \
+    PORT_FORWARDING=off \
+    PORT_FORWARDING_STATUS_FILE="/tmp/gluetun/forwarded_port" \
+    # # Cyberghost only:
+    OPENVPN_CLIENTCRT_SECRETFILE=/run/secrets/openvpn_clientcrt \
+    OPENVPN_CLIENTKEY_SECRETFILE=/run/secrets/openvpn_clientkey \
+    # # Nordvpn only:
+    SERVER_NUMBER= \
+    # # PIA and ProtonVPN only:
+    SERVER_NAME= \
+    # # ProtonVPN only:
+    FREE_ONLY= \
+    # # Surfshark only:
+    MULTIHOP_ONLY= \
+    # Firewall
+    FIREWALL=on \
+    FIREWALL_VPN_INPUT_PORTS= \
+    FIREWALL_INPUT_PORTS= \
+    FIREWALL_OUTBOUND_SUBNETS= \
+    FIREWALL_DEBUG=off \
+    # Logging
+    LOG_LEVEL=info \
+    # Health
+    HEALTH_SERVER_ADDRESS=127.0.0.1:9999 \
+    HEALTH_ADDRESS_TO_PING=github.com \
+    HEALTH_VPN_DURATION_INITIAL=6s \
+    HEALTH_VPN_DURATION_ADDITION=5s \
+    # DNS over TLS
+    DOT=on \
+    DOT_PROVIDERS=cloudflare \
+    DOT_PRIVATE_ADDRESS=127.0.0.1/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,169.254.0.0/16,::1/128,fc00::/7,fe80::/10,::ffff:7f00:1/104,::ffff:a00:0/104,::ffff:a9fe:0/112,::ffff:ac10:0/108,::ffff:c0a8:0/112 \
+    DOT_VERBOSITY=1 \
+    DOT_VERBOSITY_DETAILS=0 \
+    DOT_VALIDATION_LOGLEVEL=0 \
+    DOT_CACHING=on \
+    DOT_IPV6=off \
+    BLOCK_MALICIOUS=on \
+    BLOCK_SURVEILLANCE=off \
+    BLOCK_ADS=off \
+    UNBLOCK= \
+    DNS_UPDATE_PERIOD=24h \
+    DNS_PLAINTEXT_ADDRESS=1.1.1.1 \
+    DNS_KEEP_NAMESERVER=off \
+    # HTTP proxy
+    HTTPPROXY= \
+    HTTPPROXY_LOG=off \
+    HTTPPROXY_PORT=8888 \
+    HTTPPROXY_USER= \
+    HTTPPROXY_PASSWORD= \
+    HTTPPROXY_USER_SECRETFILE=/run/secrets/httpproxy_user \
+    HTTPPROXY_PASSWORD_SECRETFILE=/run/secrets/httpproxy_password \
+    # Shadowsocks
+    SHADOWSOCKS=off \
+    SHADOWSOCKS_LOG=off \
+    SHADOWSOCKS_ADDRESS=":8388" \
+    SHADOWSOCKS_PASSWORD= \
+    SHADOWSOCKS_PASSWORD_SECRETFILE=/run/secrets/shadowsocks_password \
+    SHADOWSOCKS_CIPHER=chacha20-ietf-poly1305 \
+    # Server data updater
+    UPDATER_PERIOD=0 \
+    # Public IP
+    PUBLICIP_FILE="/tmp/gluetun/ip" \
+    PUBLICIP_PERIOD=12h \
+    # Extras
+    VERSION_INFORMATION=on \
+    TZ= \
+    PUID= \
+    PGID=
+ENTRYPOINT ["/entrypoint"]
+EXPOSE 8000/tcp 8888/tcp 8388/tcp 8388/udp
+HEALTHCHECK --interval=5s --timeout=5s --start-period=10s --retries=1 CMD /entrypoint healthcheck
+ARG TARGETPLATFORM
+RUN apk add --no-cache --update -l apk-tools && \
+    apk add --no-cache --update -X "https://dl-cdn.alpinelinux.org/alpine/v3.12/main" openvpn==2.4.11-r0 && \
+    mv /usr/sbin/openvpn /usr/sbin/openvpn2.4 && \
+    apk del openvpn && \
+    apk add --no-cache --update openvpn ca-certificates iptables ip6tables unbound tzdata && \
+    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 && \
+    mkdir /gluetun
+COPY --from=build /tmp/gobuild/entrypoint /entrypoint

README.md

@@ -1,378 +1,125 @@
 # Gluetun VPN client
 
-*Lightweight swiss-knife-like VPN client to tunnel to Private Internet Access,
-Mullvad, Windscribe, Surfshark Cyberghost, VyprVPN, NordVPN and PureVPN VPN servers, using Go, OpenVPN,
-iptables, DNS over TLS, ShadowSocks and Tinyproxy*
+*Lightweight swiss-knife-like VPN client to tunnel to Cyberghost, ExpressVPN, FastestVPN,
+HideMyAss, IPVanish, IVPN, Mullvad, NordVPN, Privado, Private Internet Access, PrivateVPN,
+ProtonVPN, PureVPN, Surfshark, TorGuard, VPNUnlimited, VyprVPN, WeVPN and Windscribe VPN servers
+using Go, OpenVPN or Wireguard, iptables, DNS over TLS, ShadowSocks and an HTTP proxy*
 
-**ANNOUNCEMENT**: *[Video of the Git history of Gluetun](https://youtu.be/khipOYJtGJ0)*
+**ANNOUNCEMENT**: Wireguard is now supported for all providers supporting it!
 
-<img height="250" src="https://raw.githubusercontent.com/qdm12/private-internet-access-docker/master/title.svg?sanitize=true">
+![Title image](https://raw.githubusercontent.com/qdm12/gluetun/master/title.svg)
 
-[![Build status](https://github.com/qdm12/private-internet-access-docker/workflows/Buildx%20latest/badge.svg)](https://github.com/qdm12/private-internet-access-docker/actions?query=workflow%3A%22Buildx+latest%22)
-[![Docker Pulls](https://img.shields.io/docker/pulls/qmcgaw/private-internet-access.svg)](https://hub.docker.com/r/qmcgaw/private-internet-access)
-[![Docker Stars](https://img.shields.io/docker/stars/qmcgaw/private-internet-access.svg)](https://hub.docker.com/r/qmcgaw/private-internet-access)
+[![Build status](https://github.com/qdm12/gluetun/actions/workflows/ci.yml/badge.svg)](https://github.com/qdm12/gluetun/actions/workflows/ci.yml)
 
-[![GitHub last commit](https://img.shields.io/github/last-commit/qdm12/private-internet-access-docker.svg)](https://github.com/qdm12/private-internet-access-docker/issues)
-[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/qdm12/private-internet-access-docker.svg)](https://github.com/qdm12/private-internet-access-docker/issues)
-[![GitHub issues](https://img.shields.io/github/issues/qdm12/private-internet-access-docker.svg)](https://github.com/qdm12/private-internet-access-docker/issues)
+[![Docker pulls qmcgaw/gluetun](https://img.shields.io/docker/pulls/qmcgaw/gluetun.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
+[![Docker pulls qmcgaw/private-internet-access](https://img.shields.io/docker/pulls/qmcgaw/private-internet-access.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
 
-[![Image size](https://images.microbadger.com/badges/image/qmcgaw/private-internet-access.svg)](https://microbadger.com/images/qmcgaw/private-internet-access)
-[![Image version](https://images.microbadger.com/badges/version/qmcgaw/private-internet-access.svg)](https://microbadger.com/images/qmcgaw/private-internet-access)
-[![Join Slack channel](https://img.shields.io/badge/slack-@qdm12-yellow.svg?logo=slack)](https://join.slack.com/t/qdm12/shared_invite/enQtOTE0NjcxNTM1ODc5LTYyZmVlOTM3MGI4ZWU0YmJkMjUxNmQ4ODQ2OTAwYzMxMTlhY2Q1MWQyOWUyNjc2ODliNjFjMDUxNWNmNzk5MDk)
+[![Docker stars qmcgaw/gluetun](https://img.shields.io/docker/stars/qmcgaw/gluetun.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
+[![Docker stars qmcgaw/private-internet-access](https://img.shields.io/docker/stars/qmcgaw/private-internet-access.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
+
+![Last release](https://img.shields.io/github/release/qdm12/gluetun?label=Last%20release)
+![Last Docker tag](https://img.shields.io/docker/v/qmcgaw/gluetun?sort=semver&label=Last%20Docker%20tag)
+[![Last release size](https://img.shields.io/docker/image-size/qmcgaw/gluetun?sort=semver&label=Last%20released%20image)](https://hub.docker.com/r/qmcgaw/gluetun/tags?page=1&ordering=last_updated)
+![GitHub last release date](https://img.shields.io/github/release-date/qdm12/gluetun?label=Last%20release%20date)
+![Commits since release](https://img.shields.io/github/commits-since/qdm12/gluetun/latest?sort=semver)
+
+[![Latest size](https://img.shields.io/docker/image-size/qmcgaw/gluetun/latest?label=Latest%20image)](https://hub.docker.com/r/qmcgaw/gluetun/tags)
+
+[![GitHub last commit](https://img.shields.io/github/last-commit/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/commits/master)
+[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/graphs/contributors)
+[![GitHub closed PRs](https://img.shields.io/github/issues-pr-closed/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/pulls?q=is%3Apr+is%3Aclosed)
+[![GitHub issues](https://img.shields.io/github/issues/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/issues)
+[![GitHub closed issues](https://img.shields.io/github/issues-closed/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/issues?q=is%3Aissue+is%3Aclosed)
+
+[![Lines of code](https://img.shields.io/tokei/lines/github/qdm12/gluetun)](https://github.com/qdm12/gluetun)
+![Code size](https://img.shields.io/github/languages/code-size/qdm12/gluetun)
+![GitHub repo size](https://img.shields.io/github/repo-size/qdm12/gluetun)
+![Go version](https://img.shields.io/github/go-mod/go-version/qdm12/gluetun)
+
+![Visitors count](https://visitor-badge.laobi.icu/badge?page_id=gluetun.readme)
+
+## Quick links
+
+- [Setup](#Setup)
+- [Features](#Features)
+- Problem?
+  - [Check the Wiki](https://github.com/qdm12/gluetun/wiki)
+  - [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)
+- Video:
+
+  [![Video Gif](https://i.imgur.com/CetWunc.gif)](https://youtu.be/0F6I03LQcI4)
+
+- [Substack Console interview](https://console.substack.com/p/console-72)
 
 ## Features
 
-- Based on Alpine 3.12 for a small Docker image of 52MB
-- Supports **Private Internet Access**, **Mullvad**, **Windscribe**, **Surfshark**, **Cyberghost**, **Vyprvpn**, **NordVPN** and **PureVPN** servers
-- Supports Openvpn only for now
+- Based on Alpine 3.14 for a small Docker image of 31MB
+- Supports: **Cyberghost**, **ExpressVPN**, **FastestVPN**, **HideMyAss**, **IPVanish**, **IVPN**, **Mullvad**, **NordVPN**, **Privado**, **Private Internet Access**, **PrivateVPN**, **ProtonVPN**, **PureVPN**,  **Surfshark**, **TorGuard**, **VPNUnlimited**, **Vyprvpn**, **WeVPN**, **Windscribe** servers
+- Supports OpenVPN for all providers listed
+- Supports Wireguard
+  - For **Mullvad**, **Ivpn** and **Windscribe**
+  - For **Torguard**, **VPN Unlimited** and **WeVPN** using [the custom provider](https://github.com/qdm12/gluetun/wiki/Environment-variables#custom)
+  - For custom Wireguard configurations using [the custom provider](https://github.com/qdm12/gluetun/wiki/Environment-variables#custom)
+  - 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 SOCKS5 proxy (Shadowsocks, tunnels TCP+UDP)
-- Built in HTTP proxy (Tinyproxy, tunnels TCP)
-- [Connect other containers to it](https://github.com/qdm12/private-internet-access-docker#connect-to-it)
-- [Connect LAN devices to it](https://github.com/qdm12/private-internet-access-docker#connect-to-it)
-- Compatible with amd64, i686 (32 bit), **ARM** 64 bit, ARM 32 bit v6 and v7 🎆
-- VPN server side port forwarding for Private Internet Access and Vyprvpn
+- Built in Shadowsocks proxy (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 LAN devices to it](https://github.com/qdm12/gluetun/wiki/Connect-a-LAN-device-to-gluetun)
+- 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)
 - Possibility of split horizon DNS by selecting multiple DNS over TLS providers
-- Subprograms all drop root privileges once launched
-- Subprograms output streams are all merged together
+- Unbound subprogram drops root privileges once launched
 - Can work as a Kubernetes sidecar container, thanks @rorph
 
 ## Setup
 
-1. Requirements
-    - A VPN account with one of the service providers supported
-    - If you have a host or router firewall, please refer [to the firewall documentation](https://github.com/qdm12/private-internet-access-docker/blob/master/doc/firewall.md)
-1. On some devices you may need to setup your tunnel kernel module on your host with `insmod /lib/modules/tun.ko` or `modprobe tun`
-    - *Synology users*: please read [this part of the Wiki](https://github.com/qdm12/private-internet-access-docker/wiki/Common-issues#synology)
-1. Launch the container with:
+🎉 There are now instructions specific to each VPN provider with examples to help you get started as quickly as possible!
 
-    ```bash
-    docker run -d --name gluetun --cap-add=NET_ADMIN \
-    -e REGION="CA Montreal" -e USER=js89ds7 -e PASSWORD=8fd9s239G \
-    qmcgaw/private-internet-access
-    ```
+Go to the [Wiki](https://github.com/qdm12/gluetun/wiki)!
 
-    or use [docker-compose.yml](https://github.com/qdm12/private-internet-access-docker/blob/master/docker-compose.yml) with:
+[🐛 Found a bug in the Wiki?!](https://github.com/qdm12/gluetun/issues/new?assignees=&labels=%F0%9F%93%84+Wiki+issue&template=wiki+issue.md&title=Wiki+issue%3A+)
 
-    ```bash
-    docker-compose up -d
-    ```
+Here's a docker-compose.yml for the laziest:
 
-    Note that you can:
-
-    - Change the many [environment variables](#environment-variables) available
-    - Use `-p 8888:8888/tcp` to access the HTTP web proxy (and put your LAN in `EXTRA_SUBNETS` environment variable, in example `192.168.1.0/24`)
-    - Use `-p 8388:8388/tcp -p 8388:8388/udp` to access the SOCKS5 proxy (and put your LAN in `EXTRA_SUBNETS` environment variable, in example `192.168.1.0/24`)
-    - Use `-p 8000:8000/tcp` to access the [HTTP control server](#HTTP-control-server) built-in
-
-    **If you encounter an issue with the tun device not being available, see [the FAQ](https://github.com/qdm12/private-internet-access-docker/blob/master/doc/faq.md#how-to-fix-openvpn-failing-to-start)**
-
-1. You can update the image with `docker pull qmcgaw/private-internet-access:latest`. See the [wiki](https://github.com/qdm12/private-internet-access-docker/wiki/Common-issues#use-a-release-tag) for more information on other tags available.
-
-## Testing
-
-Check the VPN IP address matches your expectations
-
-```sh
-docker run --rm --network=container:gluetun alpine:3.12 wget -qO- https://ipinfo.io
+```yml
+version: "3"
+services:
+  gluetun:
+    image: qmcgaw/gluetun
+    cap_add:
+      - NET_ADMIN
+    ports:
+      - 8888:8888/tcp # HTTP proxy
+      - 8388:8388/tcp # Shadowsocks
+      - 8388:8388/udp # Shadowsocks
+    volumes:
+      - /yourpath:/gluetun
+    environment:
+      # See https://github.com/qdm12/gluetun/wiki
+      - VPNSP=ivpn
+      - VPN_TYPE=openvpn
+      # OpenVPN:
+      - OPENVPN_USER=
+      - OPENVPN_PASSWORD=
+      # Wireguard:
+      # - WIREGUARD_PRIVATE_KEY=wOEI9rqqbDwnN8/Bpp22sVz48T71vJ4fYmFWujulwUU=
+      # - WIREGUARD_ADDRESS=10.64.222.21/32
+      # Timezone for accurate log times
+      - TZ=
 ```
 
-Want more testing? ▶ [see the Wiki](https://github.com/qdm12/private-internet-access-docker/wiki/Testing)
-
-## Environment variables
-
-**TLDR**; only set the 🏁 marked environment variables to get started.
-
-### VPN
-
-| Variable | Default | Choices | Description |
-| --- | --- | --- | --- |
-| 🏁 `VPNSP` | `private internet access` | `private internet access`, `mullvad`, `windscribe`, `surfshark`, `vyprvpn`, `nordvpn`, `purevpn` | VPN Service Provider |
-| `IP_STATUS_FILE` | `/ip` | Any filepath | Filepath to store the public IP address assigned |
-| `PROTOCOL` | `udp` | `udp` or `tcp` | Network protocol to use |
-| `OPENVPN_VERBOSITY` | `1` | `0` to `6` | Openvpn verbosity level |
-| `OPENVPN_ROOT` | `no` | `yes` or `no` | Run OpenVPN as root |
-| `OPENVPN_TARGET_IP` | | Valid IP address | Specify a target VPN server (or gateway) IP address to use |
-| `OPENVPN_CIPHER` | | i.e. `aes-256-gcm` | Specify a custom cipher to use. It will also set `ncp-disable` if using AES GCM for PIA |
-| `OPENVPN_AUTH` | | i.e. `sha256` | Specify a custom auth algorithm to use |
-
-*For all providers below, server location parameters are all optional. By default a random server is picked using the filter settings provided.*
-
-- Private Internet Access
-
-    | Variable | Default | Choices | Description |
-    | --- | --- | --- | --- |
-    | 🏁 `USER` | | | Your username |
-    | 🏁 `PASSWORD` | | | Your password |
-    | `REGION` | | One of the [PIA regions](https://www.privateinternetaccess.com/pages/network/) | VPN server region |
-    | `PIA_ENCRYPTION` | `strong` | `normal`, `strong` | Encryption preset |
-    | `PORT_FORWARDING` | `off` | `on`, `off` | Enable port forwarding on the VPN server |
-    | `PORT_FORWARDING_STATUS_FILE` | `/forwarded_port` | Any filepath | Filepath to store the forwarded port number |
-
-- Mullvad
-
-    | Variable | Default | Choices | Description |
-    | --- | --- | --- | --- |
-    | 🏁 `USER` | | | Your user ID |
-    | `COUNTRY` | | One of the [Mullvad countries](https://mullvad.net/en/servers/#openvpn) | VPN server country |
-    | `CITY` | | One of the [Mullvad cities](https://mullvad.net/en/servers/#openvpn) | VPN server city |
-    | `ISP` | | One of the [Mullvad ISP](https://mullvad.net/en/servers/#openvpn) | VPN server ISP |
-    | `PORT` | | `80` or `443` for TCP; or `53` for UDP. Leave blank for default Mullvad server port | Custom VPN port to use |
-
-- Windscribe
-
-    | Variable | Default | Choices | Description |
-    | --- | --- | --- | --- |
-    | 🏁 `USER` | | | Your username |
-    | 🏁 `PASSWORD` | | | Your password |
-    | `REGION` | | One of the [Windscribe regions](https://windscribe.com/status) | VPN server region |
-    | `PORT` | | One from the [this list of ports](https://windscribe.com/getconfig/openvpn) | Custom VPN port to use |
-
-- Surfshark
-
-    | Variable | Default | Choices | Description |
-    | --- | --- | --- | --- |
-    | 🏁 `USER` | | | Your **service** username, found at the bottom of the [manual setup page](https://account.surfshark.com/setup/manual) |
-    | 🏁 `PASSWORD` | | | Your **service** password |
-    | `REGION` | | One of the [Surfshark regions](https://github.com/qdm12/private-internet-access-docker/wiki/surfshark) | VPN server region |
-
-- Cyberghost
-
-    | Variable | Default | Choices | Description |
-    | --- | --- | --- | --- |
-    | 🏁 `USER` | | | Your username |
-    | 🏁 `PASSWORD` | | | Your password |
-    | 🏁 `CLIENT_KEY` | | | Your device client key content, **see below** |
-    | `REGION` | | One of the [Cyberghost countries](https://github.com/qdm12/private-internet-access-docker/wiki/Cyberghost#regions) | VPN server country |
-    | `CYBERGHOST_GROUP` | `Premium UDP Europe` | One of the [server groups](https://github.com/qdm12/private-internet-access-docker/wiki/Cyberghost#server-groups) | Server group |
-
-    To specify your client key, you can either:
-
-    - Bind mount it at `/files/client.key`, for example with `-v /yourpath/client.key:/files/client.key:ro`
-    - Convert it to a single line value using:
-
-        ```sh
-        docker run -it --rm -v /yourpath/client.key:/files/client.key:ro qmcgaw/private-internet-access clientkey
-        ```
-
-        And use the line produced as the value for the environment variable `CLIENT_KEY`.
-
-- Vyprvpn
-
-    | Variable | Default | Choices | Description |
-    | --- | --- | --- | --- |
-    | 🏁 `USER` | | | Your username |
-    | 🏁 `PASSWORD` | | | Your password |
-    | `REGION` | | One of the [VyprVPN regions](https://www.vyprvpn.com/server-locations) | VPN server region |
-
-- NordVPN
-
-    | Variable | Default | Choices | Description |
-    | --- | --- | --- | --- |
-    | 🏁 `USER` | | | Your username |
-    | 🏁 `PASSWORD` | | | Your password |
-    | `REGION` | | One of the NordVPN server country, i.e. `Switzerland` | VPN server country |
-    | `SERVER_NUMBER` | | Server integer number | Optional server number. For example `251` for `Italy #251` |
-
-- PureVPN
-
-    | Variable | Default | Choices | Description |
-    | --- | --- | --- | --- |
-    | 🏁 `USER` | | | Your user ID |
-    | 🏁 `REGION` | | One of the [PureVPN regions](https://support.purevpn.com/vpn-servers) | VPN server region |
-    | `COUNTRY` | | One of the [PureVPN countries](https://support.purevpn.com/vpn-servers) | VPN server country |
-    | `CITY` | | One of the [PureVPN cities](https://support.purevpn.com/vpn-servers) | VPN server city |
-
-### DNS over TLS
-
-None of the following values are required.
-
-| Variable | Default | Choices | Description |
-| --- | --- | --- | --- |
-| `DOT` | `on` | `on`, `off` | Activate DNS over TLS with Unbound |
-| `DOT_PROVIDERS` | `cloudflare` | `cloudflare`, `google`, `quad9`, `quadrant`, `cleanbrowsing`, `securedns`, `libredns` | Comma delimited list of DNS over TLS providers |
-| `DOT_CACHING` | `on` | `on`, `off` | Unbound caching |
-| `DOT_IPV6` | `off` | `on`, `off` | DNS IPv6 resolution |
-| `DOT_PRIVATE_ADDRESS` | All private CIDRs ranges | | Comma separated list of CIDRs or single IP addresses Unbound won't resolve to. Note that the default setting prevents DNS rebinding |
-| `DOT_VERBOSITY` | `1` | `0` to `5` | Unbound verbosity level |
-| `DOT_VERBOSITY_DETAILS` | `0` | `0` to `4` | Unbound details verbosity level |
-| `DOT_VALIDATION_LOGLEVEL` | `0` | `0` to `2` | Unbound validation log level |
-| `DNS_UPDATE_PERIOD` | `24h` | i.e. `0`, `30s`, `5m`, `24h` | Period to update block lists and cryptographic files and restart Unbound. Set to `0` to deactivate updates |
-| `BLOCK_MALICIOUS` | `on` | `on`, `off` | Block malicious hostnames and IPs with Unbound |
-| `BLOCK_SURVEILLANCE` | `off` | `on`, `off` | Block surveillance hostnames and IPs with Unbound |
-| `BLOCK_ADS` | `off` | `on`, `off` | Block ads hostnames and IPs with Unbound |
-| `UNBLOCK` | |i.e. `domain1.com,x.domain2.co.uk` | Comma separated list of domain names to leave unblocked with Unbound |
-| `DNS_PLAINTEXT_ADDRESS` | `1.1.1.1` | Any IP address | IP address to use as DNS resolver if `DOT` is `off` |
-| `DNS_KEEP_NAMESERVER` | `off` | `on` or `off` | Keep the nameservers in /etc/resolv.conf untouched, but disabled DNS blocking features |
-
-### Firewall
-
-That one is important if you want to connect to the container from your LAN for example, using Shadowsocks or Tinyproxy.
-
-| Variable | Default | Choices | Description |
-| --- | --- | --- | --- |
-| `FIREWALL` | `on` | `on` or `off` | Turn on or off the container built-in firewall. You should use it for **debugging purposes** only. |
-| `EXTRA_SUBNETS` | | i.e. `192.168.1.0/24,192.168.10.121,10.0.0.5/28` | Comma separated subnets allowed in the container firewall |
-| `FIREWALL_VPN_INPUT_PORTS` | | i.e. `1000,8080` | Comma separated list of ports to allow from the VPN server side (useful for **vyprvpn** port forwarding) |
-| `FIREWALL_DEBUG` | `off` | `on` or `off` | Prints every firewall related command. You should use it for **debugging purposes** only. |
-
-### Shadowsocks
-
-| Variable | Default | Choices | Description |
-| --- | --- | --- | --- |
-| `SHADOWSOCKS` | `off` | `on`, `off` | Enable the internal SOCKS5 proxy Shadowsocks |
-| `SHADOWSOCKS_LOG` | `off` | `on`, `off` | Enable logging |
-| `SHADOWSOCKS_PORT` | `8388` | `1024` to `65535` | Internal port number for Shadowsocks to listen on |
-| `SHADOWSOCKS_PASSWORD` | |  | Password to use to connect to Shadowsocks |
-| `SHADOWSOCKS_METHOD` | `chacha20-ietf-poly1305` | One of [these ciphers](https://shadowsocks.org/en/config/quick-guide.html) | Method to use for Shadowsocks |
-
-### Tinyproxy
-
-| Variable | Default | Choices | Description |
-| --- | --- | --- | --- |
-| `TINYPROXY` | `off` | `on`, `off` | Enable the internal HTTP proxy tinyproxy |
-| `TINYPROXY_LOG` | `Info` | `Info`, `Connect`, `Notice`, `Warning`, `Error`, `Critical` | Tinyproxy log level |
-| `TINYPROXY_PORT` | `8888` | `1024` to `65535` | Internal port number for Tinyproxy to listen on |
-| `TINYPROXY_USER` | | | Username to use to connect to Tinyproxy |
-| `TINYPROXY_PASSWORD` | | | Password to use to connect to Tinyproxy |
-
-### System
-
-| Variable | Default | Choices | Description |
-| --- | --- | --- | --- |
-| `TZ` | | i.e. `Europe/London` | Specify a timezone to use to have correct log times |
-| `UID` | `1000` | | User ID to run as non root and for ownership of files written |
-| `GID` | `1000` | | Group ID to run as non root and for ownership of files written |
-
-### Other
-
-| Variable | Default | Choices | Description |
-| --- | --- | --- | --- |
-| `PUBLICIP_PERIOD` | `12h` | Valid duration | Period to check for public IP address. Set to `0` to disable. |
-
-## Connect to it
-
-There are various ways to achieve this, depending on your use case.
-
-- <details><summary>Connect containers in the same docker-compose.yml as Gluetun</summary><p>
-
-    Add `network_mode: "service:gluetun"` to your *docker-compose.yml* (no need for `depends_on`)
-
-    </p></details>
-- <details><summary>Connect other containers to Gluetun</summary><p>
-
-    Add `--network=container:gluetun` when launching the container, provided Gluetun is already running
-
-    </p></details>
-- <details><summary>Connect containers from another docker-compose.yml</summary><p>
-
-    Add `network_mode: "container:gluetun"` to your *docker-compose.yml*, provided Gluetun is already running
-
-    </p></details>
-- <details><summary>Connect LAN devices through the built-in HTTP proxy *Tinyproxy* (i.e. with Chrome, Kodi, etc.)</summary><p>
-
-    You might want to use Shadowsocks instead which tunnels UDP as well as TCP, whereas Tinyproxy only tunnels TCP.
-
-    1. Setup a HTTP proxy client, such as [SwitchyOmega for Chrome](https://chrome.google.com/webstore/detail/proxy-switchyomega/padekgcemlokbadohgkifijomclgjgif?hl=en)
-    1. Ensure the Gluetun container is launched with:
-        - port `8888` published `-p 8888:8888/tcp`
-        - your LAN subnet, i.e. `192.168.1.0/24`, set as `-e EXTRA_SUBNETS=192.168.1.0/24`
-    1. With your HTTP proxy client, connect to the Docker host (i.e. `192.168.1.10`) on port `8888`. You need to enter your credentials if you set them with `TINYPROXY_USER` and `TINYPROXY_PASSWORD`.
-    1. If you set `TINYPROXY_LOG` to `Info`, more information will be logged in the Docker logs
-
-    </p></details>
-- <details><summary>Connect LAN devices through the built-in SOCKS5 proxy *Shadowsocks* (per app, system wide, etc.)</summary><p>
-
-    1. Setup a SOCKS5 proxy client, there is a list of [ShadowSocks clients for **all platforms**](https://shadowsocks.org/en/download/clients.html)
-        - **note** some clients do not tunnel UDP so your DNS queries will be done locally and not through Gluetun and its built in DNS over TLS
-        - Clients that support such UDP tunneling are, as far as I know:
-            - iOS: Potatso Lite
-            - OSX: ShadowsocksX
-            - Android: Shadowsocks by Max Lv
-    1. Ensure the Gluetun container is launched with:
-        - port `8388` published `-p 8388:8388/tcp -p 8388:8388/udp`
-        - your LAN subnet, i.e. `192.168.1.0/24`, set as `-e EXTRA_SUBNETS=192.168.1.0/24`
-    1. With your SOCKS5 proxy client
-        - Enter the Docker host (i.e. `192.168.1.10`) as the server IP
-        - Enter port TCP (and UDP, if available) `8388` as the server port
-        - Use the password you have set with `SHADOWSOCKS_PASSWORD`
-        - Choose the encryption method/algorithm to the method you specified in `SHADOWSOCKS_METHOD`
-    1. If you set `SHADOWSOCKS_LOG` to `on`, (a lot) more information will be logged in the Docker logs
-
-    </p></details>
-- <details><summary>Access ports of containers connected to Gluetun</summary><p>
-
-    In example, to access port `8000` of container `xyz`  and `9000` of container `abc` connected to Gluetun,
-    publish ports `8000` and `9000` for the Gluetun container and access them as you would with any other container
-
-    </p></details>
-- <details><summary>Access ports of containers connected to Gluetun, all in the same docker-compose.yml</summary><p>
-
-    In example, to access port `8000` of container `xyz`  and `9000` of container `abc` connected to Gluetun, publish port `8000` and `9000` for the Gluetun container.
-    The docker-compose.yml file would look like:
-
-    ```yml
-    version: '3.7'
-    services:
-      gluetun:
-        image: qmcgaw/private-internet-access
-        container_name: gluetun
-        cap_add:
-          - NET_ADMIN
-        environment:
-          - USER=js89ds7
-          - PASSWORD=8fd9s239G
-        ports:
-          - 8000:8000/tcp
-          - 9000:9000/tcp
-      abc:
-        image: abc
-        container_name: abc
-        network_mode: "service:gluetun"
-      xyz:
-        image: xyz
-        container_name: xyz
-        network_mode: "service:gluetun"
-    ```
-
-    </p></details>
-
-## Private Internet Access port forwarding
-
-Note that [not all regions support port forwarding](https://www.privateinternetaccess.com/helpdesk/kb/articles/how-do-i-enable-port-forwarding-on-my-vpn).
-
-When `PORT_FORWARDING=on`, a port will be forwarded on the VPN server side and written to the file specified by `PORT_FORWARDING_STATUS_FILE=/forwarded_port`.
-It can be useful to mount this file as a volume to read it from other containers, for example to configure a torrenting client.
-
-You can also use the HTTP control server (see below) to get the port forwarded.
-
-## HTTP control server
-
-See [its Wiki page](https://github.com/qdm12/private-internet-access-docker/wiki/HTTP-control-server)
-
-## Development and contributing
-
-- Contribute with code: see [the Wiki](https://github.com/qdm12/private-internet-access-docker/wiki/Contributing).
-- [The list of existing contributors 👍](https://github.com/qdm12/private-internet-access-docker/blob/master/.github/CONTRIBUTING.md#Contributors)
-- [Github workflows](https://github.com/qdm12/private-internet-access-docker/actions) to know what's building
-- [List of issues and feature requests](https://github.com/qdm12/private-internet-access-docker/issues)
-
 ## License
 
-This repository is under an [MIT license](https://github.com/qdm12/private-internet-access-docker/master/license)
-
-## Support
-
-Sponsor me on [Github](https://github.com/sponsors/qdm12), donate to [paypal.me/qmcgaw](https://www.paypal.me/qmcgaw) or subscribe to a VPN provider through one of my affiliate links:
-
-[![https://github.com/sponsors/qdm12](https://raw.githubusercontent.com/qdm12/private-internet-access-docker/master/doc/sponsors.jpg)](https://github.com/sponsors/qdm12)
-[![https://www.paypal.me/qmcgaw](https://raw.githubusercontent.com/qdm12/private-internet-access-docker/master/doc/paypal.jpg)](https://www.paypal.me/qmcgaw)
-
-[![https://windscribe.com/?affid=mh7nyafu](https://raw.githubusercontent.com/qdm12/private-internet-access-docker/master/doc/windscribe.jpg)](https://windscribe.com/?affid=mh7nyafu)
-
-Feel also free to have a look at [the Kanban board](https://github.com/qdm12/private-internet-access-docker/projects/1) and [contribute](#Development-and-contributing) to the code or the issues discussion.
-
-Many thanks to @Frepke, @Ralph521, G. Mendez, M. Otmar Weber, J. Perez and A. Cooper for supporting me financially 🥇👍
+[![MIT](https://img.shields.io/github/license/qdm12/gluetun)](https://github.com/qdm12/gluetun/master/LICENSE)

cmd/gluetun/main.go

@@ -2,326 +2,453 @@ package main
 
 import (
 	"context"
+	"errors"
 	"fmt"
+	"net/http"
 	"os"
 	"os/signal"
+	"strconv"
 	"strings"
-	"sync"
 	"syscall"
 	"time"
+	_ "time/tzdata"
 
+	_ "github.com/breml/rootcerts"
+	"github.com/qdm12/dns/pkg/unbound"
+	"github.com/qdm12/gluetun/internal/alpine"
+	"github.com/qdm12/gluetun/internal/cli"
+	"github.com/qdm12/gluetun/internal/configuration"
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/dns"
+	"github.com/qdm12/gluetun/internal/firewall"
+	"github.com/qdm12/gluetun/internal/healthcheck"
+	"github.com/qdm12/gluetun/internal/httpproxy"
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/gluetun/internal/netlink"
+	"github.com/qdm12/gluetun/internal/openvpn"
+	"github.com/qdm12/gluetun/internal/portforward"
+	"github.com/qdm12/gluetun/internal/publicip"
+	"github.com/qdm12/gluetun/internal/routing"
+	"github.com/qdm12/gluetun/internal/server"
+	"github.com/qdm12/gluetun/internal/shadowsocks"
+	"github.com/qdm12/gluetun/internal/storage"
+	"github.com/qdm12/gluetun/internal/tun"
+	"github.com/qdm12/gluetun/internal/updater"
+	"github.com/qdm12/gluetun/internal/vpn"
 	"github.com/qdm12/golibs/command"
-	"github.com/qdm12/golibs/files"
 	"github.com/qdm12/golibs/logging"
-	"github.com/qdm12/golibs/network"
-	"github.com/qdm12/private-internet-access-docker/internal/alpine"
-	"github.com/qdm12/private-internet-access-docker/internal/cli"
-	"github.com/qdm12/private-internet-access-docker/internal/constants"
-	"github.com/qdm12/private-internet-access-docker/internal/dns"
-	"github.com/qdm12/private-internet-access-docker/internal/firewall"
-	gluetunLogging "github.com/qdm12/private-internet-access-docker/internal/logging"
-	"github.com/qdm12/private-internet-access-docker/internal/openvpn"
-	"github.com/qdm12/private-internet-access-docker/internal/params"
-	"github.com/qdm12/private-internet-access-docker/internal/publicip"
-	"github.com/qdm12/private-internet-access-docker/internal/routing"
-	"github.com/qdm12/private-internet-access-docker/internal/server"
-	"github.com/qdm12/private-internet-access-docker/internal/settings"
-	"github.com/qdm12/private-internet-access-docker/internal/shadowsocks"
-	"github.com/qdm12/private-internet-access-docker/internal/tinyproxy"
+	"github.com/qdm12/golibs/params"
+	"github.com/qdm12/goshutdown"
+	"github.com/qdm12/goshutdown/goroutine"
+	"github.com/qdm12/goshutdown/group"
+	"github.com/qdm12/goshutdown/order"
+	"github.com/qdm12/gosplash"
+	"github.com/qdm12/updated/pkg/dnscrypto"
+)
+
+//nolint:gochecknoglobals
+var (
+	version = "unknown"
+	commit  = "unknown"
+	created = "an unknown date"
+)
+
+var (
+	errSetupRouting = errors.New("cannot setup routing")
+	errCreateUser   = errors.New("cannot create user")
 )
 
 func main() {
-	ctx := context.Background()
-	os.Exit(_main(ctx, os.Args))
-}
-
-func _main(background context.Context, args []string) int {
-	if len(args) > 1 { // cli operation
-		var err error
-		switch args[1] {
-		case "healthcheck":
-			err = cli.HealthCheck()
-		case "clientkey":
-			err = cli.ClientKey(args[2:])
-		case "openvpnconfig":
-			err = cli.OpenvpnConfig()
-		default:
-			err = fmt.Errorf("command %q is unknown", args[1])
-		}
-		if err != nil {
-			fmt.Println(err)
-			return 1
-		}
-		return 0
+	buildInfo := models.BuildInformation{
+		Version: version,
+		Commit:  commit,
+		Created: created,
 	}
+
+	background := context.Background()
+	signalCtx, stop := signal.NotifyContext(background, syscall.SIGINT, syscall.SIGTERM, os.Interrupt)
 	ctx, cancel := context.WithCancel(background)
-	defer cancel()
-	logger := createLogger()
 
-	fatalOnError := makeFatalOnError(logger, cancel)
-
-	client := network.NewClient(15 * time.Second)
-	// Create configurators
-	fileManager := files.NewFileManager()
-	alpineConf := alpine.NewConfigurator(fileManager)
-	ovpnConf := openvpn.NewConfigurator(logger, fileManager)
-	dnsConf := dns.NewConfigurator(logger, client, fileManager)
-	routingConf := routing.NewRouting(logger, fileManager)
-	firewallConf := firewall.NewConfigurator(logger, routingConf, fileManager)
-	tinyProxyConf := tinyproxy.NewConfigurator(fileManager, logger)
-	shadowsocksConf := shadowsocks.NewConfigurator(fileManager, logger)
-	streamMerger := command.NewStreamMerger()
-
-	paramsReader := params.NewReader(logger, fileManager)
-	fmt.Println(gluetunLogging.Splash(
-		paramsReader.GetVersion(),
-		paramsReader.GetVcsRef(),
-		paramsReader.GetBuildDate()))
-
-	printVersions(ctx, logger, map[string]func(ctx context.Context) (string, error){
-		"OpenVPN":     ovpnConf.Version,
-		"Unbound":     dnsConf.Version,
-		"IPtables":    firewallConf.Version,
-		"TinyProxy":   tinyProxyConf.Version,
-		"ShadowSocks": shadowsocksConf.Version,
+	logger := logging.New(logging.Settings{
+		Level: logging.LevelInfo,
 	})
 
-	allSettings, err := settings.GetAllSettings(paramsReader)
-	fatalOnError(err)
+	args := os.Args
+	tun := tun.New()
+	netLinker := netlink.New()
+	cli := cli.New()
+	env := params.New()
+	cmder := command.NewCmder()
+
+	errorCh := make(chan error)
+	go func() {
+		errorCh <- _main(ctx, buildInfo, args, logger, env, tun, netLinker, cmder, cli)
+	}()
+
+	select {
+	case <-signalCtx.Done():
+		stop()
+		fmt.Println("")
+		logger.Warn("Caught OS signal, shutting down")
+		cancel()
+	case err := <-errorCh:
+		stop()
+		close(errorCh)
+		if err == nil { // expected exit such as healthcheck
+			os.Exit(0)
+		}
+		logger.Error(err.Error())
+		cancel()
+	}
+
+	const shutdownGracePeriod = 5 * time.Second
+	timer := time.NewTimer(shutdownGracePeriod)
+	select {
+	case <-errorCh:
+		if !timer.Stop() {
+			<-timer.C
+		}
+		logger.Info("Shutdown successful")
+	case <-timer.C:
+		logger.Warn("Shutdown timed out")
+	}
+
+	os.Exit(1)
+}
+
+var (
+	errCommandUnknown = errors.New("command is unknown")
+)
+
+//nolint:gocognit,gocyclo
+func _main(ctx context.Context, buildInfo models.BuildInformation,
+	args []string, logger logging.ParentLogger, env params.Interface,
+	tun tun.Interface, netLinker netlink.NetLinker, cmder command.RunStarter,
+	cli cli.CLIer) error {
+	if len(args) > 1 { // cli operation
+		switch args[1] {
+		case "healthcheck":
+			return cli.HealthCheck(ctx, env, logger)
+		case "clientkey":
+			return cli.ClientKey(args[2:])
+		case "openvpnconfig":
+			return cli.OpenvpnConfig(logger, env)
+		case "update":
+			return cli.Update(ctx, args[2:], logger)
+		case "format-servers":
+			return cli.FormatServers(args[2:])
+		default:
+			return fmt.Errorf("%w: %s", errCommandUnknown, args[1])
+		}
+	}
+
+	// TODO run this in a loop or in openvpn to reload from file without restarting
+	storageLogger := logger.NewChild(logging.Settings{Prefix: "storage: "})
+	storage, err := storage.New(storageLogger, constants.ServersData)
+	if err != nil {
+		return err
+	}
+	allServers := storage.GetServers()
+
+	var allSettings configuration.Settings
+	err = allSettings.Read(env, allServers,
+		logger.NewChild(logging.Settings{Prefix: "configuration: "}))
+	if err != nil {
+		return err
+	}
+	logger.PatchLevel(allSettings.Log.Level)
+
+	puid, pgid := allSettings.System.PUID, allSettings.System.PGID
+
+	const clientTimeout = 15 * time.Second
+	httpClient := &http.Client{Timeout: clientTimeout}
+	// Create configurators
+	alpineConf := alpine.New()
+	ovpnConf := openvpn.New(
+		logger.NewChild(logging.Settings{Prefix: "openvpn configurator: "}),
+		cmder, puid, pgid)
+	dnsCrypto := dnscrypto.New(httpClient, "", "")
+	const cacertsPath = "/etc/ssl/certs/ca-certificates.crt"
+	dnsConf := unbound.NewConfigurator(nil, cmder, dnsCrypto,
+		"/etc/unbound", "/usr/sbin/unbound", cacertsPath)
+
+	announcementExp, err := time.Parse(time.RFC3339, "2021-10-02T00:00:00Z")
+	if err != nil {
+		return err
+	}
+	splashSettings := gosplash.Settings{
+		User:         "qdm12",
+		Repository:   "gluetun",
+		Emails:       []string{"quentin.mcgaw@gmail.com"},
+		Version:      buildInfo.Version,
+		Commit:       buildInfo.Commit,
+		BuildDate:    buildInfo.Created,
+		Announcement: "Wireguard is now supported for Mullvad, IVPN and Windscribe!",
+		AnnounceExp:  announcementExp,
+		// Sponsor information
+		PaypalUser:    "qmcgaw",
+		GithubSponsor: "qdm12",
+	}
+	for _, line := range gosplash.MakeLines(splashSettings) {
+		fmt.Println(line)
+	}
+
+	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: "Unbound", getVersion: dnsConf.Version},
+		{name: "IPtables", getVersion: func(ctx context.Context) (version string, err error) {
+			return firewall.Version(ctx, cmder)
+		}},
+	})
+	if err != nil {
+		return err
+	}
+
 	logger.Info(allSettings.String())
 
-	// Should never change
-	uid, gid := allSettings.System.UID, allSettings.System.GID
-
-	err = alpineConf.CreateUser("nonrootuser", uid)
-	fatalOnError(err)
-	err = fileManager.SetOwnership("/etc/unbound", uid, gid)
-	fatalOnError(err)
-	err = fileManager.SetOwnership("/etc/tinyproxy", uid, gid)
-	fatalOnError(err)
-
-	if allSettings.Firewall.Debug {
-		firewallConf.SetDebug()
-		routingConf.SetDebug()
+	if err := os.MkdirAll("/tmp/gluetun", 0644); err != nil {
+		return err
 	}
+	if err := os.MkdirAll("/gluetun", 0644); err != nil {
+		return err
+	}
+
+	const defaultUsername = "nonrootuser"
+	nonRootUsername, err := alpineConf.CreateUser(defaultUsername, puid)
+	if err != nil {
+		return fmt.Errorf("%w: %s", errCreateUser, err)
+	}
+	if nonRootUsername != defaultUsername {
+		logger.Info("using existing username " + nonRootUsername + " corresponding to user id " + fmt.Sprint(puid))
+	}
+	// set it for Unbound
+	// TODO remove this when migrating to qdm12/dns v2
+	allSettings.DNS.Unbound.Username = nonRootUsername
+	allSettings.VPN.OpenVPN.ProcUser = nonRootUsername
+
+	if err := os.Chown("/etc/unbound", puid, pgid); err != nil {
+		return err
+	}
+
+	firewallLogLevel := allSettings.Log.Level
+	if allSettings.Firewall.Debug {
+		firewallLogLevel = logging.LevelDebug
+	}
+	routingLogger := logger.NewChild(logging.Settings{
+		Prefix: "routing: ",
+		Level:  firewallLogLevel,
+	})
+	routingConf := routing.New(netLinker, routingLogger)
 
 	defaultInterface, defaultGateway, err := routingConf.DefaultRoute()
 	if err != nil {
-		fatalOnError(err)
+		return err
 	}
 
-	localSubnet, err := routingConf.LocalSubnet()
+	localNetworks, err := routingConf.LocalNetworks()
 	if err != nil {
-		fatalOnError(err)
+		return err
 	}
 
-	firewallConf.SetNetworkInformation(defaultInterface, defaultGateway, localSubnet)
-
-	if err := ovpnConf.CheckTUN(); err != nil {
-		logger.Warn(err)
-		err = ovpnConf.CreateTUN()
-		fatalOnError(err)
+	defaultIP, err := routingConf.DefaultIP()
+	if err != nil {
+		return err
 	}
 
-	connectedCh := make(chan struct{})
-	signalConnected := func() {
-		connectedCh <- struct{}{}
+	firewallLogger := logger.NewChild(logging.Settings{
+		Prefix: "firewall: ",
+		Level:  firewallLogLevel,
+	})
+	firewallConf := firewall.NewConfig(firewallLogger, cmder,
+		defaultInterface, defaultGateway, localNetworks, defaultIP)
+
+	if err := routingConf.Setup(); err != nil {
+		if strings.Contains(err.Error(), "operation not permitted") {
+			logger.Warn("💡 Tip: Are you passing NET_ADMIN capability to gluetun?")
+		}
+		return fmt.Errorf("%w: %s", errSetupRouting, err)
+	}
+	defer func() {
+		logger.Info("routing cleanup...")
+		if err := routingConf.TearDown(); err != nil {
+			logger.Error("cannot teardown routing: " + err.Error())
+		}
+	}()
+
+	if err := firewallConf.SetOutboundSubnets(ctx, allSettings.Firewall.OutboundSubnets); err != nil {
+		return err
+	}
+	if err := routingConf.SetOutboundRoutes(allSettings.Firewall.OutboundSubnets); err != nil {
+		return err
+	}
+
+	if err := tun.Check(constants.TunnelDevice); err != nil {
+		logger.Info(err.Error() + "; creating it...")
+		err = tun.Create(constants.TunnelDevice)
+		if err != nil {
+			return err
+		}
 	}
-	defer close(connectedCh)
-	go collectStreamLines(ctx, streamMerger, logger, signalConnected)
 
 	if allSettings.Firewall.Enabled {
 		err := firewallConf.SetEnabled(ctx, true) // disabled by default
-		fatalOnError(err)
-	}
-
-	err = firewallConf.SetAllowedSubnets(ctx, allSettings.Firewall.AllowedSubnets)
-	fatalOnError(err)
-
-	for _, vpnPort := range allSettings.Firewall.VPNInputPorts {
-		err = firewallConf.SetAllowedPort(ctx, vpnPort, string(constants.TUN))
-		fatalOnError(err)
-	}
-
-	wg := &sync.WaitGroup{}
-
-	openvpnLooper := openvpn.NewLooper(allSettings.VPNSP, allSettings.OpenVPN, uid, gid,
-		ovpnConf, firewallConf, logger, client, fileManager, streamMerger, fatalOnError)
-	restartOpenvpn := openvpnLooper.Restart
-	portForward := openvpnLooper.PortForward
-	getOpenvpnSettings := openvpnLooper.GetSettings
-	getPortForwarded := openvpnLooper.GetPortForwarded
-	// wait for restartOpenvpn
-	go openvpnLooper.Run(ctx, wg)
-
-	unboundLooper := dns.NewLooper(dnsConf, allSettings.DNS, logger, streamMerger, uid, gid)
-	restartUnbound := unboundLooper.Restart
-	// wait for restartUnbound
-	go unboundLooper.Run(ctx, wg)
-
-	publicIPLooper := publicip.NewLooper(client, logger, fileManager, allSettings.System.IPStatusFilepath, allSettings.PublicIPPeriod, uid, gid)
-	restartPublicIP := publicIPLooper.Restart
-	setPublicIPPeriod := publicIPLooper.SetPeriod
-	go publicIPLooper.Run(ctx)
-	go publicIPLooper.RunRestartTicker(ctx)
-	setPublicIPPeriod(allSettings.PublicIPPeriod) // call after RunRestartTicker
-
-	tinyproxyLooper := tinyproxy.NewLooper(tinyProxyConf, firewallConf, allSettings.TinyProxy, logger, streamMerger, uid, gid, defaultInterface)
-	restartTinyproxy := tinyproxyLooper.Restart
-	go tinyproxyLooper.Run(ctx, wg)
-
-	shadowsocksLooper := shadowsocks.NewLooper(shadowsocksConf, firewallConf, allSettings.ShadowSocks, allSettings.DNS, logger, streamMerger, uid, gid, defaultInterface)
-	restartShadowsocks := shadowsocksLooper.Restart
-	go shadowsocksLooper.Run(ctx, wg)
-
-	if allSettings.TinyProxy.Enabled {
-		restartTinyproxy()
-	}
-	if allSettings.ShadowSocks.Enabled {
-		restartShadowsocks()
-	}
-
-	go func() {
-		var restartTickerContext context.Context
-		var restartTickerCancel context.CancelFunc = func() {}
-		for {
-			select {
-			case <-ctx.Done():
-				restartTickerCancel()
-				return
-			case <-connectedCh: // blocks until openvpn is connected
-				restartTickerCancel()
-				restartTickerContext, restartTickerCancel = context.WithCancel(ctx)
-				go unboundLooper.RunRestartTicker(restartTickerContext)
-				onConnected(allSettings, logger, routingConf, portForward, restartUnbound, restartPublicIP)
-			}
-		}
-	}()
-
-	httpServer := server.New("0.0.0.0:8000", logger, restartOpenvpn, restartUnbound, getOpenvpnSettings, getPortForwarded)
-	go httpServer.Run(ctx, wg)
-
-	// Start openvpn for the first time
-	restartOpenvpn()
-
-	signalsCh := make(chan os.Signal, 1)
-	signal.Notify(signalsCh,
-		syscall.SIGINT,
-		syscall.SIGTERM,
-		os.Interrupt,
-	)
-	shutdownErrorsCount := 0
-	select {
-	case signal := <-signalsCh:
-		logger.Warn("Caught OS signal %s, shutting down", signal)
-		cancel()
-	case <-ctx.Done():
-		logger.Warn("context canceled, shutting down")
-	}
-	logger.Info("Clearing ip status file %s", allSettings.System.IPStatusFilepath)
-	if err := fileManager.Remove(string(allSettings.System.IPStatusFilepath)); err != nil {
-		logger.Error(err)
-		shutdownErrorsCount++
-	}
-	if allSettings.OpenVPN.Provider.PortForwarding.Enabled {
-		logger.Info("Clearing forwarded port status file %s", allSettings.OpenVPN.Provider.PortForwarding.Filepath)
-		if err := fileManager.Remove(string(allSettings.OpenVPN.Provider.PortForwarding.Filepath)); err != nil {
-			logger.Error(err)
-			shutdownErrorsCount++
-		}
-	}
-	waiting, waited := context.WithTimeout(context.Background(), time.Second)
-	go func() {
-		defer waited()
-		wg.Wait()
-	}()
-	<-waiting.Done()
-	if waiting.Err() == context.DeadlineExceeded {
-		if shutdownErrorsCount > 0 {
-			logger.Warn("Shutdown had %d errors", shutdownErrorsCount)
-		}
-		logger.Warn("Shutdown timed out")
-		return 1
-	}
-	if shutdownErrorsCount > 0 {
-		logger.Warn("Shutdown had %d errors")
-		return 1
-	}
-	logger.Info("Shutdown successful")
-	return 0
-}
-
-func makeFatalOnError(logger logging.Logger, cancel context.CancelFunc) func(err error) {
-	return func(err error) {
 		if err != nil {
-			logger.Error(err)
-			cancel()
+			return err
 		}
 	}
-}
 
-func createLogger() logging.Logger {
-	logger, err := logging.NewLogger(logging.ConsoleEncoding, logging.InfoLevel, -1)
-	if err != nil {
-		panic(err)
+	for _, port := range allSettings.Firewall.InputPorts {
+		err = firewallConf.SetAllowedPort(ctx, port, defaultInterface)
+		if err != nil {
+			return err
+		}
+	} // TODO move inside firewall?
+
+	// Shutdown settings
+	const totalShutdownTimeout = 3 * time.Second
+	const defaultShutdownTimeout = 400 * time.Millisecond
+	defaultShutdownOnSuccess := func(goRoutineName string) {
+		logger.Info(goRoutineName + ": terminated ✔️")
 	}
-	return logger
+	defaultShutdownOnFailure := func(goRoutineName string, err error) {
+		logger.Warn(goRoutineName + ": " + err.Error() + " ⚠️")
+	}
+	defaultGroupOptions := []group.Option{
+		group.OptionTimeout(defaultShutdownTimeout),
+		group.OptionOnSuccess(defaultShutdownOnSuccess)}
+
+	controlGroupHandler := goshutdown.NewGroupHandler("control", defaultGroupOptions...)
+	tickersGroupHandler := goshutdown.NewGroupHandler("tickers", defaultGroupOptions...)
+	otherGroupHandler := goshutdown.NewGroupHandler("other", defaultGroupOptions...)
+
+	portForwardLogger := logger.NewChild(logging.Settings{Prefix: "port forwarding: "})
+	portForwardLooper := portforward.NewLoop(allSettings.VPN.Provider.PortForwarding,
+		httpClient, firewallConf, portForwardLogger)
+	portForwardHandler, portForwardCtx, portForwardDone := goshutdown.NewGoRoutineHandler(
+		"port forwarding", goroutine.OptionTimeout(time.Second))
+	go portForwardLooper.Run(portForwardCtx, portForwardDone)
+
+	unboundLogger := logger.NewChild(logging.Settings{Prefix: "dns over tls: "})
+	unboundLooper := dns.NewLoop(dnsConf, allSettings.DNS, httpClient,
+		unboundLogger)
+	dnsHandler, dnsCtx, dnsDone := goshutdown.NewGoRoutineHandler(
+		"unbound", goroutine.OptionTimeout(defaultShutdownTimeout))
+	// wait for unboundLooper.Restart or its ticker launched with RunRestartTicker
+	go unboundLooper.Run(dnsCtx, dnsDone)
+	otherGroupHandler.Add(dnsHandler)
+
+	dnsTickerHandler, dnsTickerCtx, dnsTickerDone := goshutdown.NewGoRoutineHandler(
+		"dns ticker", goroutine.OptionTimeout(defaultShutdownTimeout))
+	go unboundLooper.RunRestartTicker(dnsTickerCtx, dnsTickerDone)
+	controlGroupHandler.Add(dnsTickerHandler)
+
+	publicIPLooper := publicip.NewLoop(httpClient,
+		logger.NewChild(logging.Settings{Prefix: "ip getter: "}),
+		allSettings.PublicIP, puid, pgid)
+	pubIPHandler, pubIPCtx, pubIPDone := goshutdown.NewGoRoutineHandler(
+		"public IP", goroutine.OptionTimeout(defaultShutdownTimeout))
+	go publicIPLooper.Run(pubIPCtx, pubIPDone)
+	otherGroupHandler.Add(pubIPHandler)
+
+	pubIPTickerHandler, pubIPTickerCtx, pubIPTickerDone := goshutdown.NewGoRoutineHandler(
+		"public IP", goroutine.OptionTimeout(defaultShutdownTimeout))
+	go publicIPLooper.RunRestartTicker(pubIPTickerCtx, pubIPTickerDone)
+	tickersGroupHandler.Add(pubIPTickerHandler)
+
+	vpnLogger := logger.NewChild(logging.Settings{Prefix: "vpn: "})
+	vpnLooper := vpn.NewLoop(allSettings.VPN, allSettings.Firewall.VPNInputPorts,
+		allServers, ovpnConf, netLinker, firewallConf, routingConf, portForwardLooper,
+		cmder, publicIPLooper, unboundLooper, vpnLogger, httpClient,
+		buildInfo, allSettings.VersionInformation)
+	vpnHandler, vpnCtx, vpnDone := goshutdown.NewGoRoutineHandler(
+		"vpn", goroutine.OptionTimeout(time.Second))
+	go vpnLooper.Run(vpnCtx, vpnDone)
+
+	updaterLooper := updater.NewLooper(allSettings.Updater,
+		allServers, storage, vpnLooper.SetServers, httpClient,
+		logger.NewChild(logging.Settings{Prefix: "updater: "}))
+	updaterHandler, updaterCtx, updaterDone := goshutdown.NewGoRoutineHandler(
+		"updater", goroutine.OptionTimeout(defaultShutdownTimeout))
+	// wait for updaterLooper.Restart() or its ticket launched with RunRestartTicker
+	go updaterLooper.Run(updaterCtx, updaterDone)
+	tickersGroupHandler.Add(updaterHandler)
+
+	updaterTickerHandler, updaterTickerCtx, updaterTickerDone := goshutdown.NewGoRoutineHandler(
+		"updater ticker", goroutine.OptionTimeout(defaultShutdownTimeout))
+	go updaterLooper.RunRestartTicker(updaterTickerCtx, updaterTickerDone)
+	controlGroupHandler.Add(updaterTickerHandler)
+
+	httpProxyLooper := httpproxy.NewLoop(
+		logger.NewChild(logging.Settings{Prefix: "http proxy: "}),
+		allSettings.HTTPProxy)
+	httpProxyHandler, httpProxyCtx, httpProxyDone := goshutdown.NewGoRoutineHandler(
+		"http proxy", goroutine.OptionTimeout(defaultShutdownTimeout))
+	go httpProxyLooper.Run(httpProxyCtx, httpProxyDone)
+	otherGroupHandler.Add(httpProxyHandler)
+
+	shadowsocksLooper := shadowsocks.NewLooper(allSettings.ShadowSocks,
+		logger.NewChild(logging.Settings{Prefix: "shadowsocks: "}))
+	shadowsocksHandler, shadowsocksCtx, shadowsocksDone := goshutdown.NewGoRoutineHandler(
+		"shadowsocks proxy", goroutine.OptionTimeout(defaultShutdownTimeout))
+	go shadowsocksLooper.Run(shadowsocksCtx, shadowsocksDone)
+	otherGroupHandler.Add(shadowsocksHandler)
+
+	controlServerAddress := ":" + strconv.Itoa(int(allSettings.ControlServer.Port))
+	controlServerLogging := allSettings.ControlServer.Log
+	httpServerHandler, httpServerCtx, httpServerDone := goshutdown.NewGoRoutineHandler(
+		"http server", goroutine.OptionTimeout(defaultShutdownTimeout))
+	httpServer := server.New(httpServerCtx, controlServerAddress, controlServerLogging,
+		logger.NewChild(logging.Settings{Prefix: "http server: "}),
+		buildInfo, vpnLooper, portForwardLooper, unboundLooper, updaterLooper, publicIPLooper)
+	go httpServer.Run(httpServerCtx, httpServerDone)
+	controlGroupHandler.Add(httpServerHandler)
+
+	healthLogger := logger.NewChild(logging.Settings{Prefix: "healthcheck: "})
+	healthcheckServer := healthcheck.NewServer(allSettings.Health, healthLogger, vpnLooper)
+	healthServerHandler, healthServerCtx, healthServerDone := goshutdown.NewGoRoutineHandler(
+		"HTTP health server", goroutine.OptionTimeout(defaultShutdownTimeout))
+	go healthcheckServer.Run(healthServerCtx, healthServerDone)
+
+	orderHandler := goshutdown.NewOrderHandler("gluetun",
+		order.OptionTimeout(totalShutdownTimeout),
+		order.OptionOnSuccess(defaultShutdownOnSuccess),
+		order.OptionOnFailure(defaultShutdownOnFailure))
+	orderHandler.Append(controlGroupHandler, tickersGroupHandler, healthServerHandler,
+		vpnHandler, portForwardHandler, 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()
+
+	return orderHandler.Shutdown(context.Background())
 }
 
-func printVersions(ctx context.Context, logger logging.Logger, versionFunctions map[string]func(ctx context.Context) (string, error)) {
-	ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
+type printVersionElement struct {
+	name       string
+	getVersion func(ctx context.Context) (version string, err error)
+}
+
+type infoer interface {
+	Info(s string)
+}
+
+func printVersions(ctx context.Context, logger infoer,
+	elements []printVersionElement) (err error) {
+	const timeout = 5 * time.Second
+	ctx, cancel := context.WithTimeout(ctx, timeout)
 	defer cancel()
-	for name, f := range versionFunctions {
-		version, err := f(ctx)
-		if err != nil {
-			logger.Error(err)
-		} else {
-			logger.Info("%s version: %s", name, version)
-		}
-	}
-}
 
-func collectStreamLines(ctx context.Context, streamMerger command.StreamMerger, logger logging.Logger, signalConnected func()) {
-	// Blocking line merging paramsReader for all programs: openvpn, tinyproxy, unbound and shadowsocks
-	logger.Info("Launching standard output merger")
-	streamMerger.CollectLines(ctx, func(line string) {
-		line, level := gluetunLogging.PostProcessLine(line)
-		if line == "" {
-			return
-		}
-		switch level {
-		case logging.InfoLevel:
-			logger.Info(line)
-		case logging.WarnLevel:
-			logger.Warn(line)
-		case logging.ErrorLevel:
-			logger.Error(line)
-		}
-		if strings.Contains(line, "Initialization Sequence Completed") {
-			signalConnected()
-		}
-	}, func(err error) {
-		logger.Warn(err)
-	})
-}
-
-func onConnected(allSettings settings.Settings, logger logging.Logger, routingConf routing.Routing,
-	portForward, restartUnbound, restartPublicIP func(),
-) {
-	restartUnbound()
-	restartPublicIP()
-	if allSettings.OpenVPN.Provider.PortForwarding.Enabled {
-		time.AfterFunc(5*time.Second, portForward)
-	}
-	defaultInterface, _, err := routingConf.DefaultRoute()
-	if err != nil {
-		logger.Warn(err)
-	} else {
-		vpnGatewayIP, err := routingConf.VPNGatewayIP(defaultInterface)
+	for _, element := range elements {
+		version, err := element.getVersion(ctx)
 		if err != nil {
-			logger.Warn(err)
-		} else {
-			logger.Info("Gateway VPN IP address: %s", vpnGatewayIP)
+			return err
 		}
+		logger.Info(element.name + " version: " + version)
 	}
+
+	return nil
 }

cmd/hostfinder/main.go

@@ -1,365 +0,0 @@
-package main
-
-import (
-	"context"
-	"flag"
-	"fmt"
-	"net"
-	"os"
-	"sort"
-)
-
-func main() {
-	ctx := context.Background()
-	os.Exit(_main(ctx))
-}
-
-func _main(ctx context.Context) int {
-	fmt.Println("Host finder for Cyberghost")
-	resolverAddress := flag.String("resolver", "1.1.1.1", "DNS Resolver IP address to use")
-	flag.Parse()
-
-	resolver := newResolver(*resolverAddress)
-	lookupIP := newLookupIP(resolver)
-
-	const domain = "cg-dialup.net"
-	groups := getCyberghostGroups()
-	countryCodes := getCountryCodes()
-	type result struct {
-		groupName string
-		region    string
-		subdomain string
-		exists    bool
-	}
-	resultsChannel := make(chan result)
-	const maxGoroutines = 10
-	guard := make(chan struct{}, maxGoroutines)
-	fmt.Print("Subdomains found: ")
-	for groupName, groupID := range groups {
-		for country, countryCode := range countryCodes {
-			go func(groupName, groupID, country, countryCode string) {
-				r := result{
-					region:    country,
-					groupName: groupName,
-					subdomain: fmt.Sprintf("%s-%s", groupID, countryCode),
-				}
-				fqdn := fmt.Sprintf("%s.%s", r.subdomain, domain)
-				guard <- struct{}{}
-				ips, err := lookupIP(ctx, fqdn)
-				<-guard
-				if err == nil && len(ips) > 0 {
-					r.exists = true
-				}
-				resultsChannel <- r
-			}(groupName, groupID, country, countryCode)
-		}
-	}
-	results := make([]result, len(groups)*len(countryCodes))
-	for i := range results {
-		results[i] = <-resultsChannel
-		fmt.Printf("%s ", results[i].subdomain)
-	}
-	fmt.Print("\n\n")
-	sort.Slice(results, func(i, j int) bool {
-		return results[i].region < results[j].region
-	})
-	for _, r := range results {
-		if r.exists {
-			// Use in resolver program
-			fmt.Printf("{subdomain: %q, region: %q, group: %q},\n", r.subdomain, r.region, r.groupName)
-		}
-	}
-	return 0
-}
-
-func newResolver(ip string) *net.Resolver {
-	return &net.Resolver{
-		PreferGo: true,
-		Dial: func(ctx context.Context, network, address string) (net.Conn, error) {
-			d := net.Dialer{}
-			return d.DialContext(ctx, "udp", net.JoinHostPort(ip, "53"))
-		},
-	}
-}
-
-type lookupIPFunc func(ctx context.Context, host string) (ips []net.IP, err error)
-
-func newLookupIP(r *net.Resolver) lookupIPFunc {
-	return func(ctx context.Context, host string) (ips []net.IP, err error) {
-		addresses, err := r.LookupIPAddr(ctx, host)
-		if err != nil {
-			return nil, err
-		}
-		ips = make([]net.IP, len(addresses))
-		for i := range addresses {
-			ips[i] = addresses[i].IP
-		}
-		return ips, nil
-	}
-}
-
-func getCyberghostGroups() map[string]string {
-	return map[string]string{
-		"Premium UDP Europe": "87-1",
-		"Premium UDP USA":    "94-1",
-		"Premium UDP Asia":   "95-1",
-		"NoSpy UDP Europe":   "87-8",
-		"Premium TCP Europe": "97-1",
-		"Premium TCP USA":    "93-1",
-		"Premium TCP Asia":   "96-1",
-		"NoSpy TCP Europe":   "97-8",
-	}
-}
-
-func getCountryCodes() map[string]string {
-	return map[string]string{
-		"Afghanistan":                       "af",
-		"Aland Islands":                     "ax",
-		"Albania":                           "al",
-		"Algeria":                           "dz",
-		"American Samoa":                    "as",
-		"Andorra":                           "ad",
-		"Angola":                            "ao",
-		"Anguilla":                          "ai",
-		"Antarctica":                        "aq",
-		"Antigua and Barbuda":               "ag",
-		"Argentina":                         "ar",
-		"Armenia":                           "am",
-		"Aruba":                             "aw",
-		"Australia":                         "au",
-		"Austria":                           "at",
-		"Azerbaijan":                        "az",
-		"Bahamas":                           "bs",
-		"Bahrain":                           "bh",
-		"Bangladesh":                        "bd",
-		"Barbados":                          "bb",
-		"Belarus":                           "by",
-		"Belgium":                           "be",
-		"Belize":                            "bz",
-		"Benin":                             "bj",
-		"Bermuda":                           "bm",
-		"Bhutan":                            "bt",
-		"Bolivia":                           "bo",
-		"Bonaire":                           "bq",
-		"Bosnia and Herzegovina":            "ba",
-		"Botswana":                          "bw",
-		"Bouvet Island":                     "bv",
-		"Brazil":                            "br",
-		"British Indian Ocean Territory":    "io",
-		"British Virgin Islands":            "vg",
-		"Brunei Darussalam":                 "bn",
-		"Bulgaria":                          "bg",
-		"Burkina Faso":                      "bf",
-		"Burundi":                           "bi",
-		"Cambodia":                          "kh",
-		"Cameroon":                          "cm",
-		"Canada":                            "ca",
-		"Cape Verde":                        "cv",
-		"Cayman Islands":                    "ky",
-		"Central African Republic":          "cf",
-		"Chad":                              "td",
-		"Chile":                             "cl",
-		"China":                             "cn",
-		"Christmas Island":                  "cx",
-		"Cocos Islands":                     "cc",
-		"Colombia":                          "co",
-		"Comoros":                           "km",
-		"Congo":                             "cg",
-		"Cook Islands":                      "ck",
-		"Costa Rica":                        "cr",
-		"Cote d'Ivoire":                     "ci",
-		"Croatia":                           "hr",
-		"Cuba":                              "cu",
-		"Curacao":                           "cw",
-		"Cyprus":                            "cy",
-		"Czech Republic":                    "cz",
-		"Democratic Republic of the Congo":  "cd",
-		"Denmark":                           "dk",
-		"Djibouti":                          "dj",
-		"Dominica":                          "dm",
-		"Dominican Republic":                "do",
-		"Ecuador":                           "ec",
-		"Egypt":                             "eg",
-		"El Salvador":                       "sv",
-		"Equatorial Guinea":                 "gq",
-		"Eritrea":                           "er",
-		"Estonia":                           "ee",
-		"Ethiopia":                          "et",
-		"Falkland Islands":                  "fk",
-		"Faroe Islands":                     "fo",
-		"Fiji":                              "fj",
-		"Finland":                           "fi",
-		"France":                            "fr",
-		"French Guiana":                     "gf",
-		"French Polynesia":                  "pf",
-		"French Southern Territories":       "tf",
-		"Gabon":                             "ga",
-		"Gambia":                            "gm",
-		"Georgia":                           "ge",
-		"Germany":                           "de",
-		"Ghana":                             "gh",
-		"Gibraltar":                         "gi",
-		"Greece":                            "gr",
-		"Greenland":                         "gl",
-		"Grenada":                           "gd",
-		"Guadeloupe":                        "gp",
-		"Guam":                              "gu",
-		"Guatemala":                         "gt",
-		"Guernsey":                          "gg",
-		"Guinea-Bissau":                     "gw",
-		"Guinea":                            "gn",
-		"Guyana":                            "gy",
-		"Haiti":                             "ht",
-		"Heard Island and McDonald Islands": "hm",
-		"Honduras":                          "hn",
-		"Hong Kong":                         "hk",
-		"Hungary":                           "hu",
-		"Iceland":                           "is",
-		"India":                             "in",
-		"Indonesia":                         "id",
-		"Iran":                              "ir",
-		"Iraq":                              "iq",
-		"Ireland":                           "ie",
-		"Isle of Man":                       "im",
-		"Israel":                            "il",
-		"Italy":                             "it",
-		"Jamaica":                           "jm",
-		"Japan":                             "jp",
-		"Jersey":                            "je",
-		"Jordan":                            "jo",
-		"Kazakhstan":                        "kz",
-		"Kenya":                             "ke",
-		"Kiribati":                          "ki",
-		"Korea":                             "kr",
-		"Kuwait":                            "kw",
-		"Kyrgyzstan":                        "kg",
-		"Lao People's Democratic Republic":  "la",
-		"Latvia":                            "lv",
-		"Lebanon":                           "lb",
-		"Lesotho":                           "ls",
-		"Liberia":                           "lr",
-		"Libya":                             "ly",
-		"Liechtenstein":                     "li",
-		"Lithuania":                         "lt",
-		"Luxembourg":                        "lu",
-		"Macao":                             "mo",
-		"Macedonia":                         "mk",
-		"Madagascar":                        "mg",
-		"Malawi":                            "mw",
-		"Malaysia":                          "my",
-		"Maldives":                          "mv",
-		"Mali":                              "ml",
-		"Malta":                             "mt",
-		"Marshall Islands":                  "mh",
-		"Martinique":                        "mq",
-		"Mauritania":                        "mr",
-		"Mauritius":                         "mu",
-		"Mayotte":                           "yt",
-		"Mexico":                            "mx",
-		"Micronesia":                        "fm",
-		"Moldova":                           "md",
-		"Monaco":                            "mc",
-		"Mongolia":                          "mn",
-		"Montenegro":                        "me",
-		"Montserrat":                        "ms",
-		"Morocco":                           "ma",
-		"Mozambique":                        "mz",
-		"Myanmar":                           "mm",
-		"Namibia":                           "na",
-		"Nauru":                             "nr",
-		"Nepal":                             "np",
-		"Netherlands":                       "nl",
-		"New Caledonia":                     "nc",
-		"New Zealand":                       "nz",
-		"Nicaragua":                         "ni",
-		"Niger":                             "ne",
-		"Nigeria":                           "ng",
-		"Niue":                              "nu",
-		"Norfolk Island":                    "nf",
-		"Northern Mariana Islands":          "mp",
-		"Norway":                            "no",
-		"Oman":                              "om",
-		"Pakistan":                          "pk",
-		"Palau":                             "pw",
-		"Palestine, State of":               "ps",
-		"Panama":                            "pa",
-		"Papua New Guinea":                  "pg",
-		"Paraguay":                          "py",
-		"Peru":                              "pe",
-		"Philippines":                       "ph",
-		"Pitcairn":                          "pn",
-		"Poland":                            "pl",
-		"Portugal":                          "pt",
-		"Puerto Rico":                       "pr",
-		"Qatar":                             "qa",
-		"Reunion":                           "re",
-		"Romania":                           "ro",
-		"Russian Federation":                "ru",
-		"Rwanda":                            "rw",
-		"Saint Barthelemy":                  "bl",
-		"Saint Helena":                      "sh",
-		"Saint Kitts and Nevis":             "kn",
-		"Saint Lucia":                       "lc",
-		"Saint Martin":                      "mf",
-		"Saint Pierre and Miquelon":         "pm",
-		"Saint Vincent and the Grenadines":  "vc",
-		"Samoa":                             "ws",
-		"San Marino":                        "sm",
-		"Sao Tome and Principe":             "st",
-		"Saudi Arabia":                      "sa",
-		"Senegal":                           "sn",
-		"Serbia":                            "rs",
-		"Seychelles":                        "sc",
-		"Sierra Leone":                      "sl",
-		"Singapore":                         "sg",
-		"Sint Maarten":                      "sx",
-		"Slovakia":                          "sk",
-		"Slovenia":                          "si",
-		"Solomon Islands":                   "sb",
-		"Somalia":                           "so",
-		"South Africa":                      "za",
-		"South Georgia and the South Sandwich Islands": "gs",
-		"South Sudan":                          "ss",
-		"Spain":                                "es",
-		"Sri Lanka":                            "lk",
-		"Sudan":                                "sd",
-		"Suriname":                             "sr",
-		"Svalbard and Jan Mayen":               "sj",
-		"Swaziland":                            "sz",
-		"Sweden":                               "se",
-		"Switzerland":                          "ch",
-		"Syrian Arab Republic":                 "sy",
-		"Taiwan":                               "tw",
-		"Tajikistan":                           "tj",
-		"Tanzania":                             "tz",
-		"Thailand":                             "th",
-		"Timor-Leste":                          "tl",
-		"Togo":                                 "tg",
-		"Tokelau":                              "tk",
-		"Tonga":                                "to",
-		"Trinidad and Tobago":                  "tt",
-		"Tunisia":                              "tn",
-		"Turkey":                               "tr",
-		"Turkmenistan":                         "tm",
-		"Turks and Caicos Islands":             "tc",
-		"Tuvalu":                               "tv",
-		"Uganda":                               "ug",
-		"Ukraine":                              "ua",
-		"United Arab Emirates":                 "ae",
-		"United Kingdom":                       "gb",
-		"United States Minor Outlying Islands": "um",
-		"United States":                        "us",
-		"Uruguay":                              "uy",
-		"US Virgin Islands":                    "vi",
-		"Uzbekistan":                           "uz",
-		"Vanuatu":                              "vu",
-		"Vatican City State":                   "va",
-		"Venezuela":                            "ve",
-		"Vietnam":                              "vn",
-		"Wallis and Futuna":                    "wf",
-		"Western Sahara":                       "eh",
-		"Yemen":                                "ye",
-		"Zambia":                               "zm",
-		"Zimbabwe":                             "zw",
-	}
-}

cmd/locationToSubdomain/main.go

@@ -1,111 +0,0 @@
-package main
-
-import (
-	"encoding/json"
-	"flag"
-	"fmt"
-	"net/http"
-	"os"
-	"sort"
-	"strings"
-	"time"
-
-	"github.com/qdm12/golibs/network"
-)
-
-func main() {
-	os.Exit(_main())
-}
-
-func _main() int {
-	provider := flag.String("provider", "purevpn", "VPN provider to map location to subdomain, can be 'purevpn'")
-	flag.Parse()
-
-	client := network.NewClient(5 * time.Second)
-	switch *provider {
-	case "purevpn":
-		servers, warnings, err := purevpn(client)
-		if err != nil {
-			fmt.Println(err)
-			return 1
-		}
-		for _, server := range servers {
-			fmt.Printf(
-				"{subdomain: %q, region: %q, country: %q, city: %q},\n",
-				server.subdomain, server.region, server.country, server.city,
-			)
-		}
-		fmt.Print("\n\n")
-		for _, warning := range warnings {
-			fmt.Println(warning)
-		}
-	default:
-		fmt.Printf("Provider %q is not supported\n", *provider)
-		return 1
-	}
-	return 0
-}
-
-type purevpnServer struct {
-	region    string
-	country   string
-	city      string
-	subdomain string // without -tcp or -udp suffix
-}
-
-func purevpn(client network.Client) (servers []purevpnServer, warnings []string, err error) {
-	content, status, err := client.GetContent("https://support.purevpn.com/vpn-servers")
-	if err != nil {
-		return nil, nil, err
-	} else if status != http.StatusOK {
-		return nil, nil, fmt.Errorf("HTTP status %d from Purevpn", status)
-	}
-	const jsonPrefix = "<script>var servers = "
-	const jsonSuffix = "</script>"
-	s := string(content)
-	jsonPrefixIndex := strings.Index(s, jsonPrefix)
-	if jsonPrefixIndex == -1 {
-		return nil, nil, fmt.Errorf("cannot find prefix %s in html", jsonPrefix)
-	}
-	if len(s[jsonPrefixIndex:]) == len(jsonPrefix) {
-		return nil, nil, fmt.Errorf("no body after json prefix %s", jsonPrefix)
-	}
-	s = s[jsonPrefixIndex+len(jsonPrefix):]
-	endIndex := strings.Index(s, jsonSuffix)
-	s = s[:endIndex]
-	var data []struct {
-		Region  string `json:"region_name"`
-		Country string `json:"country_name"`
-		City    string `json:"city_name"`
-		TCP     string `json:"tcp"`
-		UDP     string `json:"udp"`
-	}
-	if err := json.Unmarshal([]byte(s), &data); err != nil {
-		return nil, nil, err
-	}
-	sort.Slice(data, func(i, j int) bool {
-		if data[i].Region == data[j].Region {
-			if data[i].Country == data[j].Country {
-				return data[i].City < data[j].City
-			}
-			return data[i].Country < data[j].Country
-		}
-		return data[i].Region < data[j].Region
-	})
-	for i := range data {
-		if data[i].UDP == "" && data[i].TCP == "" {
-			warnings = append(warnings, fmt.Sprintf("server %s %s %s does not support TCP and UDP for openvpn", data[i].Region, data[i].Country, data[i].City))
-			continue
-		}
-		if data[i].UDP == "" || data[i].TCP == "" {
-			warnings = append(warnings, fmt.Sprintf("server %s %s %s does not support TCP or udp for openvpn", data[i].Region, data[i].Country, data[i].City))
-		}
-		servers = append(servers, purevpnServer{
-			region:    data[i].Region,
-			country:   data[i].Country,
-			city:      data[i].City,
-			subdomain: strings.TrimSuffix(data[i].TCP, "-tcp.pointtoserver.com"),
-		})
-	}
-	return servers, warnings, nil
-}

cmd/mapper/main.go

@@ -1,106 +0,0 @@
-package main
-
-import (
-	"encoding/json"
-	"flag"
-	"fmt"
-	"net"
-	"net/http"
-	"os"
-	"sort"
-	"strconv"
-	"strings"
-	"time"
-
-	"github.com/qdm12/golibs/network"
-	"github.com/qdm12/private-internet-access-docker/internal/models"
-)
-
-func main() {
-	os.Exit(_main())
-}
-
-func _main() int {
-	provider := flag.String("provider", "nordvpn", "VPN provider to map region to IP addresses using their API, can be 'nordvpn'")
-	flag.Parse()
-
-	client := network.NewClient(30 * time.Second) // big file so 30 seconds
-	switch *provider {
-	case "nordvpn":
-		servers, ignoredServers, err := nordvpn(client)
-		if err != nil {
-			fmt.Println(err)
-			return 1
-		}
-		for _, server := range servers {
-			fmt.Printf(
-				"{Region: %q, Number: %d, TCP: %t, UDP: %t, IP: net.IP{%s}},\n",
-				server.Region, server.Number, server.TCP, server.UDP, strings.ReplaceAll(server.IP.String(), ".", ", "),
-			)
-		}
-		fmt.Print("\n\n")
-		for _, serverName := range ignoredServers {
-			fmt.Printf("ignored server %q because it does not support both UDP and TCP\n", serverName)
-		}
-	default:
-		fmt.Printf("Provider %q is not supported\n", *provider)
-		return 1
-	}
-	return 0
-}
-
-func nordvpn(client network.Client) (servers []models.NordvpnServer, ignoredServers []string, err error) {
-	content, status, err := client.GetContent("https://nordvpn.com/api/server")
-	if err != nil {
-		return nil, nil, err
-	} else if status != http.StatusOK {
-		return nil, nil, fmt.Errorf("HTTP status %d from NordVPN API", status)
-	}
-	response := []struct {
-		IPAddress string `json:"ip_address"`
-		Name      string `json:"name"`
-		Country   string `json:"country"`
-		Features  struct {
-			UDP bool `json:"openvpn_udp"`
-			TCP bool `json:"openvpn_tcp"`
-		} `json:"features"`
-	}{}
-	if err := json.Unmarshal(content, &response); err != nil {
-		return nil, nil, err
-	}
-
-	for _, element := range response {
-		if !element.Features.TCP && !element.Features.UDP {
-			ignoredServers = append(ignoredServers, element.Name)
-		}
-		ip := net.ParseIP(element.IPAddress)
-		if ip == nil {
-			return nil, nil, fmt.Errorf("IP address %q is not valid for server %q", element.IPAddress, element.Name)
-		}
-		i := strings.IndexRune(element.Name, '#')
-		if i < 0 {
-			return nil, nil, fmt.Errorf("No ID in server name %q", element.Name)
-		}
-		idString := element.Name[i+1:]
-		idUint64, err := strconv.ParseUint(idString, 10, 16)
-		if err != nil {
-			return nil, nil, fmt.Errorf("Bad ID in server name %q", element.Name)
-		}
-		id := uint16(idUint64)
-		server := models.NordvpnServer{
-			Region: element.Country,
-			Number: id,
-			IP:     ip,
-			TCP:    element.Features.TCP,
-			UDP:    element.Features.UDP,
-		}
-		servers = append(servers, server)
-	}
-	sort.Slice(servers, func(i, j int) bool {
-		if servers[i].Region == servers[j].Region {
-			return servers[i].Number < servers[j].Number
-		}
-		return servers[i].Region < servers[j].Region
-	})
-	return servers, ignoredServers, nil
-}

cmd/ovpnparser/main.go

@@ -1,152 +0,0 @@
-package main
-
-import (
-	"archive/zip"
-	"bytes"
-	"flag"
-	"fmt"
-	"io/ioutil"
-	"net"
-	"net/http"
-	"os"
-	"path/filepath"
-	"sort"
-	"strings"
-	"time"
-
-	"github.com/qdm12/golibs/network"
-)
-
-func main() {
-	os.Exit(_main())
-}
-
-// Find subdomains from .ovpn files contained in a .zip file
-func _main() int {
-	provider := flag.String("provider", "surfshark", "VPN provider to parse openvpn files for, can be 'surfshark' or 'vyprvpn")
-	flag.Parse()
-
-	var urls []string
-	var suffix string
-	switch *provider {
-	case "surfshark":
-		urls = []string{
-			"https://account.surfshark.com/api/v1/server/configurations",
-			"https://v2uploads.zopim.io/p/2/L/p2LbwLkvfQoSdzOl6VEltzQA6StiZqrs/12500634259669c77012765139bcfe4f4c90db1e.zip",
-		}
-		suffix = ".prod.surfshark.com"
-	case "vyprvpn":
-		urls = []string{
-			"https://support.vyprvpn.com/hc/article_attachments/360052617332/Vypr_OpenVPN_20200320.zip",
-		}
-		suffix = ".vyprvpn.com"
-	default:
-		fmt.Printf("Provider %q is not supported\n", *provider)
-		return 1
-	}
-	contents, err := fetchAndExtractFiles(urls...)
-	if err != nil {
-		fmt.Println(err)
-		return 1
-	}
-
-	uniqueSubdomainsToFilename := make(map[string]string)
-	for fileName, content := range contents {
-		subdomain, err := extractInformation(content, suffix)
-		if err != nil {
-			fmt.Println(err)
-			return 1
-		} else if len(subdomain) > 0 {
-			fileName = strings.TrimSuffix(fileName, ".ovpn")
-			fileName = strings.ReplaceAll(fileName, " - ", " ")
-			uniqueSubdomainsToFilename[subdomain] = fileName
-		}
-	}
-	type subdomainFilename struct {
-		subdomain string
-		fileName  string
-	}
-	subdomains := make([]subdomainFilename, len(uniqueSubdomainsToFilename))
-	i := 0
-	for subdomain, fileName := range uniqueSubdomainsToFilename {
-		subdomains[i] = subdomainFilename{
-			subdomain: subdomain,
-			fileName:  fileName,
-		}
-		i++
-	}
-	sort.Slice(subdomains, func(i, j int) bool {
-		return subdomains[i].subdomain < subdomains[j].subdomain
-	})
-	fmt.Println("Subdomain Filename")
-	for i := range subdomains {
-		fmt.Printf("%s %s\n", subdomains[i].subdomain, subdomains[i].fileName)
-	}
-	return 0
-}
-
-func fetchAndExtractFiles(urls ...string) (contents map[string][]byte, err error) {
-	client := network.NewClient(10 * time.Second)
-	contents = make(map[string][]byte)
-	for _, url := range urls {
-		zipBytes, status, err := client.GetContent(url)
-		if err != nil {
-			return nil, err
-		} else if status != http.StatusOK {
-			return nil, fmt.Errorf("Getting %s results in HTTP status code %d", url, status)
-		}
-		newContents, err := zipExtractAll(zipBytes)
-		if err != nil {
-			return nil, err
-		}
-		for fileName, content := range newContents {
-			contents[fileName] = content
-		}
-	}
-	return contents, nil
-}
-
-func zipExtractAll(zipBytes []byte) (contents map[string][]byte, err error) {
-	r, err := zip.NewReader(bytes.NewReader(zipBytes), int64(len(zipBytes)))
-	if err != nil {
-		return nil, err
-	}
-	contents = map[string][]byte{}
-	for _, zf := range r.File {
-		fileName := filepath.Base(zf.Name)
-		if !strings.HasSuffix(fileName, ".ovpn") {
-			continue
-		}
-		f, err := zf.Open()
-		if err != nil {
-			return nil, err
-		}
-		defer f.Close()
-		contents[fileName], err = ioutil.ReadAll(f)
-		if err != nil {
-			return nil, err
-		}
-		if err := f.Close(); err != nil {
-			return nil, err
-		}
-	}
-	return contents, nil
-}
-
-func extractInformation(content []byte, suffix string) (subdomain string, err error) {
-	lines := strings.Split(string(content), "\n")
-	for _, line := range lines {
-		if strings.HasPrefix(line, "remote ") {
-			words := strings.Fields(line)
-			if len(words) < 2 {
-				return "", fmt.Errorf("not enough words on line %q", line)
-			}
-			host := words[1]
-			if net.ParseIP(host) != nil {
-				return "", nil // ignore IP addresses
-			}
-			return strings.TrimSuffix(host, suffix), nil
-		}
-	}
-	return "", fmt.Errorf("could not find remote line in: %s", string(content))
-}

cmd/resolver/main.go

@@ -1,920 +0,0 @@
-package main
-
-import (
-	"bytes"
-	"context"
-	"flag"
-	"fmt"
-	"net"
-	"os"
-	"sort"
-	"strings"
-)
-
-func main() {
-	ctx := context.Background()
-	os.Exit(_main(ctx))
-}
-
-func _main(ctx context.Context) int {
-	resolverAddress := flag.String("resolver", "1.1.1.1", "DNS Resolver IP address to use")
-	provider := flag.String("provider", "pia", "VPN provider to resolve for, 'pia', 'windscribe', 'cyberghost', 'vyprvpn' or 'purevpn'")
-	region := flag.String("region", "all", "Comma separated list of VPN provider region names to resolve for, use 'all' to resolve all")
-	flag.Parse()
-
-	resolver := newResolver(*resolverAddress)
-	lookupIP := newLookupIP(resolver)
-
-	var domain string
-	var servers []server
-	switch *provider {
-	case "pia":
-		domain = "privateinternetaccess.com"
-		servers = piaServers()
-	case "windscribe":
-		domain = "windscribe.com"
-		servers = windscribeServers()
-	case "surfshark":
-		domain = "prod.surfshark.com"
-		servers = surfsharkServers()
-	case "cyberghost":
-		domain = "cg-dialup.net"
-		servers = cyberghostServers()
-	case "vyprvpn":
-		domain = "vyprvpn.com"
-		servers = vyprvpnServers()
-	case "purevpn":
-		domain = "pointtoserver.com"
-		servers = purevpnServers()
-	default:
-		fmt.Printf("Provider %q is not supported\n", *provider)
-		return 1
-	}
-	if *region != "all" {
-		regions := strings.Split(*region, ",")
-		uniqueRegions := make(map[string]struct{})
-		for _, r := range regions {
-			uniqueRegions[r] = struct{}{}
-		}
-		for i := range servers {
-			if _, ok := uniqueRegions[servers[i].region]; !ok {
-				servers[i] = servers[len(servers)-1]
-				servers = servers[:len(servers)-1]
-			}
-		}
-	}
-
-	stringChannel := make(chan string)
-	errorChannel := make(chan error)
-	const maxGoroutines = 10
-	guard := make(chan struct{}, maxGoroutines)
-	for _, s := range servers {
-		go func(s server) {
-			guard <- struct{}{}
-			ips, err := resolveRepeat(ctx, lookupIP, s.subdomain+"."+domain, 3)
-			<-guard
-			if err != nil {
-				errorChannel <- err
-				return
-			}
-			stringChannel <- formatLine(*provider, s, ips)
-		}(s)
-	}
-	var lines []string
-	var errors []error
-	for range servers {
-		select {
-		case err := <-errorChannel:
-			errors = append(errors, err)
-		case s := <-stringChannel:
-			lines = append(lines, s)
-		}
-	}
-	sort.Slice(lines, func(i, j int) bool {
-		return lines[i] < lines[j]
-	})
-	for _, s := range lines {
-		fmt.Println(s)
-	}
-	if len(errors) > 0 {
-		fmt.Printf("\n%d errors occurred, described below\n\n", len(errors))
-		for _, err := range errors {
-			fmt.Println(err)
-		}
-		return 1
-	}
-	return 0
-}
-
-func formatLine(provider string, s server, ips []net.IP) string {
-	ipStrings := make([]string, len(ips))
-	for i := range ips {
-		ipStrings[i] = fmt.Sprintf("{%s}", strings.ReplaceAll(ips[i].String(), ".", ", "))
-	}
-	ipString := strings.Join(ipStrings, ", ")
-	switch provider {
-	case "pia":
-		return fmt.Sprintf(
-			"{Region: %q, IPs: []net.IP{%s}},",
-			s.region, ipString,
-		)
-	case "windscribe":
-		return fmt.Sprintf(
-			"{Region: %q, IPs: []net.IP{%s}},",
-			s.region, ipString,
-		)
-	case "surfshark":
-		return fmt.Sprintf(
-			"{Region: %q, IPs: []net.IP{%s}},",
-			s.region, ipString,
-		)
-	case "cyberghost":
-		return fmt.Sprintf(
-			"{Region: %q, Group: %q, IPs: []net.IP{%s}},",
-			s.region, s.group, ipString,
-		)
-	case "vyprvpn":
-		return fmt.Sprintf(
-			"{Region: %q, IPs: []net.IP{%s}},",
-			s.region, ipString,
-		)
-	case "purevpn":
-		return fmt.Sprintf(
-			"{Region: %q, Country: %q, City: %q, IPs: []net.IP{%s}},",
-			s.region, s.country, s.city, ipString,
-		)
-	}
-	return ""
-}
-
-type lookupIPFunc func(ctx context.Context, host string) (ips []net.IP, err error)
-
-func newLookupIP(r *net.Resolver) lookupIPFunc {
-	return func(ctx context.Context, host string) (ips []net.IP, err error) {
-		addresses, err := r.LookupIPAddr(ctx, host)
-		if err != nil {
-			return nil, err
-		}
-		ips = make([]net.IP, len(addresses))
-		for i := range addresses {
-			ips[i] = addresses[i].IP
-		}
-		return ips, nil
-	}
-}
-
-func newResolver(ip string) *net.Resolver {
-	return &net.Resolver{
-		PreferGo: true,
-		Dial: func(ctx context.Context, network, address string) (net.Conn, error) {
-			d := net.Dialer{}
-			return d.DialContext(ctx, "udp", net.JoinHostPort(ip, "53"))
-		},
-	}
-}
-
-func resolveRepeat(ctx context.Context, lookupIP lookupIPFunc, host string, n int) (ips []net.IP, err error) {
-	for i := 0; i < n; i++ {
-		newIPs, err := lookupIP(ctx, host)
-		if err != nil {
-			return nil, err
-		}
-		ips = append(ips, newIPs...)
-	}
-	return uniqueSortedIPs(ips), nil
-}
-
-func uniqueSortedIPs(ips []net.IP) []net.IP {
-	uniqueIPs := make(map[string]struct{})
-	for _, ip := range ips {
-		uniqueIPs[ip.String()] = struct{}{}
-	}
-	ips = make([]net.IP, len(uniqueIPs))
-	i := 0
-	for ip := range uniqueIPs {
-		ips[i] = net.ParseIP(ip)
-		i++
-	}
-	sort.Slice(ips, func(i, j int) bool {
-		return bytes.Compare(ips[i], ips[j]) < 0
-	})
-	return ips
-}
-
-type server struct {
-	subdomain string
-	region    string
-	group     string // only for cyberghost
-	country   string // only for purevpn
-	city      string // only for purevpn
-}
-
-func piaServers() []server {
-	return []server{
-		{subdomain: "au-melbourne", region: "AU Melbourne"},
-		{subdomain: "au-perth", region: "AU Perth"},
-		{subdomain: "au-sydney", region: "AU Sydney"},
-		{subdomain: "austria", region: "Austria"},
-		{subdomain: "belgium", region: "Belgium"},
-		{subdomain: "ca-montreal", region: "CA Montreal"},
-		{subdomain: "ca-toronto", region: "CA Toronto"},
-		{subdomain: "ca-vancouver", region: "CA Vancouver"},
-		{subdomain: "czech", region: "Czech Republic"},
-		{subdomain: "de-berlin", region: "DE Berlin"},
-		{subdomain: "de-frankfurt", region: "DE Frankfurt"},
-		{subdomain: "denmark", region: "Denmark"},
-		{subdomain: "fi", region: "Finlan"},
-		{subdomain: "france", region: "France"},
-		{subdomain: "hk", region: "Hong Kong"},
-		{subdomain: "hungary", region: "Hungary"},
-		{subdomain: "in", region: "India"},
-		{subdomain: "ireland", region: "Ireland"},
-		{subdomain: "israel", region: "Israel"},
-		{subdomain: "italy", region: "Italy"},
-		{subdomain: "japan", region: "Japan"},
-		{subdomain: "lu", region: "Luxembourg"},
-		{subdomain: "mexico", region: "Mexico"},
-		{subdomain: "nl", region: "Netherlands"},
-		{subdomain: "nz", region: "New Zealand"},
-		{subdomain: "no", region: "Norway"},
-		{subdomain: "poland", region: "Poland"},
-		{subdomain: "ro", region: "Romania"},
-		{subdomain: "sg", region: "Singapore"},
-		{subdomain: "spain", region: "Spain"},
-		{subdomain: "sweden", region: "Sweden"},
-		{subdomain: "swiss", region: "Switzerland"},
-		{subdomain: "ae", region: "UAE"},
-		{subdomain: "uk-london", region: "UK London"},
-		{subdomain: "uk-manchester", region: "UK Manchester"},
-		{subdomain: "uk-southampton", region: "UK Southampton"},
-		{subdomain: "us-atlanta", region: "US Atlanta"},
-		{subdomain: "us-california", region: "US California"},
-		{subdomain: "us-chicago", region: "US Chicago"},
-		{subdomain: "us-denver", region: "US Denver"},
-		{subdomain: "us-east", region: "US East"},
-		{subdomain: "us-florida", region: "US Florida"},
-		{subdomain: "us-houston", region: "US Houston"},
-		{subdomain: "us-lasvegas", region: "US Las Vegas"},
-		{subdomain: "us-newyorkcity", region: "US New York City"},
-		{subdomain: "us-seattle", region: "US Seattle"},
-		{subdomain: "us-siliconvalley", region: "US Silicon Valley"},
-		{subdomain: "us-texas", region: "US Texas"},
-		{subdomain: "us-washingtondc", region: "US Washington DC"},
-		{subdomain: "us-west", region: "US West"},
-	}
-}
-
-func windscribeServers() []server {
-	return []server{
-		{subdomain: "al", region: "Albania"},
-		{subdomain: "ar", region: "Argentina"},
-		{subdomain: "au", region: "Australia"},
-		{subdomain: "at", region: "Austria"},
-		{subdomain: "az", region: "Azerbaijan"},
-		{subdomain: "be", region: "Belgium"},
-		{subdomain: "ba", region: "Bosnia"},
-		{subdomain: "br", region: "Brazil"},
-		{subdomain: "bg", region: "Bulgaria"},
-		{subdomain: "ca", region: "Canada East"},
-		{subdomain: "ca-west", region: "Canada West"},
-		{subdomain: "co", region: "Colombia"},
-		{subdomain: "hr", region: "Croatia"},
-		{subdomain: "cy", region: "Cyprus"},
-		{subdomain: "cz", region: "Czech republic"},
-		{subdomain: "dk", region: "Denmark"},
-		{subdomain: "ee", region: "Estonia"},
-		{subdomain: "aq", region: "Fake antarctica"},
-		{subdomain: "fi", region: "Finland"},
-		{subdomain: "fr", region: "France"},
-		{subdomain: "ge", region: "Georgia"},
-		{subdomain: "de", region: "Germany"},
-		{subdomain: "gr", region: "Greece"},
-		{subdomain: "hk", region: "Hong kong"},
-		{subdomain: "hu", region: "Hungary"},
-		{subdomain: "is", region: "Iceland"},
-		{subdomain: "in", region: "India"},
-		{subdomain: "id", region: "Indonesia"},
-		{subdomain: "ie", region: "Ireland"},
-		{subdomain: "il", region: "Israel"},
-		{subdomain: "it", region: "Italy"},
-		{subdomain: "jp", region: "Japan"},
-		{subdomain: "lv", region: "Latvia"},
-		{subdomain: "lt", region: "Lithuania"},
-		{subdomain: "mk", region: "Macedonia"},
-		{subdomain: "my", region: "Malaysia"},
-		{subdomain: "mx", region: "Mexico"},
-		{subdomain: "md", region: "Moldova"},
-		{subdomain: "nl", region: "Netherlands"},
-		{subdomain: "nz", region: "New zealand"},
-		{subdomain: "no", region: "Norway"},
-		{subdomain: "ph", region: "Philippines"},
-		{subdomain: "pl", region: "Poland"},
-		{subdomain: "pt", region: "Portugal"},
-		{subdomain: "ro", region: "Romania"},
-		{subdomain: "ru", region: "Russia"},
-		{subdomain: "rs", region: "Serbia"},
-		{subdomain: "sg", region: "Singapore"},
-		{subdomain: "sk", region: "Slovakia"},
-		{subdomain: "si", region: "Slovenia"},
-		{subdomain: "za", region: "South Africa"},
-		{subdomain: "kr", region: "South Korea"},
-		{subdomain: "es", region: "Spain"},
-		{subdomain: "se", region: "Sweden"},
-		{subdomain: "ch", region: "Switzerland"},
-		{subdomain: "th", region: "Thailand"},
-		{subdomain: "tn", region: "Tunisia"},
-		{subdomain: "tr", region: "Turkey"},
-		{subdomain: "ua", region: "Ukraine"},
-		{subdomain: "ae", region: "United Arab Emirates"},
-		{subdomain: "uk", region: "United Kingdom"},
-		{subdomain: "us-central", region: "US Central"},
-		{subdomain: "us-east", region: "US East"},
-		{subdomain: "us-west", region: "US West"},
-		{subdomain: "vn", region: "Vietnam"},
-		{subdomain: "wf-ca", region: "Windflix CA"},
-		{subdomain: "wf-jp", region: "Windflix JP"},
-		{subdomain: "wf-uk", region: "Windflix UK"},
-		{subdomain: "wf-us", region: "Windflix US"},
-	}
-}
-
-func surfsharkServers() []server {
-	return []server{
-		{subdomain: "ae-dub", region: "United Arab Emirates"},
-		{subdomain: "al-tia", region: "Albania"},
-		{subdomain: "at-vie", region: "Austria"},
-		{subdomain: "au-adl", region: "Australia Adelaide"},
-		{subdomain: "au-bne", region: "Australia Brisbane"},
-		{subdomain: "au-mel", region: "Australia Melbourne"},
-		{subdomain: "au-per", region: "Australia Perth"},
-		{subdomain: "au-syd", region: "Australia Sydney"},
-		{subdomain: "au-us", region: "Australia US"},
-		{subdomain: "az-bak", region: "Azerbaijan"},
-		{subdomain: "ba-sjj", region: "Bosnia and Herzegovina"},
-		{subdomain: "be-bru", region: "Belgium"},
-		{subdomain: "bg-sof", region: "Bulgaria"},
-		{subdomain: "br-sao", region: "Brazil"},
-		{subdomain: "ca-mon", region: "Canada Montreal"},
-		{subdomain: "ca-tor", region: "Canada Toronto"},
-		{subdomain: "ca-us", region: "Canada US"},
-		{subdomain: "ca-van", region: "Canada Vancouver"},
-		{subdomain: "ch-zur", region: "Switzerland"},
-		{subdomain: "cl-san", region: "Chile"},
-		{subdomain: "co-bog", region: "Colombia"},
-		{subdomain: "cr-sjn", region: "Costa Rica"},
-		{subdomain: "cy-nic", region: "Cyprus"},
-		{subdomain: "cz-prg", region: "Czech Republic"},
-		{subdomain: "de-ber", region: "Germany Berlin"},
-		{subdomain: "de-fra", region: "Germany Frankfurt am Main"},
-		{subdomain: "de-fra-st001", region: "Germany Frankfurt am Main st001"},
-		{subdomain: "de-fra-st002", region: "Germany Frankfurt am Main st002"},
-		{subdomain: "de-fra-st003", region: "Germany Frankfurt am Main st003"},
-		{subdomain: "de-muc", region: "Germany Munich"},
-		{subdomain: "de-nue", region: "Germany Nuremberg"},
-		{subdomain: "de-sg", region: "Germany Singapour"},
-		{subdomain: "de-uk", region: "Germany UK"},
-		{subdomain: "dk-cph", region: "Denmark"},
-		{subdomain: "ee-tll", region: "Estonia"},
-		{subdomain: "es-bcn", region: "Spain Barcelona"},
-		{subdomain: "es-mad", region: "Spain Madrid"},
-		{subdomain: "es-vlc", region: "Spain Valencia"},
-		{subdomain: "fi-hel", region: "Finland"},
-		{subdomain: "fr-bod", region: "France Bordeaux"},
-		{subdomain: "fr-mrs", region: "France Marseilles"},
-		{subdomain: "fr-par", region: "France Paris"},
-		{subdomain: "fr-se", region: "France Sweden"},
-		{subdomain: "gr-ath", region: "Greece"},
-		{subdomain: "hk-hkg", region: "Hong Kong"},
-		{subdomain: "hr-zag", region: "Croatia"},
-		{subdomain: "hu-bud", region: "Hungary"},
-		{subdomain: "id-jak", region: "Indonesia"},
-		{subdomain: "ie-dub", region: "Ireland"},
-		{subdomain: "il-tlv", region: "Israel"},
-		{subdomain: "in-chn", region: "India Chennai"},
-		{subdomain: "in-idr", region: "India Indore"},
-		{subdomain: "in-mum", region: "India Mumbai"},
-		{subdomain: "in-uk", region: "India UK"},
-		{subdomain: "is-rkv", region: "Iceland"},
-		{subdomain: "it-mil", region: "Italy Milan"},
-		{subdomain: "it-rom", region: "Italy Rome"},
-		{subdomain: "jp-tok", region: "Japan Tokyo"},
-		{subdomain: "jp-tok-st001", region: "Japan Tokyo st001"},
-		{subdomain: "jp-tok-st002", region: "Japan Tokyo st002"},
-		{subdomain: "jp-tok-st003", region: "Japan Tokyo st003"},
-		{subdomain: "jp-tok-st004", region: "Japan Tokyo st004"},
-		{subdomain: "jp-tok-st005", region: "Japan Tokyo st005"},
-		{subdomain: "jp-tok-st006", region: "Japan Tokyo st006"},
-		{subdomain: "jp-tok-st007", region: "Japan Tokyo st007"},
-		{subdomain: "kr-seo", region: "Korea"},
-		{subdomain: "kz-ura", region: "Kazakhstan"},
-		{subdomain: "lu-ste", region: "Luxembourg"},
-		{subdomain: "lv-rig", region: "Latvia"},
-		{subdomain: "ly-tip", region: "Libya"},
-		{subdomain: "md-chi", region: "Moldova"},
-		{subdomain: "mk-skp", region: "North Macedonia"},
-		{subdomain: "my-kul", region: "Malaysia"},
-		{subdomain: "ng-lag", region: "Nigeria"},
-		{subdomain: "nl-ams", region: "Netherlands Amsterdam"},
-		{subdomain: "nl-ams-st001", region: "Netherlands Amsterdam st001"},
-		{subdomain: "nl-us", region: "Netherlands US"},
-		{subdomain: "no-osl", region: "Norway"},
-		{subdomain: "nz-akl", region: "New Zealand"},
-		{subdomain: "ph-mnl", region: "Philippines"},
-		{subdomain: "pl-gdn", region: "Poland Gdansk"},
-		{subdomain: "pl-waw", region: "Poland Warsaw"},
-		{subdomain: "pt-lis", region: "Portugal Lisbon"},
-		{subdomain: "pt-lou", region: "Portugal Loule"},
-		{subdomain: "pt-opo", region: "Portugal Porto"},
-		{subdomain: "py-asu", region: "Paraguay"},
-		{subdomain: "ro-buc", region: "Romania"},
-		{subdomain: "rs-beg", region: "Serbia"},
-		{subdomain: "ru-mos", region: "Russia Moscow"},
-		{subdomain: "ru-spt", region: "Russia St. Petersburg"},
-		{subdomain: "se-sto", region: "Sweden"},
-		{subdomain: "sg-hk", region: "Singapore Hong Kong"},
-		{subdomain: "sg-nl", region: "Singapore Netherlands"},
-		{subdomain: "sg-sng", region: "Singapore"},
-		{subdomain: "sg-sng-st001", region: "Singapore st001"},
-		{subdomain: "sg-sng-st002", region: "Singapore st002"},
-		{subdomain: "sg-sng-st003", region: "Singapore st003"},
-		{subdomain: "sg-sng-st004", region: "Singapore st004"},
-		{subdomain: "si-lju", region: "Slovenia"},
-		{subdomain: "sk-bts", region: "Slovekia"},
-		{subdomain: "th-bkk", region: "Thailand"},
-		{subdomain: "tr-bur", region: "Turkey"},
-		{subdomain: "tw-tai", region: "Taiwan"},
-		{subdomain: "ua-iev", region: "Ukraine"},
-		{subdomain: "uk-de", region: "UK Germany"},
-		{subdomain: "uk-fr", region: "UK France"},
-		{subdomain: "uk-gla", region: "UK Glasgow"},
-		{subdomain: "uk-lon", region: "UK London"},
-		{subdomain: "uk-lon-st001", region: "UK London st001"},
-		{subdomain: "uk-lon-st002", region: "UK London st002"},
-		{subdomain: "uk-lon-st003", region: "UK London st003"},
-		{subdomain: "uk-lon-st004", region: "UK London st004"},
-		{subdomain: "uk-lon-st005", region: "UK London st005"},
-		{subdomain: "uk-man", region: "UK Manchester"},
-		{subdomain: "us-atl", region: "US Atlanta"},
-		{subdomain: "us-bdn", region: "US Bend"},
-		{subdomain: "us-bos", region: "US Boston"},
-		{subdomain: "us-buf", region: "US Buffalo"},
-		{subdomain: "us-chi", region: "US Chicago"},
-		{subdomain: "us-clt", region: "US Charlotte"},
-		{subdomain: "us-dal", region: "US Dallas"},
-		{subdomain: "us-den", region: "US Denver"},
-		{subdomain: "us-dtw", region: "US Gahanna"},
-		{subdomain: "us-hou", region: "US Houston"},
-		{subdomain: "us-kan", region: "US Kansas City"},
-		{subdomain: "us-las", region: "US Las Vegas"},
-		{subdomain: "us-lax", region: "US Los Angeles"},
-		{subdomain: "us-ltm", region: "US Latham"},
-		{subdomain: "us-mia", region: "US Miami"},
-		{subdomain: "us-mnz", region: "US Maryland"},
-		{subdomain: "us-nl", region: "US Netherlands"},
-		{subdomain: "us-nyc", region: "US New York City"},
-		{subdomain: "us-nyc-mp001", region: "US New York City mp001"},
-		{subdomain: "us-nyc-st001", region: "US New York City st001"},
-		{subdomain: "us-nyc-st002", region: "US New York City st002"},
-		{subdomain: "us-nyc-st003", region: "US New York City st003"},
-		{subdomain: "us-nyc-st004", region: "US New York City st004"},
-		{subdomain: "us-nyc-st005", region: "US New York City st005"},
-		{subdomain: "us-orl", region: "US Orlando"},
-		{subdomain: "us-phx", region: "US Phoenix"},
-		{subdomain: "us-pt", region: "US Portugal"},
-		{subdomain: "us-sea", region: "US Seatle"},
-		{subdomain: "us-sfo", region: "US San Francisco"},
-		{subdomain: "us-slc", region: "US Salt Lake City"},
-		{subdomain: "us-stl", region: "US Saint Louis"},
-		{subdomain: "us-tpa", region: "US Tampa"},
-		{subdomain: "vn-hcm", region: "Vietnam"},
-		{subdomain: "za-jnb", region: "South Africa"},
-	}
-}
-
-func cyberghostServers() []server {
-	return []server{
-		{subdomain: "97-1-al", region: "Albania", group: "Premium TCP Europe"},
-		{subdomain: "87-1-al", region: "Albania", group: "Premium UDP Europe"},
-		{subdomain: "87-1-dz", region: "Algeria", group: "Premium UDP Europe"},
-		{subdomain: "97-1-dz", region: "Algeria", group: "Premium TCP Europe"},
-		{subdomain: "97-1-ad", region: "Andorra", group: "Premium TCP Europe"},
-		{subdomain: "87-1-ad", region: "Andorra", group: "Premium UDP Europe"},
-		{subdomain: "94-1-ar", region: "Argentina", group: "Premium UDP USA"},
-		{subdomain: "93-1-ar", region: "Argentina", group: "Premium TCP USA"},
-		{subdomain: "87-1-am", region: "Armenia", group: "Premium UDP Europe"},
-		{subdomain: "97-1-am", region: "Armenia", group: "Premium TCP Europe"},
-		{subdomain: "95-1-au", region: "Australia", group: "Premium UDP Asia"},
-		{subdomain: "96-1-au", region: "Australia", group: "Premium TCP Asia"},
-		{subdomain: "97-1-at", region: "Austria", group: "Premium TCP Europe"},
-		{subdomain: "87-1-at", region: "Austria", group: "Premium UDP Europe"},
-		{subdomain: "93-1-bs", region: "Bahamas", group: "Premium TCP USA"},
-		{subdomain: "94-1-bs", region: "Bahamas", group: "Premium UDP USA"},
-		{subdomain: "95-1-bd", region: "Bangladesh", group: "Premium UDP Asia"},
-		{subdomain: "96-1-bd", region: "Bangladesh", group: "Premium TCP Asia"},
-		{subdomain: "97-1-by", region: "Belarus", group: "Premium TCP Europe"},
-		{subdomain: "87-1-by", region: "Belarus", group: "Premium UDP Europe"},
-		{subdomain: "97-1-be", region: "Belgium", group: "Premium TCP Europe"},
-		{subdomain: "87-1-be", region: "Belgium", group: "Premium UDP Europe"},
-		{subdomain: "87-1-ba", region: "Bosnia and Herzegovina", group: "Premium UDP Europe"},
-		{subdomain: "97-1-ba", region: "Bosnia and Herzegovina", group: "Premium TCP Europe"},
-		{subdomain: "94-1-br", region: "Brazil", group: "Premium UDP USA"},
-		{subdomain: "93-1-br", region: "Brazil", group: "Premium TCP USA"},
-		{subdomain: "87-1-bg", region: "Bulgaria", group: "Premium UDP Europe"},
-		{subdomain: "97-1-bg", region: "Bulgaria", group: "Premium TCP Europe"},
-		{subdomain: "96-1-kh", region: "Cambodia", group: "Premium TCP Asia"},
-		{subdomain: "95-1-kh", region: "Cambodia", group: "Premium UDP Asia"},
-		{subdomain: "93-1-ca", region: "Canada", group: "Premium TCP USA"},
-		{subdomain: "94-1-ca", region: "Canada", group: "Premium UDP USA"},
-		{subdomain: "93-1-cl", region: "Chile", group: "Premium TCP USA"},
-		{subdomain: "94-1-cl", region: "Chile", group: "Premium UDP USA"},
-		{subdomain: "96-1-cn", region: "China", group: "Premium TCP Asia"},
-		{subdomain: "95-1-cn", region: "China", group: "Premium UDP Asia"},
-		{subdomain: "94-1-co", region: "Colombia", group: "Premium UDP USA"},
-		{subdomain: "93-1-co", region: "Colombia", group: "Premium TCP USA"},
-		{subdomain: "93-1-cr", region: "Costa Rica", group: "Premium TCP USA"},
-		{subdomain: "94-1-cr", region: "Costa Rica", group: "Premium UDP USA"},
-		{subdomain: "87-1-cy", region: "Cyprus", group: "Premium UDP Europe"},
-		{subdomain: "97-1-cy", region: "Cyprus", group: "Premium TCP Europe"},
-		{subdomain: "97-1-cz", region: "Czech Republic", group: "Premium TCP Europe"},
-		{subdomain: "87-1-cz", region: "Czech Republic", group: "Premium UDP Europe"},
-		{subdomain: "87-1-dk", region: "Denmark", group: "Premium UDP Europe"},
-		{subdomain: "97-1-dk", region: "Denmark", group: "Premium TCP Europe"},
-		{subdomain: "87-1-eg", region: "Egypt", group: "Premium UDP Europe"},
-		{subdomain: "97-1-eg", region: "Egypt", group: "Premium TCP Europe"},
-		{subdomain: "87-1-ee", region: "Estonia", group: "Premium UDP Europe"},
-		{subdomain: "97-1-ee", region: "Estonia", group: "Premium TCP Europe"},
-		{subdomain: "97-1-fi", region: "Finland", group: "Premium TCP Europe"},
-		{subdomain: "87-1-fi", region: "Finland", group: "Premium UDP Europe"},
-		{subdomain: "87-1-fr", region: "France", group: "Premium UDP Europe"},
-		{subdomain: "97-1-fr", region: "France", group: "Premium TCP Europe"},
-		{subdomain: "87-1-ge", region: "Georgia", group: "Premium UDP Europe"},
-		{subdomain: "97-1-ge", region: "Georgia", group: "Premium TCP Europe"},
-		{subdomain: "97-1-de", region: "Germany", group: "Premium TCP Europe"},
-		{subdomain: "87-1-de", region: "Germany", group: "Premium UDP Europe"},
-		{subdomain: "87-1-gr", region: "Greece", group: "Premium UDP Europe"},
-		{subdomain: "97-1-gr", region: "Greece", group: "Premium TCP Europe"},
-		{subdomain: "97-1-gl", region: "Greenland", group: "Premium TCP Europe"},
-		{subdomain: "87-1-gl", region: "Greenland", group: "Premium UDP Europe"},
-		{subdomain: "96-1-hk", region: "Hong Kong", group: "Premium TCP Asia"},
-		{subdomain: "95-1-hk", region: "Hong Kong", group: "Premium UDP Asia"},
-		{subdomain: "87-1-hu", region: "Hungary", group: "Premium UDP Europe"},
-		{subdomain: "97-1-hu", region: "Hungary", group: "Premium TCP Europe"},
-		{subdomain: "97-1-is", region: "Iceland", group: "Premium TCP Europe"},
-		{subdomain: "87-1-is", region: "Iceland", group: "Premium UDP Europe"},
-		{subdomain: "87-1-in", region: "India", group: "Premium UDP Europe"},
-		{subdomain: "97-1-in", region: "India", group: "Premium TCP Europe"},
-		{subdomain: "95-1-id", region: "Indonesia", group: "Premium UDP Asia"},
-		{subdomain: "96-1-id", region: "Indonesia", group: "Premium TCP Asia"},
-		{subdomain: "87-1-ir", region: "Iran", group: "Premium UDP Europe"},
-		{subdomain: "97-1-ir", region: "Iran", group: "Premium TCP Europe"},
-		{subdomain: "87-1-ie", region: "Ireland", group: "Premium UDP Europe"},
-		{subdomain: "97-1-ie", region: "Ireland", group: "Premium TCP Europe"},
-		{subdomain: "87-1-im", region: "Isle of Man", group: "Premium UDP Europe"},
-		{subdomain: "97-1-im", region: "Isle of Man", group: "Premium TCP Europe"},
-		{subdomain: "87-1-il", region: "Israel", group: "Premium UDP Europe"},
-		{subdomain: "97-1-il", region: "Israel", group: "Premium TCP Europe"},
-		{subdomain: "97-1-it", region: "Italy", group: "Premium TCP Europe"},
-		{subdomain: "87-1-it", region: "Italy", group: "Premium UDP Europe"},
-		{subdomain: "95-1-jp", region: "Japan", group: "Premium UDP Asia"},
-		{subdomain: "96-1-jp", region: "Japan", group: "Premium TCP Asia"},
-		{subdomain: "97-1-kz", region: "Kazakhstan", group: "Premium TCP Europe"},
-		{subdomain: "87-1-kz", region: "Kazakhstan", group: "Premium UDP Europe"},
-		{subdomain: "95-1-ke", region: "Kenya", group: "Premium UDP Asia"},
-		{subdomain: "96-1-ke", region: "Kenya", group: "Premium TCP Asia"},
-		{subdomain: "95-1-kr", region: "Korea", group: "Premium UDP Asia"},
-		{subdomain: "96-1-kr", region: "Korea", group: "Premium TCP Asia"},
-		{subdomain: "97-1-lv", region: "Latvia", group: "Premium TCP Europe"},
-		{subdomain: "87-1-lv", region: "Latvia", group: "Premium UDP Europe"},
-		{subdomain: "97-1-li", region: "Liechtenstein", group: "Premium TCP Europe"},
-		{subdomain: "87-1-li", region: "Liechtenstein", group: "Premium UDP Europe"},
-		{subdomain: "97-1-lt", region: "Lithuania", group: "Premium TCP Europe"},
-		{subdomain: "87-1-lt", region: "Lithuania", group: "Premium UDP Europe"},
-		{subdomain: "87-1-lu", region: "Luxembourg", group: "Premium UDP Europe"},
-		{subdomain: "97-1-lu", region: "Luxembourg", group: "Premium TCP Europe"},
-		{subdomain: "96-1-mo", region: "Macao", group: "Premium TCP Asia"},
-		{subdomain: "95-1-mo", region: "Macao", group: "Premium UDP Asia"},
-		{subdomain: "97-1-mk", region: "Macedonia", group: "Premium TCP Europe"},
-		{subdomain: "87-1-mk", region: "Macedonia", group: "Premium UDP Europe"},
-		{subdomain: "95-1-my", region: "Malaysia", group: "Premium UDP Asia"},
-		{subdomain: "96-1-my", region: "Malaysia", group: "Premium TCP Asia"},
-		{subdomain: "87-1-mt", region: "Malta", group: "Premium UDP Europe"},
-		{subdomain: "97-1-mt", region: "Malta", group: "Premium TCP Europe"},
-		{subdomain: "93-1-mx", region: "Mexico", group: "Premium TCP USA"},
-		{subdomain: "94-1-mx", region: "Mexico", group: "Premium UDP USA"},
-		{subdomain: "87-1-md", region: "Moldova", group: "Premium UDP Europe"},
-		{subdomain: "97-1-md", region: "Moldova", group: "Premium TCP Europe"},
-		{subdomain: "87-1-mc", region: "Monaco", group: "Premium UDP Europe"},
-		{subdomain: "97-1-mc", region: "Monaco", group: "Premium TCP Europe"},
-		{subdomain: "96-1-mn", region: "Mongolia", group: "Premium TCP Asia"},
-		{subdomain: "95-1-mn", region: "Mongolia", group: "Premium UDP Asia"},
-		{subdomain: "87-1-me", region: "Montenegro", group: "Premium UDP Europe"},
-		{subdomain: "97-1-me", region: "Montenegro", group: "Premium TCP Europe"},
-		{subdomain: "97-1-ma", region: "Morocco", group: "Premium TCP Europe"},
-		{subdomain: "87-1-ma", region: "Morocco", group: "Premium UDP Europe"},
-		{subdomain: "97-1-nl", region: "Netherlands", group: "Premium TCP Europe"},
-		{subdomain: "87-1-nl", region: "Netherlands", group: "Premium UDP Europe"},
-		{subdomain: "95-1-nz", region: "New Zealand", group: "Premium UDP Asia"},
-		{subdomain: "96-1-nz", region: "New Zealand", group: "Premium TCP Asia"},
-		{subdomain: "87-1-ng", region: "Nigeria", group: "Premium UDP Europe"},
-		{subdomain: "97-1-ng", region: "Nigeria", group: "Premium TCP Europe"},
-		{subdomain: "97-1-no", region: "Norway", group: "Premium TCP Europe"},
-		{subdomain: "87-1-no", region: "Norway", group: "Premium UDP Europe"},
-		{subdomain: "97-1-pk", region: "Pakistan", group: "Premium TCP Europe"},
-		{subdomain: "87-1-pk", region: "Pakistan", group: "Premium UDP Europe"},
-		{subdomain: "97-1-pa", region: "Panama", group: "Premium TCP Europe"},
-		{subdomain: "87-1-pa", region: "Panama", group: "Premium UDP Europe"},
-		{subdomain: "95-1-ph", region: "Philippines", group: "Premium UDP Asia"},
-		{subdomain: "96-1-ph", region: "Philippines", group: "Premium TCP Asia"},
-		{subdomain: "97-1-pl", region: "Poland", group: "Premium TCP Europe"},
-		{subdomain: "87-1-pl", region: "Poland", group: "Premium UDP Europe"},
-		{subdomain: "97-1-pt", region: "Portugal", group: "Premium TCP Europe"},
-		{subdomain: "87-1-pt", region: "Portugal", group: "Premium UDP Europe"},
-		{subdomain: "97-1-qa", region: "Qatar", group: "Premium TCP Europe"},
-		{subdomain: "87-1-qa", region: "Qatar", group: "Premium UDP Europe"},
-		{subdomain: "87-1-ro", region: "Romania", group: "Premium UDP Europe"},
-		{subdomain: "87-8-ro", region: "Romania", group: "NoSpy UDP Europe"},
-		{subdomain: "97-8-ro", region: "Romania", group: "NoSpy TCP Europe"},
-		{subdomain: "97-1-ro", region: "Romania", group: "Premium TCP Europe"},
-		{subdomain: "87-1-ru", region: "Russian Federation", group: "Premium UDP Europe"},
-		{subdomain: "97-1-ru", region: "Russian Federation", group: "Premium TCP Europe"},
-		{subdomain: "97-1-sa", region: "Saudi Arabia", group: "Premium TCP Europe"},
-		{subdomain: "87-1-sa", region: "Saudi Arabia", group: "Premium UDP Europe"},
-		{subdomain: "97-1-rs", region: "Serbia", group: "Premium TCP Europe"},
-		{subdomain: "87-1-rs", region: "Serbia", group: "Premium UDP Europe"},
-		{subdomain: "95-1-sg", region: "Singapore", group: "Premium UDP Asia"},
-		{subdomain: "96-1-sg", region: "Singapore", group: "Premium TCP Asia"},
-		{subdomain: "87-1-sk", region: "Slovakia", group: "Premium UDP Europe"},
-		{subdomain: "97-1-sk", region: "Slovakia", group: "Premium TCP Europe"},
-		{subdomain: "87-1-si", region: "Slovenia", group: "Premium UDP Europe"},
-		{subdomain: "97-1-si", region: "Slovenia", group: "Premium TCP Europe"},
-		{subdomain: "87-1-za", region: "South Africa", group: "Premium UDP Europe"},
-		{subdomain: "95-1-za", region: "South Africa", group: "Premium UDP Asia"},
-		{subdomain: "97-1-za", region: "South Africa", group: "Premium TCP Europe"},
-		{subdomain: "96-1-za", region: "South Africa", group: "Premium TCP Asia"},
-		{subdomain: "97-1-es", region: "Spain", group: "Premium TCP Europe"},
-		{subdomain: "87-1-es", region: "Spain", group: "Premium UDP Europe"},
-		{subdomain: "97-1-lk", region: "Sri Lanka", group: "Premium TCP Europe"},
-		{subdomain: "87-1-lk", region: "Sri Lanka", group: "Premium UDP Europe"},
-		{subdomain: "97-1-se", region: "Sweden", group: "Premium TCP Europe"},
-		{subdomain: "87-1-se", region: "Sweden", group: "Premium UDP Europe"},
-		{subdomain: "87-1-ch", region: "Switzerland", group: "Premium UDP Europe"},
-		{subdomain: "97-1-ch", region: "Switzerland", group: "Premium TCP Europe"},
-		{subdomain: "96-1-tw", region: "Taiwan", group: "Premium TCP Asia"},
-		{subdomain: "95-1-tw", region: "Taiwan", group: "Premium UDP Asia"},
-		{subdomain: "96-1-th", region: "Thailand", group: "Premium TCP Asia"},
-		{subdomain: "95-1-th", region: "Thailand", group: "Premium UDP Asia"},
-		{subdomain: "87-1-tr", region: "Turkey", group: "Premium UDP Europe"},
-		{subdomain: "97-1-tr", region: "Turkey", group: "Premium TCP Europe"},
-		{subdomain: "97-1-ua", region: "Ukraine", group: "Premium TCP Europe"},
-		{subdomain: "87-1-ua", region: "Ukraine", group: "Premium UDP Europe"},
-		{subdomain: "87-1-ae", region: "United Arab Emirates", group: "Premium UDP Europe"},
-		{subdomain: "97-1-ae", region: "United Arab Emirates", group: "Premium TCP Europe"},
-		{subdomain: "97-1-gb", region: "United Kingdom", group: "Premium TCP Europe"},
-		{subdomain: "87-1-gb", region: "United Kingdom", group: "Premium UDP Europe"},
-		{subdomain: "94-1-us", region: "United States", group: "Premium UDP USA"},
-		{subdomain: "93-1-us", region: "United States", group: "Premium TCP USA"},
-		{subdomain: "87-1-ve", region: "Venezuela", group: "Premium UDP Europe"},
-		{subdomain: "97-1-ve", region: "Venezuela", group: "Premium TCP Europe"},
-		{subdomain: "95-1-vn", region: "Vietnam", group: "Premium UDP Asia"},
-		{subdomain: "96-1-vn", region: "Vietnam", group: "Premium TCP Asia"},
-	}
-}
-
-func vyprvpnServers() []server {
-	return []server{
-		{subdomain: "ae1", region: "Dubai"},
-		{subdomain: "ar1", region: "Argentina"},
-		{subdomain: "at1", region: "Austria"},
-		{subdomain: "au1", region: "Australia Sydney"},
-		{subdomain: "au2", region: "Australia Melbourne"},
-		{subdomain: "au3", region: "Australia Perth"},
-		{subdomain: "be1", region: "Belgium"},
-		{subdomain: "bg1", region: "Bulgaria"},
-		{subdomain: "bh1", region: "Bahrain"},
-		{subdomain: "br1", region: "Brazil"},
-		{subdomain: "ca1", region: "Canada"},
-		{subdomain: "ch1", region: "Switzerland"},
-		{subdomain: "co1", region: "Columbia"},
-		{subdomain: "cr1", region: "Costa Rica"},
-		{subdomain: "cz1", region: "Czech Republic"},
-		{subdomain: "de1", region: "Germany"},
-		{subdomain: "dk1", region: "Denmark"},
-		{subdomain: "dz1", region: "Algeria"},
-		{subdomain: "eg1", region: "Egypt"},
-		{subdomain: "es1", region: "Spain"},
-		{subdomain: "eu1", region: "Netherlands"},
-		{subdomain: "fi1", region: "Finland"},
-		{subdomain: "fr1", region: "France"},
-		{subdomain: "gr1", region: "Greece"},
-		{subdomain: "hk1", region: "Hong Kong"},
-		{subdomain: "id1", region: "Indonesia"},
-		{subdomain: "ie1", region: "Ireland"},
-		{subdomain: "il1", region: "Israel"},
-		{subdomain: "in1", region: "India"},
-		{subdomain: "is1", region: "Iceland"},
-		{subdomain: "it1", region: "Italy"},
-		{subdomain: "jp1", region: "Japan"},
-		{subdomain: "kr1", region: "South Korea"},
-		{subdomain: "li1", region: "Liechtenstein"},
-		{subdomain: "lt1", region: "Lithuania"},
-		{subdomain: "lu1", region: "Luxembourg"},
-		{subdomain: "lv1", region: "Latvia"},
-		{subdomain: "mh1", region: "Marshall Islands"},
-		{subdomain: "mo1", region: "Macao"},
-		{subdomain: "mv1", region: "Maldives"},
-		{subdomain: "mx1", region: "Mexico"},
-		{subdomain: "my1", region: "Malaysia"},
-		{subdomain: "no1", region: "Norway"},
-		{subdomain: "nz1", region: "New Zealand"},
-		{subdomain: "pa1", region: "Panama"},
-		{subdomain: "ph1", region: "Philippines"},
-		{subdomain: "pk1", region: "Pakistan"},
-		{subdomain: "pl1", region: "Poland"},
-		{subdomain: "pt1", region: "Portugal"},
-		{subdomain: "qa1", region: "Qatar"},
-		{subdomain: "ro1", region: "Romania"},
-		{subdomain: "ru1", region: "Russia"},
-		{subdomain: "sa1", region: "Saudi Arabia"},
-		{subdomain: "se1", region: "Sweden"},
-		{subdomain: "sg1", region: "Singapore"},
-		{subdomain: "si1", region: "Slovenia"},
-		{subdomain: "sk1", region: "Slovakia"},
-		{subdomain: "sv1", region: "El Salvador"},
-		{subdomain: "th1", region: "Thailand"},
-		{subdomain: "tr1", region: "Turkey"},
-		{subdomain: "tw1", region: "Taiwan"},
-		{subdomain: "ua1", region: "Ukraine"},
-		{subdomain: "uk1", region: "United Kingdom"},
-		{subdomain: "us1", region: "USA Los Angeles"},
-		{subdomain: "us2", region: "USA Washington DC"},
-		{subdomain: "us3", region: "USA Austin"},
-		{subdomain: "us4", region: "USA Miami"},
-		{subdomain: "us5", region: "USA New York"},
-		{subdomain: "us6", region: "USA Chicago"},
-		{subdomain: "us7", region: "USA San Francisco"},
-		{subdomain: "us8", region: "USA Seattle"},
-		{subdomain: "uy1", region: "Uruguay"},
-		{subdomain: "vn1", region: "Vietnam"},
-	}
-}
-
-func purevpnServers() []server {
-	servers := []server{
-		{subdomain: "vlus-dz1-ovpn", region: "Africa", country: "Algeria", city: "Algiers"},
-		{subdomain: "vlus-ao1-ovpn", region: "Africa", country: "Angola", city: "Benguela"},
-		{subdomain: "vleu-cv-ovpn", region: "Africa", country: "Cape Verde", city: "Praia"},
-		{subdomain: "vlus-eg1-ovpn", region: "Africa", country: "Egypt", city: "Cairo"},
-		{subdomain: "et1-ovpn", region: "Africa", country: "Ethiopia", city: "Addis Ababa"},
-		{subdomain: "gh1-ovpn", region: "Africa", country: "Ghana", city: "Accra"},
-		{subdomain: "ke1-ovpn", region: "Africa", country: "Kenya", city: "Mombasa"},
-		{subdomain: "vlus-mg1-ovpn", region: "Africa", country: "Madagascar", city: "Antananarivo"},
-		{subdomain: "vlus-mr1-ovpn", region: "Africa", country: "Mauritania", city: "Nouakchott"},
-		{subdomain: "mu1-ovpn", region: "Africa", country: "Mauritius", city: "Port Louis"},
-		{subdomain: "ma1-ovpn", region: "Africa", country: "Morocco", city: "Rabat"},
-		{subdomain: "vlus-ne1-ovpn", region: "Africa", country: "Niger", city: "Niamey"},
-		{subdomain: "ng1-ovpn", region: "Africa", country: "Nigeria", city: "Suleja"},
-		{subdomain: "vlus-sn1-ovpn", region: "Africa", country: "Senegal", city: "Dakar"},
-		{subdomain: "sc1-ovpn", region: "Africa", country: "Seychelles", city: "Victoria"},
-		{subdomain: "za2-ovpn", region: "Africa", country: "South Africa", city: "Johannesburg"},
-		{subdomain: "vlus-tz1-ovpn", region: "Africa", country: "Tanzania", city: "Dar Es Salaam"},
-		{subdomain: "vlus-tn1-ovpn", region: "Africa", country: "Tunisia", city: "Tunis"},
-		{subdomain: "vlus-af1-ovpn", region: "Asia", country: "Afghanistan", city: "Kabul"},
-		{subdomain: "sg2-ovpn", region: "Asia", country: "Armenia", city: "Singapore"},
-		{subdomain: "az1-ovpn", region: "Asia", country: "Azerbaijan", city: "Baku"},
-		{subdomain: "vlus-bd1-ovpn", region: "Asia", country: "Bangladesh", city: "Dhaka"},
-		{subdomain: "bn2-ovpn", region: "Asia", country: "Brunei Darussalam", city: "Bandar Seri Begawan"},
-		{subdomain: "kh1-ovpn", region: "Asia", country: "Cambodia", city: "Phnom Penh"},
-		{subdomain: "hk2-ovpn", region: "Asia", country: "Hong Kong (SAR)", city: "Hong Kong"},
-		{subdomain: "in2-ovpn", region: "Asia", country: "India", city: "Chennai"},
-		{subdomain: "idn1-ovpn", region: "Asia", country: "Indonesia", city: "Jakarta"},
-		{subdomain: "jp-tk1-ovpn", region: "Asia", country: "Japan", city: "Tokyo"},
-		{subdomain: "vlus-kz1-ovpn", region: "Asia", country: "Kazakhstan", city: "Almaty"},
-		{subdomain: "kr2-ovpn", region: "Asia", country: "Korea, South", city: "Seoul"},
-		{subdomain: "vlus-kg1-ovpn", region: "Asia", country: "Kyrgyzstan", city: "Bishkek"},
-		{subdomain: "vlus-la1-ovpn", region: "Asia", country: "Laos", city: "Vientiane"},
-		{subdomain: "mo1-ovpn", region: "Asia", country: "Macao", city: "Beyrouth"},
-		{subdomain: "my2-ovpn", region: "Asia", country: "Malaysia", city: "Johor Baharu"},
-		{subdomain: "my-kl2-ovpn", region: "Asia", country: "Malaysia", city: "Kuala Lumpur"},
-		{subdomain: "vlus-mn1-ovpn", region: "Asia", country: "Mongolia", city: "Ulaanbaatar"},
-		{subdomain: "pk1-ovpn", region: "Asia", country: "Pakistan", city: "Islamabad"},
-		{subdomain: "vlus-pg1-ovpn", region: "Asia", country: "Papua New Guinea", city: "Port Moresby"},
-		{subdomain: "vlap-ph2-ovpn", region: "Asia", country: "Philippines", city: "Manila"},
-		{subdomain: "vlus-lk1-ovpn", region: "Asia", country: "Sri Lanka", city: "Colombo"},
-		{subdomain: "tw2-ovpn", region: "Asia", country: "Taiwan", city: "Taipei"},
-		{subdomain: "vlus-tj-ovpn", region: "Asia", country: "Tajikistan", city: "Dushanbe"},
-		{subdomain: "vlap-th2-ovpn", region: "Asia", country: "Thailand", city: "Bangkok"},
-		{subdomain: "tr2-ovpn", region: "Asia", country: "Turkey", city: "Istanbul"},
-		{subdomain: "vlus-tm1-ovpn", region: "Asia", country: "Turkmenistan", city: "Ashgabat"},
-		{subdomain: "vlus-uz-ovpn", region: "Asia", country: "Uzbekistan", city: "Tashkent"},
-		{subdomain: "vlap-vn2-ovpn", region: "Asia", country: "Vietnam", city: "Hanoi"},
-		{subdomain: "al1-ovpn", region: "Europe", country: "Albania", city: "Tirane"},
-		{subdomain: "vleu-am1-ovpn", region: "Europe", country: "Armenia", city: "Yerevan"},
-		{subdomain: "at2-ovpn", region: "Europe", country: "Austria", city: "Vienna"},
-		{subdomain: "vleu-be2-ovpn", region: "Europe", country: "Belgium", city: "Brussels"},
-		{subdomain: "ba1-ovpn", region: "Europe", country: "Bosnia and Herzegovina", city: "Sarajevo"},
-		{subdomain: "bg2-ovpn", region: "Europe", country: "Bulgaria", city: "Sofia"},
-		{subdomain: "vlus-hr1-ovpn", region: "Europe", country: "Croatia", city: "Zagreb"},
-		{subdomain: "cy1-ovpn", region: "Europe", country: "Cyprus", city: "Nicosia"},
-		{subdomain: "dk2-ovpn", region: "Europe", country: "Denmark", city: "Copenhagen"},
-		{subdomain: "ee1-ovpn", region: "Europe", country: "Estonia", city: "Tallinn"},
-		{subdomain: "fr2-ovpn", region: "Europe", country: "France", city: "Paris"},
-		{subdomain: "vlus-ge1-ovpn", region: "Europe", country: "Georgia", city: "Tbilisi"},
-		{subdomain: "de2-ovpn", region: "Europe", country: "Germany", city: "Frankfurt"},
-		{subdomain: "de2-ovpn", region: "Europe", country: "Germany", city: "Munich"},
-		{subdomain: "de-ao1-ovpn", region: "Europe", country: "Germany", city: "Nuremberg"},
-		{subdomain: "gr2-ovpn", region: "Europe", country: "Greece", city: "Thessaloniki"},
-		{subdomain: "hu2-ovpn", region: "Europe", country: "Hungary", city: "Budapest"},
-		{subdomain: "is1-ovpn", region: "Europe", country: "Iceland", city: "Reykjavik"},
-		{subdomain: "ie2-ovpn", region: "Europe", country: "Ireland", city: "Dublin"},
-		{subdomain: "im1-ovpn", region: "Europe", country: "Isle of Man", city: "Onchan"},
-		{subdomain: "vlus-it1-ovpn", region: "Europe", country: "Italy", city: "Milano"},
-		{subdomain: "lv1-ovpn", region: "Europe", country: "Latvia", city: "RIGA"},
-		{subdomain: "li1-ovpn", region: "Europe", country: "Liechtenstein", city: "Vaduz"},
-		{subdomain: "lt1-ovpn", region: "Europe", country: "Lithuania", city: "Vilnius"},
-		{subdomain: "lu2-ovpn", region: "Europe", country: "Luxembourg", city: "Luxembourg"},
-		{subdomain: "mt1-ovpn", region: "Europe", country: "Malta", city: "Sliema"},
-		{subdomain: "mn1-ovpn", region: "Europe", country: "Monaco", city: "Monaco"},
-		{subdomain: "vleu-me1-ovpn", region: "Europe", country: "Montenegro", city: "Podgorica"},
-		{subdomain: "nl2-ovpn", region: "Europe", country: "Netherlands", city: "Amsterdam"},
-		{subdomain: "vleu-no2-ovpn", region: "Europe", country: "Norway", city: "Oslo"},
-		{subdomain: "pl2-ovpn", region: "Europe", country: "Poland", city: "Warsaw"},
-		{subdomain: "pt2-ovpn", region: "Europe", country: "Portugal", city: "Lisbon"},
-		{subdomain: "ro2-ovpn", region: "Europe", country: "Romania", city: "Bucharest"},
-		{subdomain: "rs2-ovpn", region: "Europe", country: "Serbia", city: "Niš"},
-		{subdomain: "sk1-ovpn", region: "Europe", country: "Slovakia", city: "Bratislava"},
-		{subdomain: "si1-ovpn", region: "Europe", country: "Slovenia", city: "Ljubljana"},
-		{subdomain: "es-ovpn", region: "Europe", country: "Spain", city: "Barcelona"},
-		{subdomain: "vlus-se1-ovpn", region: "Europe", country: "Sweden", city: "Stockholm"},
-		{subdomain: "ch2-ovpn", region: "Europe", country: "Switzerland", city: "Zurich"},
-		{subdomain: "ukg2-ovpn", region: "Europe", country: "United Kingdom", city: "Gosport"},
-		{subdomain: "ukl2-ovpn", region: "Europe", country: "United Kingdom", city: "London"},
-		{subdomain: "ukm2-ovpn", region: "Europe", country: "United Kingdom", city: "Maidenhead"},
-		{subdomain: "vlus-uk-man1-ovpn", region: "Europe", country: "United Kingdom", city: "Manchester"},
-		{subdomain: "bh-ovpn", region: "Middle East", country: "Bahrain", city: "Manama"},
-		{subdomain: "vlus-jo1-ovpn", region: "Middle East", country: "Jordan", city: "Amman"},
-		{subdomain: "vlus-kw1-ovpn", region: "Middle East", country: "Kuwait", city: "Kuwait"},
-		{subdomain: "om1-ovpn", region: "Middle East", country: "Oman", city: "Salalah"},
-		{subdomain: "qa1-ovpn", region: "Middle East", country: "Qatar", city: "Doha"},
-		{subdomain: "sa1-ovpn", region: "Middle East", country: "Saudi Arabia", city: "Jeddah"},
-		{subdomain: "ae2-ovpn", region: "Middle East", country: "United Arab Emirates", city: "Dubai"},
-		{subdomain: "aw1-ovpn", region: "North America", country: "Aruba", city: "Oranjestad"},
-		{subdomain: "vleu-bb-ovpn", region: "North America", country: "Barbados", city: "Bridgetown"},
-		{subdomain: "bz1-ovpn", region: "North America", country: "Belize", city: "Belmopan"},
-		{subdomain: "vleu-bm-ovpn", region: "North America", country: "Bermuda", city: "Hamilton"},
-		{subdomain: "caq1-ovpn", region: "North America", country: "Canada", city: "Montreal"},
-		{subdomain: "cato-ovpn", region: "North America", country: "Canada", city: "Toronto"},
-		{subdomain: "cav2-ovpn", region: "North America", country: "Canada", city: "Vancouver"},
-		{subdomain: "vleu-ky-ovpn", region: "North America", country: "Cayman Islands", city: "George Town"},
-		{subdomain: "vlus-cr1-ovpn", region: "North America", country: "Costa Rica", city: "San Jose"},
-		{subdomain: "vleu-dm-ovpn", region: "North America", country: "Dominica", city: "Roseau"},
-		{subdomain: "vleu-do-ovpn", region: "North America", country: "Dominican Republic", city: "Santo Domingo"},
-		{subdomain: "vleu-sv-ovpn", region: "North America", country: "El Salvador", city: "San Salvador"},
-		{subdomain: "vleu-gd-ovpn", region: "North America", country: "Grenada", city: "St George's"},
-		{subdomain: "vleu-gt-ovpn", region: "North America", country: "Guatemala", city: "Guatemala"},
-		{subdomain: "vleu-ht1-ovpn", region: "North America", country: "Haiti", city: "PORT-AU-PRINCE"},
-		{subdomain: "vleu-hn-ovpn", region: "North America", country: "Honduras", city: "TEGUCIGALPA"},
-		{subdomain: "jm1-ovpn", region: "North America", country: "Jamaica", city: "Kingston"},
-		{subdomain: "vlus-mx2-ovpn", region: "North America", country: "Mexico", city: "Mexico City"},
-		{subdomain: "vleu-ms-ovpn", region: "North America", country: "Montserrat", city: "plymouth"},
-		{subdomain: "pr1-ovpn", region: "North America", country: "Puerto Rico", city: "San Juan"},
-		{subdomain: "vleu-lc-ovpn", region: "North America", country: "Saint Lucia", city: "Castries"},
-		{subdomain: "bs1-ovpn", region: "North America", country: "The Bahamas", city: "Freeport"},
-		{subdomain: "vleu-tt-ovpn", region: "North America", country: "Trinidad and Tobago", city: "Port of Spain"},
-		{subdomain: "vleu-tc-ovpn", region: "North America", country: "Turks and Caicos Islands", city: "Balfour Town"},
-		{subdomain: "usva-ovpn", region: "North America", country: "United States", city: "Ashburn"},
-		{subdomain: "usil2-ovpn", region: "North America", country: "United States", city: "Chicago"},
-		{subdomain: "usoh1-ovpn", region: "North America", country: "United States", city: "Columbus"},
-		{subdomain: "usga2-ovpn", region: "North America", country: "United States", city: "Georgia"},
-		{subdomain: "ustx2-ovpn", region: "North America", country: "United States", city: "Houston"},
-		{subdomain: "usla2-ovpn", region: "North America", country: "United States", city: "Los Angeles"},
-		{subdomain: "usfl2-ovpn", region: "North America", country: "United States", city: "Miami"},
-		{subdomain: "usnj2-ovpn", region: "North America", country: "United States", city: "New Jersey"},
-		{subdomain: "usny2-ovpn", region: "North America", country: "United States", city: "New York"},
-		{subdomain: "usphx2-ovpn", region: "North America", country: "United States", city: "Phoenix"},
-		{subdomain: "usut2-ovpn", region: "North America", country: "United States", city: "Salt Lake City"},
-		{subdomain: "ussf2-ovpn", region: "North America", country: "United States", city: "San Francisco"},
-		{subdomain: "ussa-ovpn", region: "North America", country: "United States", city: "Seattle"},
-		{subdomain: "uswdc2-ovpn", region: "North America", country: "United States", city: "Washington, D.C."},
-		{subdomain: "au-bn-ovpn", region: "Oceania", country: "Australia", city: "Brisbane"},
-		{subdomain: "au-me1-ovpn", region: "Oceania", country: "Australia", city: "Melbourne"},
-		{subdomain: "au2-pe-ovpn", region: "Oceania", country: "Australia", city: "Perth"},
-		{subdomain: "au-sd2-ovpn", region: "Oceania", country: "Australia", city: "Sydney"},
-		{subdomain: "nz2-ovpn", region: "Oceania", country: "New Zealand", city: "Auckland"},
-		{subdomain: "vlus-ar1-ovpn", region: "South America", country: "Argentina", city: "Buenos Aires"},
-		{subdomain: "vleu-bo-ovpn", region: "South America", country: "Bolivia", city: "Sucre"},
-		{subdomain: "br2-ovpn", region: "South America", country: "Brazil", city: "Sao Paulo"},
-		{subdomain: "vg1-ovpn", region: "South America", country: "British Virgin Island", city: "Road Town"},
-		{subdomain: "vlbr-cl-ovpn", region: "South America", country: "Chile", city: "Santiago"},
-		{subdomain: "co1-ovpn", region: "South America", country: "Colombia", city: "Bogota"},
-		{subdomain: "ec1-ovpn", region: "South America", country: "Ecuador", city: "Quito"},
-		{subdomain: "vleu-gy-ovpn", region: "South America", country: "Guyana", city: "Georgetown"},
-		{subdomain: "pa2-ovpn", region: "South America", country: "Panama", city: "Panama City"},
-		{subdomain: "vleu-py-ovpn", region: "South America", country: "Paraguay", city: "Asuncion"},
-		{subdomain: "pe1-ovpn", region: "South America", country: "Peru", city: "Lima"},
-		{subdomain: "vleu-sr-ovpn", region: "South America", country: "Suriname", city: "Paramaribo"},
-	}
-	for i := range servers {
-		servers[i].subdomain += "-udp"
-	}
-	return servers
-}

docker-compose.yml

@@ -1,39 +0,0 @@
-version: "3.7"
-services:
-  gluetun:
-    image: qmcgaw/private-internet-access
-    container_name: gluetun
-    cap_add:
-      - NET_ADMIN
-    network_mode: bridge
-    ports:
-      - 8888:8888/tcp # Tinyproxy
-      - 8388:8388/tcp # Shadowsocks
-      - 8388:8388/udp # Shadowsocks
-      - 8000:8000/tcp # Built-in HTTP control server
-    # command:
-    environment:
-      # More variables are available, see the readme table
-      - VPNSP=private internet access
-
-      # Timezone for accurate logs times
-      - TZ=
-
-      # All VPN providers
-      - USER=js89ds7
-
-      # All VPN providers but Mullvad
-      - PASSWORD=8fd9s239G
-
-      # Cyberghost only
-      - CLIENT_KEY=
-
-      # All VPN providers but Mullvad
-      - REGION=Austria
-
-      # Mullvad only
-      - COUNTRY=Sweden
-
-      # Allow for example your LAN, set to: 192.168.1.0/24
-      - EXTRA_SUBNETS=
-    restart: always

go.mod

@@ -1,12 +1,44 @@
-module github.com/qdm12/private-internet-access-docker
+module github.com/qdm12/gluetun
 
-go 1.14
+go 1.17
 
 require (
-	github.com/fatih/color v1.9.0
-	github.com/golang/mock v1.4.3
-	github.com/kyokomi/emoji v2.2.4+incompatible
-	github.com/qdm12/golibs v0.0.0-20200712151944-a0325873bf5a
-	github.com/stretchr/testify v1.6.1
-	golang.org/x/sys v0.0.0-20200625212154-ddb9806d33ae
+	github.com/breml/rootcerts v0.1.0
+	github.com/fatih/color v1.13.0
+	github.com/go-ping/ping v0.0.0-20210911151512-381826476871
+	github.com/golang/mock v1.6.0
+	github.com/qdm12/dns v1.11.0
+	github.com/qdm12/golibs v0.0.0-20210822203818-5c568b0777b6
+	github.com/qdm12/goshutdown v0.3.0
+	github.com/qdm12/gosplash v0.1.0
+	github.com/qdm12/ss-server v0.3.0
+	github.com/qdm12/updated v0.0.0-20210603204757-205acfe6937e
+	github.com/stretchr/testify v1.7.0
+	github.com/vishvananda/netlink v1.1.0
+	golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c
+	golang.zx2c4.com/wireguard v0.0.0-20210805125648-3957e9b9dd19
+	golang.zx2c4.com/wireguard/wgctrl v0.0.0-20210803171230-4253848d036c
+	inet.af/netaddr v0.0.0-20210718074554-06ca8145d722
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/google/go-cmp v0.5.5 // indirect
+	github.com/google/uuid v1.2.0 // indirect
+	github.com/josharian/native v0.0.0-20200817173448-b6b71def0850 // indirect
+	github.com/mattn/go-colorable v0.1.9 // indirect
+	github.com/mattn/go-isatty v0.0.14 // indirect
+	github.com/mdlayher/genetlink v1.0.0 // indirect
+	github.com/mdlayher/netlink v1.4.0 // 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-20191106174202-0a2b9b5464df // indirect
+	go4.org/intern v0.0.0-20210108033219-3eb7198706b2 // indirect
+	go4.org/unsafe/assume-no-moving-gc v0.0.0-20201222180813-1025295fd063 // indirect
+	golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 // indirect
+	golang.org/x/net v0.0.0-20210504132125-bbd867fde50d // indirect
+	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c // indirect
+	gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // indirect
 )

go.sum

@@ -1,134 +1,252 @@
-github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
-github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
-github.com/PuerkitoBio/purell v1.1.0 h1:rmGxhojJlM0tuKtfdvliR84CFHljx9ag64t2xmVkjK4=
 github.com/PuerkitoBio/purell v1.1.0/go.mod h1:c11w/QuzBsJSee3cPx9rAFu61PvFxuPbtSwDGJws/X0=
-github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 h1:d+Bc7a5rLufV/sSk/8dngufqelfh6jnri85riMAaF/M=
 github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE=
-github.com/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf h1:eg0MeVzsP1G42dRafH3vf+al2vQIJU0YHX+1Tw87oco=
+github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/ghQa61ZWa/C2Aw3RkjiTBOix7dkqa1VLIs=
+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.1.0 h1:jf/F4MHeXBi7FVAHrPq+/MBmPlGXTbUAyR977bZ0j4E=
+github.com/breml/rootcerts v0.1.0/go.mod h1:24FDtzYMpqIeYC7QzaE8VPRQaFZU5TIUDlyk8qwjD88=
+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=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/docker/go-units v0.3.3/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk=
-github.com/fatih/color v1.9.0 h1:8xPHl4/q1VyqGIPif1F+1V3Y3lSmrq01EabUW3CoW5s=
-github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU=
-github.com/globalsign/mgo v0.0.0-20180905125535-1ca0a4f7cbcb h1:D4uzjWwKYQ5XnAvUbuvHW93esHg7F8N/OYeBBcJoTr0=
+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.13.0 h1:8LOYc1KYPPmyKMuN8QV2DNRWNbLo6LZ0iLs8+mlH53w=
+github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk=
+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=
 github.com/go-openapi/analysis v0.0.0-20180825180245-b006789cd277/go.mod h1:k70tL6pCuVxPJOHXQ+wIac1FUrvNkHolPie/cLEU6hI=
-github.com/go-openapi/analysis v0.17.0 h1:8JV+dzJJiK46XqGLqqLav8ZfEiJECp8jlOFhpiCdZ+0=
 github.com/go-openapi/analysis v0.17.0/go.mod h1:IowGgpVeD0vNm45So8nr+IcQ3pxVtpRoBWb8PVZO0ik=
 github.com/go-openapi/errors v0.17.0/go.mod h1:LcZQpmvG4wyF5j4IhA73wkLFQg+QJXOQHVjmcZxhka0=
-github.com/go-openapi/errors v0.17.2 h1:azEQ8Fnx0jmtFF2fxsnmd6I0x6rsweUF63qqSO1NmKk=
 github.com/go-openapi/errors v0.17.2/go.mod h1:LcZQpmvG4wyF5j4IhA73wkLFQg+QJXOQHVjmcZxhka0=
-github.com/go-openapi/jsonpointer v0.17.0 h1:nH6xp8XdXHx8dqveo0ZuJBluCO2qGrPbDNZ0dwoRHP0=
 github.com/go-openapi/jsonpointer v0.17.0/go.mod h1:cOnomiV+CVVwFLk0A/MExoFMjwdsUdVpsRhURCKh+3M=
-github.com/go-openapi/jsonreference v0.17.0 h1:yJW3HCkTHg7NOA+gZ83IPHzUSnUzGXhGmsdiCcMexbA=
 github.com/go-openapi/jsonreference v0.17.0/go.mod h1:g4xxGn04lDIRh0GJb5QlpE3HfopLOL6uZrK/VgnsK9I=
-github.com/go-openapi/loads v0.17.0 h1:H22nMs3GDQk4SwAaFQ+jLNw+0xoFeCueawhZlv8MBYs=
 github.com/go-openapi/loads v0.17.0/go.mod h1:72tmFy5wsWx89uEVddd0RjRWPZm92WRLhf7AC+0+OOU=
 github.com/go-openapi/runtime v0.0.0-20180920151709-4f900dc2ade9/go.mod h1:6v9a6LTXWQCdL8k1AO3cvqx5OtZY/Y9wKTgaoP6YRfA=
-github.com/go-openapi/runtime v0.17.2 h1:/ZK67ikFhQAMFFH/aPu2MaGH7QjP4wHBvHYOVIzDAw0=
 github.com/go-openapi/runtime v0.17.2/go.mod h1:QO936ZXeisByFmZEO1IS1Dqhtf4QV1sYYFtIq6Ld86Q=
-github.com/go-openapi/spec v0.17.0 h1:XNvrt8FlSVP8T1WuhbAFF6QDhJc0zsoWzX4wXARhhpE=
 github.com/go-openapi/spec v0.17.0/go.mod h1:XkF/MOi14NmjsfZ8VtAKf8pIlbZzyoTvZsdfssdxcBI=
-github.com/go-openapi/strfmt v0.17.0 h1:1isAxYf//QDTnVzbLAMrUK++0k1EjeLJU/gTOR0o3Mc=
 github.com/go-openapi/strfmt v0.17.0/go.mod h1:P82hnJI0CXkErkXi8IKjPbNBM6lV6+5pLP5l494TcyU=
-github.com/go-openapi/swag v0.17.0 h1:iqrgMg7Q7SvtbWLlltPrkMs0UBJI6oTSs79JFRUi880=
 github.com/go-openapi/swag v0.17.0/go.mod h1:AByQ+nYG6gQg71GINrmuDXCPWdL640yX49/kXLo40Tg=
-github.com/go-openapi/validate v0.17.0 h1:pqoViQz3YLOGIhAmD0N4Lt6pa/3Gnj3ymKqQwq8iS6U=
 github.com/go-openapi/validate v0.17.0/go.mod h1:Uh4HdOzKt19xGIGm1qHf/ofbX1YQ4Y+MYsct2VUrAJ4=
-github.com/golang/mock v1.4.3 h1:GV+pQPG/EUUbkh47niozDcADz6go/dUwhVzdUQHIVRw=
-github.com/golang/mock v1.4.3/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw=
+github.com/go-ping/ping v0.0.0-20210911151512-381826476871 h1:wtjTfjwAR/BYYMJ+QOLI/3J/qGEI0fgrkZvgsEWK2/Q=
+github.com/go-ping/ping v0.0.0-20210911151512-381826476871/go.mod h1:xIFjORFzTxqIV/tDVGO4eDy/bLuSyawEeojSm3GfRGk=
+github.com/golang/mock v1.5.0/go.mod h1:CWnOUgYIOo4TcNZ0wHX3YZCqsaM1I1Jvs6v3mP3KVu8=
+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/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
+github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
+github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
+github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
+github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
+github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/gotify/go-api-client/v2 v2.0.4 h1:0w8skCr8aLBDKaQDg31LKKHUGF7rt7zdRpR+6cqIAlE=
+github.com/google/uuid v1.2.0 h1:qJYtXnJRWmpe7m/3XlyhrsLrEURqHRM2kxzoxXqyUDs=
+github.com/google/uuid v1.2.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/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
+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 v0.0.0-20200817173448-b6b71def0850 h1:uhL5Gw7BINiiPAo24A2sxkcDI0Jt/sqp1v5xQCniEFA=
+github.com/josharian/native v0.0.0-20200817173448-b6b71def0850/go.mod h1:7X/raswPFr05uY3HiLlYeyQntB6OO7E/d2Cu7qoaN2w=
+github.com/jsimonetti/rtnetlink v0.0.0-20190606172950-9527aa82566a/go.mod h1:Oz+70psSo5OFh8DBl0Zv2ACw7Esh6pPUphlvZG9x7uw=
+github.com/jsimonetti/rtnetlink v0.0.0-20200117123717-f846d4f6c1f4/go.mod h1:WGuG/smIU4J/54PblvSbh+xvCZmpJnFgr3ds6Z55XMQ=
+github.com/jsimonetti/rtnetlink v0.0.0-20201009170750-9c6f07d100c1/go.mod h1:hqoO/u39cqLeBLebZ8fWdE96O7FxrAsRYhnVOdgHxok=
+github.com/jsimonetti/rtnetlink v0.0.0-20201216134343-bde56ed16391/go.mod h1:cR77jAZG3Y3bsb8hF6fHJbFoyFukLFOkQ98S0pQz3xw=
+github.com/jsimonetti/rtnetlink v0.0.0-20201220180245-69540ac93943/go.mod h1:z4c53zj6Eex712ROyh8WI0ihysb5j2ROyV42iNogmAs=
+github.com/jsimonetti/rtnetlink v0.0.0-20210122163228-8d122574c736/go.mod h1:ZXpIyOK59ZnN7J0BV99cZUPmsqDRZ3eq5X+st7u/oSA=
+github.com/jsimonetti/rtnetlink v0.0.0-20210212075122-66c871082f2b h1:c3NTyLNozICy8B4mlMXemD3z/gXgQzVXZS/HqT+i3do=
+github.com/jsimonetti/rtnetlink v0.0.0-20210212075122-66c871082f2b/go.mod h1:8w9Rh8m+aHZIG69YPGGem1i5VzoyRC8nw2kA8B+ik5U=
+github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
 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=
+github.com/kr/pty v1.1.8/go.mod h1:O1sed60cT9XZ5uDucP5qwvh+TE3NnUj51EiZO/lmSfw=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
-github.com/kyokomi/emoji v2.2.4+incompatible h1:np0woGKwx9LiHAQmwZx79Oc0rHpNw3o+3evou4BEPv4=
 github.com/kyokomi/emoji v2.2.4+incompatible/go.mod h1:mZ6aGCD7yk8j6QY6KICwnZ2pxoszVseX1DNoGtU2tBA=
-github.com/mailru/easyjson v0.0.0-20180823135443-60711f1a8329 h1:2gxZ0XQIU/5z3Z3bUBu+FXuk2pFbkN6tcwi/pjyaDic=
 github.com/mailru/easyjson v0.0.0-20180823135443-60711f1a8329/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
-github.com/mattn/go-colorable v0.1.4 h1:snbPLB8fVfU9iwbbo30TPtbLRzwWu6aJS6Xh4eaaviA=
-github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
-github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
-github.com/mattn/go-isatty v0.0.11 h1:FxPOTFNqGkuDUGi3H/qkUbQO4ZiBa2brKq5r0l8TGeM=
-github.com/mattn/go-isatty v0.0.11/go.mod h1:PhnuNfih5lzO57/f3n+odYbM4JtupLOxQOAqxQCu2WE=
-github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE=
+github.com/mattn/go-colorable v0.1.8/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
+github.com/mattn/go-colorable v0.1.9 h1:sqDoxXbdeALODt0DAeJCVp38ps9ZogZEAXjus69YV3U=
+github.com/mattn/go-colorable v0.1.9/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
+github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
+github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
+github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
+github.com/mdlayher/ethtool v0.0.0-20210210192532-2b88debcdd43 h1:WgyLFv10Ov49JAQI/ZLUkCZ7VJS3r74hwFIGXJsgZlY=
+github.com/mdlayher/ethtool v0.0.0-20210210192532-2b88debcdd43/go.mod h1:+t7E0lkKfbBsebllff1xdTmyJt8lH37niI6kwFk9OTo=
+github.com/mdlayher/genetlink v1.0.0 h1:OoHN1OdyEIkScEmRgxLEe2M9U8ClMytqA5niynLtfj0=
+github.com/mdlayher/genetlink v1.0.0/go.mod h1:0rJ0h4itni50A86M2kHcgS85ttZazNt7a8H2a2cw0Gc=
+github.com/mdlayher/netlink v0.0.0-20190409211403-11939a169225/go.mod h1:eQB3mZE4aiYnlUsyGGCOpPETfdQq4Jhsgf1fk3cwQaA=
+github.com/mdlayher/netlink v1.0.0/go.mod h1:KxeJAFOFLG6AjpyDkQ/iIhxygIUKD+vcwqcnu43w/+M=
+github.com/mdlayher/netlink v1.1.0/go.mod h1:H4WCitaheIsdF9yOYu8CFmCgQthAPIWZmcKp9uZHgmY=
+github.com/mdlayher/netlink v1.1.1/go.mod h1:WTYpFb/WTvlRJAyKhZL5/uy69TDDpHHu2VZmb2XgV7o=
+github.com/mdlayher/netlink v1.2.0/go.mod h1:kwVW1io0AZy9A1E2YYgaD4Cj+C+GPkU6klXCMzIJ9p8=
+github.com/mdlayher/netlink v1.2.1/go.mod h1:bacnNlfhqHqqLo4WsYeXSqfyXkInQ9JneWI68v1KwSU=
+github.com/mdlayher/netlink v1.2.2-0.20210123213345-5cc92139ae3e/go.mod h1:bacnNlfhqHqqLo4WsYeXSqfyXkInQ9JneWI68v1KwSU=
+github.com/mdlayher/netlink v1.3.0/go.mod h1:xK/BssKuwcRXHrtN04UBkwQ6dY9VviGGuriDdoPSWys=
+github.com/mdlayher/netlink v1.4.0 h1:n3ARR+Fm0dDv37dj5wSWZXDKcy+U0zwcXS3zKMnSiT0=
+github.com/mdlayher/netlink v1.4.0/go.mod h1:dRJi5IABcZpBD2A3D0Mv/AiX8I9uDEu5oGkAVrekmf8=
+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.1.3 h1:v+sk57XuaCKGXpWtVBX8YJzO7hMGx4Aajh4TQbdEFdc=
-github.com/mr-tron/base58 v1.1.3/go.mod h1:BinMc/sQntlIE1frQmRFPUoPA1Zkr8VRgBdjWI2mNwc=
+github.com/mr-tron/base58 v1.2.0 h1:T/HDJBh4ZCPbU39/+c3rRvE0uKBQlU27+QI8LJ4t64o=
+github.com/mr-tron/base58 v1.2.0/go.mod h1:BinMc/sQntlIE1frQmRFPUoPA1Zkr8VRgBdjWI2mNwc=
 github.com/pborman/uuid v1.2.0/go.mod h1:X/NO0urCmaxf9VXbdlT7C2Yzkj2IKimNn4k+gtPdI/k=
-github.com/phayes/permbits v0.0.0-20190612203442-39d7c581d2ee h1:P6U24L02WMfj9ymZTxl7CxS73JC99x3ukk+DBkgQGQs=
+github.com/pelletier/go-buffruneio v0.2.0/go.mod h1:JkE26KsDizTr40EUHkXVtNPvgGtbSNq5BcowyYOWdKo=
 github.com/phayes/permbits v0.0.0-20190612203442-39d7c581d2ee/go.mod h1:3uODdxMgOaPYeWU7RzZLxVtJHZ/x1f/iHkBZuKJDzuY=
-github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
 github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/qdm12/golibs v0.0.0-20200712151944-a0325873bf5a h1:IyS72qFm+iXipadmUKXmpJScKXXK2GrD8yYfxXsnIYs=
-github.com/qdm12/golibs v0.0.0-20200712151944-a0325873bf5a/go.mod h1:pikkTN7g7zRuuAnERwqW1yAFq6pYmxrxpjiwGvb0Ysc=
-github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
-github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
+github.com/qdm12/dns v1.11.0 h1:jpcD5DZXXQSQe5a263PL09ghukiIdptvXFOZvyKEm6Q=
+github.com/qdm12/dns v1.11.0/go.mod h1:FmQsNOUcrrZ4UFzWAiED56AKXeNgaX3ySbmPwEfNjjE=
+github.com/qdm12/golibs v0.0.0-20210603202746-e5494e9c2ebb/go.mod h1:15RBzkun0i8XB7ADIoLJWp9ITRgsz3LroEI2FiOXLRg=
+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/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.1.0/go.mod h1:+A3fWW4/rUeDXhY3ieBzwghKdnIPFJgD8K3qQkenJlw=
+github.com/qdm12/ss-server v0.3.0 h1:BfKv4OU6dYb2KcDMYpTc7LIuO2jB73g3JCzy988GrLI=
+github.com/qdm12/ss-server v0.3.0/go.mod h1:ug+nWfuzKw/h5fxL1B6e9/OhkVuWJX4i2V1Pf0pJU1o=
+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=
+github.com/riobard/go-bloom v0.0.0-20200614022211-cdc8013cb5b3/go.mod h1:HgjTstvQsPGkxUsCd2KWxErBblirPizecHcpD3ffK+s=
+github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
+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/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 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
-github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
-github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-go.uber.org/atomic v1.5.0 h1:OI5t8sDa1Or+q8AeE+yKeB/SDYioSHAgcVljj9JIETY=
-go.uber.org/atomic v1.5.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ=
-go.uber.org/multierr v1.3.0 h1:sFPn2GLc3poCkfrpIXGhBD2X0CMIo4Q/zSULXrj/+uc=
-go.uber.org/multierr v1.3.0/go.mod h1:VgVr7evmIr6uPjLBxg28wmKNXyqE9akIJ5XnfpiKl+4=
-go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee h1:0mgffUl7nfd+FpvXMVz4IDEaUSmT1ysygQC7qYo7sG4=
-go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee/go.mod h1:vJERXedbb3MVM5f9Ejo0C68/HhF8uaILCdgjnY+goOA=
-go.uber.org/zap v1.13.0 h1:nR6NoDBgAf67s68NhaXbsojM+2gxp3S1hWkHDl27pVU=
-go.uber.org/zap v1.13.0/go.mod h1:zwrFLgMcdUuIBviXEYEH1YKNaOBnKXsx2IPda5bBwHM=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/vishvananda/netlink v1.1.0 h1:1iyaYNBLmP6L0220aDnYQpo1QEV4t4hJ+xEEhhJH8j0=
+github.com/vishvananda/netlink v1.1.0/go.mod h1:cTgwzPIzzgDAYoQrMm0EdrjRUBkTqKYppBueQtXaqoE=
+github.com/vishvananda/netns v0.0.0-20191106174202-0a2b9b5464df h1:OviZH7qLw/7ZovXvuNyL3XQl8UFofeikI1NW1Gypu7k=
+github.com/vishvananda/netns v0.0.0-20191106174202-0a2b9b5464df/go.mod h1:JP3t17pCcGlemwknint6hfoeCVQrEMVwxRLRjXpq+BU=
+github.com/xanzy/ssh-agent v0.2.1/go.mod h1:mLlQY/MoOhWBj+gOGMQkOeiEvkx+8pJSI+0Bx9h2kr4=
+github.com/yl2chen/cidranger v1.0.2/go.mod h1:9U1yz7WPYDwf0vpNWFaeRh0bjwz5RVgRy/9UEQfHl0g=
+github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
+github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
+go4.org/intern v0.0.0-20210108033219-3eb7198706b2 h1:VFTf+jjIgsldaz/Mr00VaCSswHJrI2hIjQygE/W4IMg=
+go4.org/intern v0.0.0-20210108033219-3eb7198706b2/go.mod h1:vLqJ+12kCw61iCWsPto0EOHhBS+o4rO5VIucbc9g2Cc=
+go4.org/unsafe/assume-no-moving-gc v0.0.0-20201222175341-b30ae309168e/go.mod h1:FftLjUGFEDu5k8lt0ddY+HcrH/qU/0qk+H8j9/nTl3E=
+go4.org/unsafe/assume-no-moving-gc v0.0.0-20201222180813-1025295fd063 h1:1tk03FUNpulq2cuWpXZWj649rwJpk0d20rxWiopKRmc=
+go4.org/unsafe/assume-no-moving-gc v0.0.0-20201222180813-1025295fd063/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-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
-golang.org/x/crypto v0.0.0-20200117160349-530e935923ad/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
-golang.org/x/lint v0.0.0-20190930215403-16217165b5de h1:5hukYrvBGR8/eNkX5mdUezrA6JiaEZDtJb9Ei+1LlBs=
-golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
-golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc=
+golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
+golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I=
+golang.org/x/crypto v0.0.0-20210503195802-e9a32991a82e/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8=
+golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8=
+golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 h1:/UOmuWzQfxxo9UtlXMwuQU8CMgg1eZXqTRwkSQJWKOI=
+golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
+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-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
-golang.org/x/net v0.0.0-20190620200207-3b0461eec859 h1:R/3boaszxrf1GEUWTVDzSKVwLmSJpwZ1yqXm8j0v2QI=
 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-20190827160401-ba9fcec4b297/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-20191007182048-72f939374954/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20200202094626-16171245cfb2/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20201010224723-4f7140c49acb/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
+golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
+golang.org/x/net v0.0.0-20201110031124-69a78807bb2b/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
+golang.org/x/net v0.0.0-20201216054612-986b41b23924/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20201224014010-6772e930b67b/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20210119194325-5f4716e94777/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20210316092652-d523dce5a7f4/go.mod h1:RBQZq4jEuRlivfhVLdyRGr576XBO4/greRjx4P4O3yc=
+golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM=
+golang.org/x/net v0.0.0-20210504132125-bbd867fde50d h1:nTDGCTeAu2LhcsHTRzjyIUbZHCJ4QePArsm27Hka0UM=
+golang.org/x/net v0.0.0-20210504132125-bbd867fde50d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
 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 h1:5KslGYwFpkhGh+Q16bwMP3cOontH8FOep7tGV86Y7SQ=
+golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20190412213103-97732733099d h1:+R4KGOnez64A81RvjARKc4UT5/tI9ujCIVX+P5KiHuI=
+golang.org/x/sys v0.0.0-20190221075227-b4e8571b14e0/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20190411185658-b44545bcd369/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20190606203320-7fc4e5ec1444/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20190826190057-c7b8b68b1456/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20190924154521-2837fb4f24fe/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20191008105621-543471e840be/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20200625212154-ddb9806d33ae h1:Ih9Yo4hSPImZOpfGuA4bR/ORKTAbhZo2AbWNRCnevdo=
-golang.org/x/sys v0.0.0-20200625212154-ddb9806d33ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
+golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200202164722-d101bd2416d5/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20201009025420-dfb3f7c4e634/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20201118182958-a01c418693c7/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20201218084310-7d0127a74742/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210110051926-789bb1bd4061/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210123111255-9b0068b26619/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210216163648-f7da38b97c65/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210309040221-94ec62e08169/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210315160823-c6e025ad8005/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210403161142-5e06dd20ab57/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210503173754-0981d6026fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+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-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I=
+golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
-golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=
-golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=
-golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
-golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5 h1:hKsoRgsbwY1NafxrwTs+k64bikrLBkAgPir1TNCj3Zs=
-golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+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/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=
+golang.org/x/tools v0.0.0-20191216052735-49a3e744a425/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
+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=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+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 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
+golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.zx2c4.com/wireguard v0.0.0-20210427022245-097af6e1351b/go.mod h1:a057zjmoc00UN7gVkaJt2sXVK523kMJcogDTEvPIasg=
+golang.zx2c4.com/wireguard v0.0.0-20210805125648-3957e9b9dd19 h1:ab2jcw2W91Rz07eHAb8Lic7sFQKO0NhBftjv6m/gL/0=
+golang.zx2c4.com/wireguard v0.0.0-20210805125648-3957e9b9dd19/go.mod h1:laHzsbfMhGSobUmruXWAyMKKHSqvIcrqZJMyHD+/3O8=
+golang.zx2c4.com/wireguard/wgctrl v0.0.0-20210803171230-4253848d036c h1:ADNrRDI5NR23/TUCnEmlLZLt4u9DnZ2nwRkPrAcFvto=
+golang.zx2c4.com/wireguard/wgctrl v0.0.0-20210803171230-4253848d036c/go.mod h1:+1XihzyZUBJcSc5WO9SwNA7v26puQwOEDwanaxfNXPQ=
 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/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
+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=
+gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI=
 gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
-gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-honnef.co/go/tools v0.0.1-2019.2.3 h1:3JgtbtFHMiCmsznwGVTUWbgGov+pVqnlf1dEJTNAXeM=
-honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg=
-rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
-rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=
+inet.af/netaddr v0.0.0-20210511181906-37180328850c/go.mod h1:z0nx+Dh+7N7CC8V5ayHtHGpZpxLQZZxkIaaz6HN65Ls=
+inet.af/netaddr v0.0.0-20210718074554-06ca8145d722 h1:Qws2rZnQudC58cIagVucPQDLmMi3kAXgxscsgD0v6DU=
+inet.af/netaddr v0.0.0-20210718074554-06ca8145d722/go.mod h1:z0nx+Dh+7N7CC8V5ayHtHGpZpxLQZZxkIaaz6HN65Ls=

internal/alpine/alpine.go

@@ -1,25 +1,29 @@
+// Package alpine defines a configurator to interact with the Alpine operating system.
 package alpine
 
 import (
 	"os/user"
-
-	"github.com/qdm12/golibs/files"
 )
 
-type Configurator interface {
-	CreateUser(username string, uid int) error
+var _ Alpiner = (*Alpine)(nil)
+
+type Alpiner interface {
+	UserCreater
+	VersionGetter
 }
 
-type configurator struct {
-	fileManager files.FileManager
-	lookupUID   func(uid string) (*user.User, error)
-	lookupUser  func(username string) (*user.User, error)
+type Alpine struct {
+	alpineReleasePath string
+	passwdPath        string
+	lookupID          func(uid string) (*user.User, error)
+	lookup            func(username string) (*user.User, error)
 }
 
-func NewConfigurator(fileManager files.FileManager) Configurator {
-	return &configurator{
-		fileManager: fileManager,
-		lookupUID:   user.LookupId,
-		lookupUser:  user.Lookup,
+func New() *Alpine {
+	return &Alpine{
+		alpineReleasePath: "/etc/alpine-release",
+		passwdPath:        "/etc/passwd",
+		lookupID:          user.LookupId,
+		lookup:            user.Lookup,
 	}
 }

internal/alpine/users.go

@@ -1,38 +1,58 @@
 package alpine
 
 import (
+	"errors"
 	"fmt"
+	"os"
 	"os/user"
+	"strconv"
 )
 
-// CreateUser creates a user in Alpine with the given UID
-func (c *configurator) CreateUser(username string, uid int) error {
-	UIDStr := fmt.Sprintf("%d", uid)
-	u, err := c.lookupUID(UIDStr)
+var (
+	ErrUserAlreadyExists = errors.New("user already exists")
+)
+
+type UserCreater interface {
+	CreateUser(username string, uid int) (createdUsername string, err error)
+}
+
+// CreateUser creates a user in Alpine with the given UID.
+func (a *Alpine) CreateUser(username string, uid int) (createdUsername string, err error) {
+	UIDStr := strconv.Itoa(uid)
+	u, err := a.lookupID(UIDStr)
 	_, unknownUID := err.(user.UnknownUserIdError)
 	if err != nil && !unknownUID {
-		return fmt.Errorf("cannot create user: %w", err)
-	} else if u != nil {
-		if u.Username == username {
-			return nil
-		}
-		return fmt.Errorf("user with ID %d exists with username %q instead of %q", uid, u.Username, username)
+		return "", err
 	}
-	u, err = c.lookupUser(username)
+
+	if u != nil {
+		if u.Username == username {
+			return "", nil
+		}
+		return u.Username, nil
+	}
+
+	u, err = a.lookup(username)
 	_, unknownUsername := err.(user.UnknownUserError)
 	if err != nil && !unknownUsername {
-		return fmt.Errorf("cannot create user: %w", err)
-	} else if u != nil {
-		return fmt.Errorf("cannot create user: user with name %s already exists for ID %s instead of %d", username, u.Uid, uid)
+		return "", err
 	}
-	passwd, err := c.fileManager.ReadFile("/etc/passwd")
-	if err != nil {
-		return fmt.Errorf("cannot create user: %w", err)
-	}
-	passwd = append(passwd, []byte(fmt.Sprintf("%s:x:%d:::/dev/null:/sbin/nologin\n", username, uid))...)
 
-	if err := c.fileManager.WriteToFile("/etc/passwd", passwd); err != nil {
-		return fmt.Errorf("cannot create user: %w", err)
+	if u != nil {
+		return "", fmt.Errorf("%w: with name %s for ID %s instead of %d",
+			ErrUserAlreadyExists, username, u.Uid, uid)
 	}
-	return nil
+
+	file, err := os.OpenFile(a.passwdPath, os.O_APPEND|os.O_WRONLY, 0644)
+	if err != nil {
+		return "", err
+	}
+	s := fmt.Sprintf("%s:x:%d:::/dev/null:/sbin/nologin\n", username, uid)
+	_, err = file.WriteString(s)
+	if err != nil {
+		_ = file.Close()
+		return "", err
+	}
+
+	return username, file.Close()
 }

internal/alpine/version.go

@@ -0,0 +1,31 @@
+package alpine
+
+import (
+	"context"
+	"io"
+	"os"
+	"strings"
+)
+
+type VersionGetter interface {
+	Version(ctx context.Context) (version string, err error)
+}
+
+func (a *Alpine) Version(ctx context.Context) (version string, err error) {
+	file, err := os.OpenFile(a.alpineReleasePath, os.O_RDONLY, 0)
+	if err != nil {
+		return "", err
+	}
+
+	b, err := io.ReadAll(file)
+	if err != nil {
+		return "", err
+	}
+
+	if err := file.Close(); err != nil {
+		return "", err
+	}
+
+	version = strings.ReplaceAll(string(b), "\n", "")
+	return version, nil
+}

internal/cli/ci.go

@@ -0,0 +1,7 @@
+package cli
+
+import "context"
+
+func (c *CLI) CI(context context.Context) error {
+	return nil
+}

internal/cli/cli.go

@@ -1,74 +1,22 @@
+// Package cli defines an interface CLI to run command line operations.
 package cli
 
-import (
-	"flag"
-	"fmt"
-	"strings"
+var _ CLIer = (*CLI)(nil)
 
-	"net"
-
-	"github.com/qdm12/golibs/files"
-	"github.com/qdm12/golibs/logging"
-	"github.com/qdm12/private-internet-access-docker/internal/params"
-	"github.com/qdm12/private-internet-access-docker/internal/provider"
-	"github.com/qdm12/private-internet-access-docker/internal/settings"
-)
-
-func ClientKey(args []string) error {
-	flagSet := flag.NewFlagSet("clientkey", flag.ExitOnError)
-	filepath := flagSet.String("path", "/files/client.key", "file path to the client.key file")
-	if err := flagSet.Parse(args); err != nil {
-		return err
-	}
-	fileManager := files.NewFileManager()
-	data, err := fileManager.ReadFile(*filepath)
-	if err != nil {
-		return err
-	}
-	s := string(data)
-	s = strings.ReplaceAll(s, "\n", "")
-	s = strings.ReplaceAll(s, "\r", "")
-	s = strings.TrimPrefix(s, "-----BEGIN PRIVATE KEY-----")
-	s = strings.TrimSuffix(s, "-----END PRIVATE KEY-----")
-	fmt.Println(s)
-	return nil
+type CLIer interface {
+	ClientKeyFormatter
+	HealthChecker
+	OpenvpnConfigMaker
+	Updater
+	ServersFormatter
 }
 
-func HealthCheck() error {
-	ips, err := net.LookupIP("github.com")
-	if err != nil {
-		return fmt.Errorf("cannot resolve github.com (%s)", err)
-	} else if len(ips) == 0 {
-		return fmt.Errorf("resolved no IP addresses for github.com")
-	}
-	return nil
+type CLI struct {
+	repoServersPath string
 }
 
-func OpenvpnConfig() error {
-	logger, err := logging.NewLogger(logging.ConsoleEncoding, logging.InfoLevel, -1)
-	if err != nil {
-		return err
+func New() *CLI {
+	return &CLI{
+		repoServersPath: "./internal/storage/servers.json",
 	}
-	paramsReader := params.NewReader(logger, files.NewFileManager())
-	allSettings, err := settings.GetAllSettings(paramsReader)
-	if err != nil {
-		return err
-	}
-	providerConf := provider.New(allSettings.OpenVPN.Provider.Name)
-	connections, err := providerConf.GetOpenVPNConnections(allSettings.OpenVPN.Provider.ServerSelection)
-	if err != nil {
-		return err
-	}
-	lines := providerConf.BuildConf(
-		connections,
-		allSettings.OpenVPN.Verbosity,
-		allSettings.System.UID,
-		allSettings.System.GID,
-		allSettings.OpenVPN.Root,
-		allSettings.OpenVPN.Cipher,
-		allSettings.OpenVPN.Auth,
-		allSettings.OpenVPN.Provider.ExtraConfigOptions,
-	)
-	fmt.Println(strings.Join(lines, "\n"))
-	return nil
 }

internal/cli/clientkey.go

@@ -0,0 +1,45 @@
+package cli
+
+import (
+	"flag"
+	"fmt"
+	"io"
+	"os"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+type ClientKeyFormatter interface {
+	ClientKey(args []string) error
+}
+
+func (c *CLI) ClientKey(args []string) error {
+	flagSet := flag.NewFlagSet("clientkey", flag.ExitOnError)
+	filepath := flagSet.String("path", constants.ClientKey, "file path to the client.key file")
+	if err := flagSet.Parse(args); err != nil {
+		return err
+	}
+	file, err := os.OpenFile(*filepath, os.O_RDONLY, 0)
+	if err != nil {
+		return err
+	}
+	data, err := io.ReadAll(file)
+	if err != nil {
+		_ = file.Close()
+		return err
+	}
+	if err := file.Close(); err != nil {
+		return err
+	}
+	if err != nil {
+		return err
+	}
+	s := string(data)
+	s = strings.ReplaceAll(s, "\n", "")
+	s = strings.ReplaceAll(s, "\r", "")
+	s = strings.TrimPrefix(s, "-----BEGIN PRIVATE KEY-----")
+	s = strings.TrimSuffix(s, "-----END PRIVATE KEY-----")
+	fmt.Println(s)
+	return nil
+}

internal/cli/formatservers.go

@@ -0,0 +1,130 @@
+package cli
+
+import (
+	"errors"
+	"flag"
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/storage"
+)
+
+type ServersFormatter interface {
+	FormatServers(args []string) error
+}
+
+var (
+	ErrFormatNotRecognized = errors.New("format is not recognized")
+	ErrProviderUnspecified = errors.New("VPN provider to format was not specified")
+	ErrOpenOutputFile      = errors.New("cannot open output file")
+	ErrWriteOutput         = errors.New("cannot write to output file")
+	ErrCloseOutputFile     = errors.New("cannot close output file")
+)
+
+func (c *CLI) FormatServers(args []string) error {
+	var format, output string
+	var cyberghost, expressvpn, fastestvpn, hideMyAss, ipvanish, ivpn, mullvad,
+		nordvpn, pia, privado, privatevpn, protonvpn, purevpn, surfshark,
+		torguard, vpnUnlimited, vyprvpn, wevpn, windscribe bool
+	flagSet := flag.NewFlagSet("markdown", 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")
+	flagSet.BoolVar(&cyberghost, "cyberghost", false, "Format Cyberghost servers")
+	flagSet.BoolVar(&expressvpn, "expressvpn", false, "Format ExpressVPN servers")
+	flagSet.BoolVar(&fastestvpn, "fastestvpn", false, "Format FastestVPN servers")
+	flagSet.BoolVar(&hideMyAss, "hidemyass", false, "Format HideMyAss servers")
+	flagSet.BoolVar(&ipvanish, "ipvanish", false, "Format IpVanish servers")
+	flagSet.BoolVar(&ivpn, "ivpn", false, "Format IVPN servers")
+	flagSet.BoolVar(&mullvad, "mullvad", false, "Format Mullvad servers")
+	flagSet.BoolVar(&nordvpn, "nordvpn", false, "Format Nordvpn servers")
+	flagSet.BoolVar(&pia, "pia", false, "Format Private Internet Access servers")
+	flagSet.BoolVar(&privado, "privado", false, "Format Privado servers")
+	flagSet.BoolVar(&privatevpn, "privatevpn", false, "Format Private VPN servers")
+	flagSet.BoolVar(&protonvpn, "protonvpn", false, "Format Protonvpn servers")
+	flagSet.BoolVar(&purevpn, "purevpn", false, "Format Purevpn servers")
+	flagSet.BoolVar(&surfshark, "surfshark", false, "Format Surfshark servers")
+	flagSet.BoolVar(&torguard, "torguard", false, "Format Torguard servers")
+	flagSet.BoolVar(&vpnUnlimited, "vpnunlimited", false, "Format VPN Unlimited servers")
+	flagSet.BoolVar(&vyprvpn, "vyprvpn", false, "Format Vyprvpn servers")
+	flagSet.BoolVar(&wevpn, "wevpn", false, "Format WeVPN servers")
+	flagSet.BoolVar(&windscribe, "windscribe", false, "Format Windscribe servers")
+	if err := flagSet.Parse(args); err != nil {
+		return err
+	}
+
+	if format != "markdown" {
+		return fmt.Errorf("%w: %s", ErrFormatNotRecognized, format)
+	}
+
+	logger := newNoopLogger()
+	storage, err := storage.New(logger, constants.ServersData)
+	if err != nil {
+		return fmt.Errorf("%w: %s", ErrNewStorage, err)
+	}
+	currentServers := storage.GetServers()
+
+	var formatted string
+	switch {
+	case cyberghost:
+		formatted = currentServers.Cyberghost.ToMarkdown()
+	case expressvpn:
+		formatted = currentServers.Expressvpn.ToMarkdown()
+	case fastestvpn:
+		formatted = currentServers.Fastestvpn.ToMarkdown()
+	case hideMyAss:
+		formatted = currentServers.HideMyAss.ToMarkdown()
+	case ipvanish:
+		formatted = currentServers.Ipvanish.ToMarkdown()
+	case ivpn:
+		formatted = currentServers.Ivpn.ToMarkdown()
+	case mullvad:
+		formatted = currentServers.Mullvad.ToMarkdown()
+	case nordvpn:
+		formatted = currentServers.Nordvpn.ToMarkdown()
+	case pia:
+		formatted = currentServers.Pia.ToMarkdown()
+	case privado:
+		formatted = currentServers.Privado.ToMarkdown()
+	case privatevpn:
+		formatted = currentServers.Privatevpn.ToMarkdown()
+	case protonvpn:
+		formatted = currentServers.Protonvpn.ToMarkdown()
+	case purevpn:
+		formatted = currentServers.Purevpn.ToMarkdown()
+	case surfshark:
+		formatted = currentServers.Surfshark.ToMarkdown()
+	case torguard:
+		formatted = currentServers.Torguard.ToMarkdown()
+	case vpnUnlimited:
+		formatted = currentServers.VPNUnlimited.ToMarkdown()
+	case vyprvpn:
+		formatted = currentServers.Vyprvpn.ToMarkdown()
+	case wevpn:
+		formatted = currentServers.Wevpn.ToMarkdown()
+	case windscribe:
+		formatted = currentServers.Windscribe.ToMarkdown()
+	default:
+		return ErrProviderUnspecified
+	}
+
+	output = filepath.Clean(output)
+	file, err := os.OpenFile(output, os.O_TRUNC|os.O_WRONLY|os.O_CREATE, 0644)
+	if err != nil {
+		return fmt.Errorf("%w: %s", ErrOpenOutputFile, err)
+	}
+
+	_, err = fmt.Fprint(file, formatted)
+	if err != nil {
+		_ = file.Close()
+		return fmt.Errorf("%w: %s", ErrWriteOutput, err)
+	}
+
+	err = file.Close()
+	if err != nil {
+		return fmt.Errorf("%w: %s", ErrCloseOutputFile, err)
+	}
+
+	return nil
+}

internal/cli/healthcheck.go

@@ -0,0 +1,39 @@
+package cli
+
+import (
+	"context"
+	"net"
+	"net/http"
+	"time"
+
+	"github.com/qdm12/gluetun/internal/configuration"
+	"github.com/qdm12/gluetun/internal/healthcheck"
+	"github.com/qdm12/golibs/params"
+)
+
+type HealthChecker interface {
+	HealthCheck(ctx context.Context, env params.Interface, warner configuration.Warner) error
+}
+
+func (c *CLI) HealthCheck(ctx context.Context, env params.Interface,
+	warner configuration.Warner) error {
+	// Extract the health server port from the configuration.
+	config := configuration.Health{}
+	err := config.Read(env, warner)
+	if err != nil {
+		return err
+	}
+	_, port, err := net.SplitHostPort(config.ServerAddress)
+	if err != nil {
+		return err
+	}
+
+	const timeout = 10 * time.Second
+	httpClient := &http.Client{Timeout: timeout}
+	client := healthcheck.NewClient(httpClient)
+	ctx, cancel := context.WithTimeout(ctx, timeout)
+	defer cancel()
+
+	url := "http://127.0.0.1:" + port
+	return client.Check(ctx, url)
+}

internal/cli/nooplogger.go

@@ -0,0 +1,16 @@
+package cli
+
+import "github.com/qdm12/golibs/logging"
+
+type noopLogger struct{}
+
+func newNoopLogger() *noopLogger {
+	return new(noopLogger)
+}
+
+func (l *noopLogger) Debug(s string)                 {}
+func (l *noopLogger) Info(s string)                  {}
+func (l *noopLogger) Warn(s string)                  {}
+func (l *noopLogger) Error(s string)                 {}
+func (l *noopLogger) PatchLevel(level logging.Level) {}
+func (l *noopLogger) PatchPrefix(prefix string)      {}

internal/cli/openvpnconfig.go

@@ -0,0 +1,48 @@
+package cli
+
+import (
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/qdm12/gluetun/internal/configuration"
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/provider"
+	"github.com/qdm12/gluetun/internal/storage"
+	"github.com/qdm12/golibs/params"
+)
+
+type OpenvpnConfigMaker interface {
+	OpenvpnConfig(logger OpenvpnConfigLogger, env params.Interface) error
+}
+
+type OpenvpnConfigLogger interface {
+	Info(s string)
+	Warn(s string)
+}
+
+func (c *CLI) OpenvpnConfig(logger OpenvpnConfigLogger, env params.Interface) error {
+	storage, err := storage.New(logger, constants.ServersData)
+	if err != nil {
+		return err
+	}
+	allServers := storage.GetServers()
+
+	var allSettings configuration.Settings
+	err = allSettings.Read(env, allServers, logger)
+	if err != nil {
+		return err
+	}
+	providerConf := provider.New(allSettings.VPN.Provider.Name, allServers, time.Now)
+	connection, err := providerConf.GetConnection(allSettings.VPN.Provider.ServerSelection)
+	if err != nil {
+		return err
+	}
+	lines, err := providerConf.BuildConf(connection, allSettings.VPN.OpenVPN)
+	if err != nil {
+		return err
+	}
+
+	fmt.Println(strings.Join(lines, "\n"))
+	return nil
+}

internal/cli/update.go

@@ -0,0 +1,120 @@
+package cli
+
+import (
+	"context"
+	"encoding/json"
+	"errors"
+	"flag"
+	"fmt"
+	"net/http"
+	"os"
+	"time"
+
+	"github.com/qdm12/gluetun/internal/configuration"
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/gluetun/internal/storage"
+	"github.com/qdm12/gluetun/internal/updater"
+)
+
+var (
+	ErrModeUnspecified         = errors.New("at least one of -enduser or -maintainers must be specified")
+	ErrNewStorage              = errors.New("cannot create storage")
+	ErrUpdateServerInformation = errors.New("cannot update server information")
+	ErrWriteToFile             = errors.New("cannot write updated information to file")
+)
+
+type Updater interface {
+	Update(ctx context.Context, args []string, logger UpdaterLogger) error
+}
+
+type UpdaterLogger interface {
+	Info(s string)
+	Warn(s string)
+	Error(s string)
+}
+
+func (c *CLI) Update(ctx context.Context, args []string, logger UpdaterLogger) error {
+	options := configuration.Updater{CLI: true}
+	var endUserMode, maintainerMode, updateAll bool
+	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,
+		"Write results to ./internal/storage/servers.json to modify the program (for maintainers)")
+	flagSet.StringVar(&options.DNSAddress, "dns", "8.8.8.8", "DNS resolver address to use")
+	flagSet.BoolVar(&updateAll, "all", false, "Update servers for all VPN providers")
+	flagSet.BoolVar(&options.Cyberghost, "cyberghost", false, "Update Cyberghost servers")
+	flagSet.BoolVar(&options.Expressvpn, "expressvpn", false, "Update ExpressVPN servers")
+	flagSet.BoolVar(&options.Fastestvpn, "fastestvpn", false, "Update FastestVPN servers")
+	flagSet.BoolVar(&options.HideMyAss, "hidemyass", false, "Update HideMyAss servers")
+	flagSet.BoolVar(&options.Ipvanish, "ipvanish", false, "Update IpVanish servers")
+	flagSet.BoolVar(&options.Ivpn, "ivpn", false, "Update IVPN servers")
+	flagSet.BoolVar(&options.Mullvad, "mullvad", false, "Update Mullvad servers")
+	flagSet.BoolVar(&options.Nordvpn, "nordvpn", false, "Update Nordvpn servers")
+	flagSet.BoolVar(&options.PIA, "pia", false, "Update Private Internet Access post-summer 2020 servers")
+	flagSet.BoolVar(&options.Privado, "privado", false, "Update Privado servers")
+	flagSet.BoolVar(&options.Privatevpn, "privatevpn", false, "Update Private VPN servers")
+	flagSet.BoolVar(&options.Protonvpn, "protonvpn", false, "Update Protonvpn servers")
+	flagSet.BoolVar(&options.Purevpn, "purevpn", false, "Update Purevpn servers")
+	flagSet.BoolVar(&options.Surfshark, "surfshark", false, "Update Surfshark servers")
+	flagSet.BoolVar(&options.Torguard, "torguard", false, "Update Torguard servers")
+	flagSet.BoolVar(&options.VPNUnlimited, "vpnunlimited", false, "Update VPN Unlimited servers")
+	flagSet.BoolVar(&options.Vyprvpn, "vyprvpn", false, "Update Vyprvpn servers")
+	flagSet.BoolVar(&options.Wevpn, "wevpn", false, "Update WeVPN servers")
+	flagSet.BoolVar(&options.Windscribe, "windscribe", false, "Update Windscribe servers")
+	if err := flagSet.Parse(args); err != nil {
+		return err
+	}
+	if !endUserMode && !maintainerMode {
+		return ErrModeUnspecified
+	}
+
+	if updateAll {
+		options.EnableAll()
+	}
+
+	const clientTimeout = 10 * time.Second
+	httpClient := &http.Client{Timeout: clientTimeout}
+
+	storage, err := storage.New(logger, constants.ServersData)
+	if err != nil {
+		return fmt.Errorf("%w: %s", ErrNewStorage, err)
+	}
+	currentServers := storage.GetServers()
+
+	updater := updater.New(options, httpClient, currentServers, logger)
+	allServers, err := updater.UpdateServers(ctx)
+	if err != nil {
+		return fmt.Errorf("%w: %s", ErrUpdateServerInformation, err)
+	}
+
+	if endUserMode {
+		if err := storage.FlushToFile(allServers); err != nil {
+			return fmt.Errorf("%w: %s", ErrWriteToFile, err)
+		}
+	}
+
+	if maintainerMode {
+		if err := writeToEmbeddedJSON(c.repoServersPath, allServers); err != nil {
+			return fmt.Errorf("%w: %s", ErrWriteToFile, err)
+		}
+	}
+
+	return nil
+}
+
+func writeToEmbeddedJSON(repoServersPath string,
+	allServers models.AllServers) error {
+	const perms = 0600
+	f, err := os.OpenFile(repoServersPath,
+		os.O_TRUNC|os.O_WRONLY|os.O_CREATE, perms)
+	if err != nil {
+		return err
+	}
+
+	defer f.Close()
+
+	encoder := json.NewEncoder(f)
+	encoder.SetIndent("", "  ")
+	return encoder.Encode(allServers)
+}

internal/configuration/configuration.go

@@ -0,0 +1,3 @@
+// Package configuration reads initial settings from environment variables
+// and secret files.
+package configuration

internal/configuration/constants.go

@@ -0,0 +1,6 @@
+package configuration
+
+const (
+	lastIndent = "|--"
+	indent     = "   "
+)

internal/configuration/custom.go

@@ -0,0 +1,95 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+	"net"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+var (
+	errCustomNotSupported    = errors.New("custom provider is not supported")
+	errCustomExtractFromFile = errors.New("cannot extract configuration from file")
+)
+
+func (settings *Provider) readCustom(r reader, vpnType string) (err error) {
+	settings.Name = constants.Custom
+
+	switch vpnType {
+	case constants.OpenVPN:
+		return settings.ServerSelection.OpenVPN.readCustom(r)
+	case constants.Wireguard:
+		return settings.ServerSelection.Wireguard.readCustom(r)
+	default:
+		return fmt.Errorf("%w: for VPN type %s", errCustomNotSupported, vpnType)
+	}
+}
+
+func (settings *OpenVPNSelection) readCustom(r reader) (err error) {
+	configFile, err := r.env.Get("OPENVPN_CUSTOM_CONFIG", params.CaseSensitiveValue(), params.Compulsory())
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_CUSTOM_CONFIG: %w", err)
+	}
+	settings.ConfFile = configFile
+
+	// For display and consistency purposes only,
+	// these values are not actually used since the file is re-read
+	// before each OpenVPN start.
+	_, connection, err := r.ovpnExt.Data(configFile)
+	if err != nil {
+		return fmt.Errorf("%w: %s", errCustomExtractFromFile, err)
+	}
+	settings.TCP = connection.Protocol == constants.TCP
+
+	return nil
+}
+
+func (settings *OpenVPN) readCustom(r reader) (err error) {
+	settings.ConfFile, err = r.env.Path("OPENVPN_CUSTOM_CONFIG",
+		params.Compulsory(), params.CaseSensitiveValue())
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_CUSTOM_CONFIG: %w", err)
+	}
+
+	return nil
+}
+
+func (settings *WireguardSelection) readCustom(r reader) (err error) {
+	settings.PublicKey, err = r.env.Get("WIREGUARD_PUBLIC_KEY",
+		params.CaseSensitiveValue(), params.Compulsory())
+	if err != nil {
+		return fmt.Errorf("environment variable WIREGUARD_PUBLIC_KEY: %w", err)
+	}
+
+	settings.EndpointIP, err = readWireguardEndpointIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.EndpointPort, err = r.env.Port("WIREGUARD_ENDPOINT_PORT", params.Compulsory(),
+		params.RetroKeys([]string{"WIREGUARD_PORT"}, r.onRetroActive))
+	if err != nil {
+		return fmt.Errorf("environment variable WIREGUARD_ENDPOINT_PORT: %w", err)
+	}
+
+	return nil
+}
+
+// readWireguardEndpointIP reads and parses the server endpoint IP
+// address from the environment variable WIREGUARD_ENDPOINT_IP.
+func readWireguardEndpointIP(env params.Interface) (endpointIP net.IP, err error) {
+	s, err := env.Get("WIREGUARD_ENDPOINT_IP", params.Compulsory())
+	if err != nil {
+		return nil, fmt.Errorf("environment variable WIREGUARD_ENDPOINT_IP: %w", err)
+	}
+
+	endpointIP = net.ParseIP(s)
+	if endpointIP == nil {
+		return nil, fmt.Errorf("environment variable WIREGUARD_ENDPOINT_IP: %w: %s",
+			ErrInvalidIP, s)
+	}
+
+	return endpointIP, nil
+}

internal/configuration/cyberghost.go

@@ -0,0 +1,47 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+func (settings *Provider) readCyberghost(r reader) (err error) {
+	settings.Name = constants.Cyberghost
+	servers := r.servers.GetCyberghost()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY",
+		constants.CyberghostCountryChoices(servers),
+		params.RetroKeys([]string{"REGION"}, r.onRetroActive))
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME",
+		constants.CyberghostHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return settings.ServerSelection.OpenVPN.readProtocolAndPort(r)
+}
+
+func (settings *OpenVPN) readCyberghost(r reader) (err error) {
+	settings.ClientKey, err = readClientKey(r)
+	if err != nil {
+		return fmt.Errorf("%w: %s", errClientKey, err)
+	}
+
+	settings.ClientCrt, err = readClientCertificate(r)
+	if err != nil {
+		return fmt.Errorf("%w: %s", errClientCert, err)
+	}
+
+	return nil
+}

internal/configuration/dns.go

@@ -0,0 +1,117 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+	"net"
+	"strings"
+	"time"
+
+	"github.com/qdm12/dns/pkg/blacklist"
+	"github.com/qdm12/dns/pkg/unbound"
+	"github.com/qdm12/golibs/params"
+)
+
+// DNS contains settings to configure Unbound for DNS over TLS operation.
+type DNS struct { //nolint:maligned
+	Enabled          bool
+	PlaintextAddress net.IP
+	KeepNameserver   bool
+	UpdatePeriod     time.Duration
+	Unbound          unbound.Settings
+	BlacklistBuild   blacklist.BuilderSettings
+}
+
+func (settings *DNS) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *DNS) lines() (lines []string) {
+	lines = append(lines, lastIndent+"DNS:")
+
+	if settings.PlaintextAddress != nil {
+		lines = append(lines, indent+lastIndent+"Plaintext address: "+settings.PlaintextAddress.String())
+	}
+
+	if settings.KeepNameserver {
+		lines = append(lines, indent+lastIndent+"Keep nameserver (disabled blocking): yes")
+	}
+
+	if !settings.Enabled {
+		return lines
+	}
+
+	lines = append(lines, indent+lastIndent+"DNS over TLS:")
+
+	lines = append(lines, indent+indent+lastIndent+"Unbound:")
+	for _, line := range settings.Unbound.Lines() {
+		lines = append(lines, indent+indent+indent+line)
+	}
+
+	lines = append(lines, indent+indent+lastIndent+"Blacklist:")
+	for _, line := range settings.BlacklistBuild.Lines(indent, lastIndent) {
+		lines = append(lines, indent+indent+indent+line)
+	}
+
+	if settings.UpdatePeriod > 0 {
+		lines = append(lines, indent+indent+lastIndent+"Update: every "+settings.UpdatePeriod.String())
+	}
+
+	return lines
+}
+
+var (
+	ErrUnboundSettings   = errors.New("failed getting Unbound settings")
+	ErrBlacklistSettings = errors.New("failed getting DNS blacklist settings")
+)
+
+func (settings *DNS) read(r reader) (err error) {
+	settings.Enabled, err = r.env.OnOff("DOT", params.Default("on"))
+	if err != nil {
+		return fmt.Errorf("environment variable DOT: %w", err)
+	}
+
+	// Plain DNS settings
+	if err := settings.readDNSPlaintext(r.env); err != nil {
+		return err
+	}
+	settings.KeepNameserver, err = r.env.OnOff("DNS_KEEP_NAMESERVER", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable DNS_KEEP_NAMESERVER: %w", err)
+	}
+
+	// DNS over TLS external settings
+	if err := settings.readBlacklistBuilding(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrBlacklistSettings, err)
+	}
+
+	settings.UpdatePeriod, err = r.env.Duration("DNS_UPDATE_PERIOD", params.Default("24h"))
+	if err != nil {
+		return fmt.Errorf("environment variable DNS_UPDATE_PERIOD: %w", err)
+	}
+
+	// Unbound settings
+	if err := settings.readUnbound(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrUnboundSettings, err)
+	}
+
+	return nil
+}
+
+var (
+	ErrDNSAddressNotAnIP = errors.New("DNS plaintext address is not an IP address")
+)
+
+func (settings *DNS) readDNSPlaintext(env params.Interface) error {
+	s, err := env.Get("DNS_PLAINTEXT_ADDRESS", params.Default("1.1.1.1"))
+	if err != nil {
+		return fmt.Errorf("environment variable DNS_PLAINTEXT_ADDRESS: %w", err)
+	}
+
+	settings.PlaintextAddress = net.ParseIP(s)
+	if settings.PlaintextAddress == nil {
+		return fmt.Errorf("%w: %s", ErrDNSAddressNotAnIP, s)
+	}
+
+	return nil
+}

internal/configuration/dns_test.go

@@ -0,0 +1,76 @@
+package configuration
+
+import (
+	"net"
+	"testing"
+	"time"
+
+	"github.com/qdm12/dns/pkg/blacklist"
+	"github.com/qdm12/dns/pkg/provider"
+	"github.com/qdm12/dns/pkg/unbound"
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_DNS_Lines(t *testing.T) {
+	t.Parallel()
+	testCases := map[string]struct {
+		settings DNS
+		lines    []string
+	}{
+		"disabled DOT": {
+			settings: DNS{
+				PlaintextAddress: net.IP{1, 1, 1, 1},
+			},
+			lines: []string{
+				"|--DNS:",
+				"   |--Plaintext address: 1.1.1.1",
+			},
+		},
+		"enabled DOT": {
+			settings: DNS{
+				Enabled:        true,
+				KeepNameserver: true,
+				Unbound: unbound.Settings{
+					Providers: []provider.Provider{
+						provider.Cloudflare(),
+					},
+				},
+				BlacklistBuild: blacklist.BuilderSettings{
+					BlockMalicious:    true,
+					BlockAds:          true,
+					BlockSurveillance: true,
+				},
+				UpdatePeriod: time.Hour,
+			},
+			lines: []string{
+				"|--DNS:",
+				"   |--Keep nameserver (disabled blocking): yes",
+				"   |--DNS over TLS:",
+				"      |--Unbound:",
+				"          |--DNS over TLS providers:",
+				"              |--Cloudflare",
+				"          |--Listening port: 0",
+				"          |--Access control:",
+				"              |--Allowed:",
+				"          |--Caching: disabled",
+				"          |--IPv4 resolution: disabled",
+				"          |--IPv6 resolution: disabled",
+				"          |--Verbosity level: 0/5",
+				"          |--Verbosity details level: 0/4",
+				"          |--Validation log level: 0/2",
+				"          |--Username: ",
+				"      |--Blacklist:",
+				"         |--Blocked categories: malicious, surveillance, ads",
+				"      |--Update: every 1h0m0s",
+			},
+		},
+	}
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			lines := testCase.settings.lines()
+			assert.Equal(t, testCase.lines, lines)
+		})
+	}
+}

internal/configuration/dnsblacklist.go

@@ -0,0 +1,87 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/qdm12/golibs/params"
+	"inet.af/netaddr"
+)
+
+func (settings *DNS) readBlacklistBuilding(r reader) (err error) {
+	settings.BlacklistBuild.BlockMalicious, err = r.env.OnOff("BLOCK_MALICIOUS", params.Default("on"))
+	if err != nil {
+		return fmt.Errorf("environment variable BLOCK_MALICIOUS: %w", err)
+	}
+
+	settings.BlacklistBuild.BlockSurveillance, err = r.env.OnOff("BLOCK_SURVEILLANCE", params.Default("on"),
+		params.RetroKeys([]string{"BLOCK_NSA"}, r.onRetroActive))
+	if err != nil {
+		return fmt.Errorf("environment variable BLOCK_SURVEILLANCE (or BLOCK_NSA): %w", err)
+	}
+
+	settings.BlacklistBuild.BlockAds, err = r.env.OnOff("BLOCK_ADS", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable BLOCK_ADS: %w", err)
+	}
+
+	if err := settings.readPrivateAddresses(r.env); err != nil {
+		return err
+	}
+
+	return settings.readBlacklistUnblockedHostnames(r)
+}
+
+var (
+	ErrInvalidPrivateAddress = errors.New("private address is not a valid IP or CIDR range")
+)
+
+func (settings *DNS) readPrivateAddresses(env params.Interface) (err error) {
+	privateAddresses, err := env.CSV("DOT_PRIVATE_ADDRESS")
+	if err != nil {
+		return fmt.Errorf("environment variable DOT_PRIVATE_ADDRESS: %w", err)
+	} else if len(privateAddresses) == 0 {
+		return nil
+	}
+
+	ips := make([]netaddr.IP, 0, len(privateAddresses))
+	ipPrefixes := make([]netaddr.IPPrefix, 0, len(privateAddresses))
+
+	for _, address := range privateAddresses {
+		ip, err := netaddr.ParseIP(address)
+		if err == nil {
+			ips = append(ips, ip)
+			continue
+		}
+
+		ipPrefix, err := netaddr.ParseIPPrefix(address)
+		if err == nil {
+			ipPrefixes = append(ipPrefixes, ipPrefix)
+			continue
+		}
+
+		return fmt.Errorf("%w: %s", ErrInvalidPrivateAddress, address)
+	}
+
+	settings.BlacklistBuild.AddBlockedIPs = append(settings.BlacklistBuild.AddBlockedIPs, ips...)
+	settings.BlacklistBuild.AddBlockedIPPrefixes = append(settings.BlacklistBuild.AddBlockedIPPrefixes, ipPrefixes...)
+
+	return nil
+}
+
+func (settings *DNS) readBlacklistUnblockedHostnames(r reader) (err error) {
+	hostnames, err := r.env.CSV("UNBLOCK")
+	if err != nil {
+		return fmt.Errorf("environment variable UNBLOCK: %w", err)
+	} else if len(hostnames) == 0 {
+		return nil
+	}
+	for _, hostname := range hostnames {
+		if !r.regex.MatchHostname(hostname) {
+			return fmt.Errorf("%w: %s", ErrInvalidHostname, hostname)
+		}
+	}
+
+	settings.BlacklistBuild.AllowedHosts = append(settings.BlacklistBuild.AllowedHosts, hostnames...)
+	return nil
+}

internal/configuration/expressvpn.go

@@ -0,0 +1,40 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) readExpressvpn(r reader) (err error) {
+	settings.Name = constants.Expressvpn
+	servers := r.servers.GetExpressvpn()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME",
+		constants.ExpressvpnHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.ExpressvpnCountriesChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.ExpressvpnCityChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.OpenVPN.TCP, err = readOpenVPNProtocol(r)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/configuration/fastestvpn.go

@@ -0,0 +1,30 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) readFastestvpn(r reader) (err error) {
+	settings.Name = constants.Fastestvpn
+	servers := r.servers.GetFastestvpn()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME",
+		constants.FastestvpnHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.FastestvpnCountriesChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	return settings.ServerSelection.OpenVPN.readProtocolOnly(r)
+}

internal/configuration/firewall.go

@@ -0,0 +1,99 @@
+package configuration
+
+import (
+	"fmt"
+	"net"
+	"strings"
+
+	"github.com/qdm12/golibs/params"
+)
+
+// Firewall contains settings to customize the firewall operation.
+type Firewall struct {
+	VPNInputPorts   []uint16
+	InputPorts      []uint16
+	OutboundSubnets []net.IPNet
+	Enabled         bool
+	Debug           bool
+}
+
+func (settings *Firewall) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *Firewall) lines() (lines []string) {
+	if !settings.Enabled {
+		lines = append(lines, lastIndent+"Firewall: disabled ⚠️")
+		return lines
+	}
+
+	lines = append(lines, lastIndent+"Firewall:")
+
+	if settings.Debug {
+		lines = append(lines, indent+lastIndent+"Debug: on")
+	}
+
+	if len(settings.VPNInputPorts) > 0 {
+		lines = append(lines, indent+lastIndent+"VPN input ports: "+
+			strings.Join(uint16sToStrings(settings.VPNInputPorts), ", "))
+	}
+
+	if len(settings.InputPorts) > 0 {
+		lines = append(lines, indent+lastIndent+"Input ports: "+
+			strings.Join(uint16sToStrings(settings.InputPorts), ", "))
+	}
+
+	if len(settings.OutboundSubnets) > 0 {
+		lines = append(lines, indent+lastIndent+"Outbound subnets: "+
+			strings.Join(ipNetsToStrings(settings.OutboundSubnets), ", "))
+	}
+
+	return lines
+}
+
+func (settings *Firewall) read(r reader) (err error) {
+	settings.Enabled, err = r.env.OnOff("FIREWALL", params.Default("on"))
+	if err != nil {
+		return fmt.Errorf("environment variable FIREWALL: %w", err)
+	}
+
+	settings.Debug, err = r.env.OnOff("FIREWALL_DEBUG", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable FIREWALL_DEBUG: %w", err)
+	}
+
+	if err := settings.readVPNInputPorts(r.env); err != nil {
+		return err
+	}
+
+	if err := settings.readInputPorts(r.env); err != nil {
+		return err
+	}
+
+	return settings.readOutboundSubnets(r)
+}
+
+func (settings *Firewall) readVPNInputPorts(env params.Interface) (err error) {
+	settings.VPNInputPorts, err = readCSVPorts(env, "FIREWALL_VPN_INPUT_PORTS")
+	if err != nil {
+		return fmt.Errorf("environment variable FIREWALL_VPN_INPUT_PORTS: %w", err)
+	}
+	return nil
+}
+
+func (settings *Firewall) readInputPorts(env params.Interface) (err error) {
+	settings.InputPorts, err = readCSVPorts(env, "FIREWALL_INPUT_PORTS")
+	if err != nil {
+		return fmt.Errorf("environment variable FIREWALL_INPUT_PORTS: %w", err)
+	}
+	return nil
+}
+
+func (settings *Firewall) readOutboundSubnets(r reader) (err error) {
+	retroOption := params.RetroKeys([]string{"EXTRA_SUBNETS"}, r.onRetroActive)
+	settings.OutboundSubnets, err = readCSVIPNets(r.env, "FIREWALL_OUTBOUND_SUBNETS", retroOption)
+	if err != nil {
+		return fmt.Errorf("environment variable FIREWALL_OUTBOUND_SUBNETS: %w", err)
+	}
+	return nil
+}

internal/configuration/health.go

@@ -0,0 +1,72 @@
+package configuration
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/golibs/params"
+)
+
+// Health contains settings for the healthcheck and health server.
+type Health struct {
+	ServerAddress string
+	AddressToPing string
+	VPN           HealthyWait
+}
+
+func (settings *Health) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *Health) lines() (lines []string) {
+	lines = append(lines, lastIndent+"Health:")
+
+	lines = append(lines, indent+lastIndent+"Server address: "+settings.ServerAddress)
+
+	lines = append(lines, indent+lastIndent+"Address to ping: "+settings.AddressToPing)
+
+	lines = append(lines, indent+lastIndent+"VPN:")
+	for _, line := range settings.VPN.lines() {
+		lines = append(lines, indent+indent+line)
+	}
+
+	return lines
+}
+
+// Read is to be used for the healthcheck query mode.
+func (settings *Health) Read(env params.Interface, warner Warner) (err error) {
+	reader := newReader(env, models.AllServers{}, warner) // note: no need for servers data
+	return settings.read(reader)
+}
+
+func (settings *Health) read(r reader) (err error) {
+	var warning string
+	settings.ServerAddress, warning, err = r.env.ListeningAddress(
+		"HEALTH_SERVER_ADDRESS", params.Default("127.0.0.1:9999"))
+	if warning != "" {
+		r.warner.Warn("environment variable HEALTH_SERVER_ADDRESS: " + warning)
+	}
+	if err != nil {
+		return fmt.Errorf("environment variable HEALTH_SERVER_ADDRESS: %w", err)
+	}
+
+	settings.AddressToPing, err = r.env.Get("HEALTH_ADDRESS_TO_PING", params.Default("github.com"))
+	if err != nil {
+		return fmt.Errorf("environment variable HEALTH_ADDRESS_TO_PING: %w", err)
+	}
+
+	retroKeyOption := params.RetroKeys([]string{"HEALTH_OPENVPN_DURATION_INITIAL"}, r.onRetroActive)
+	settings.VPN.Initial, err = r.env.Duration("HEALTH_VPN_DURATION_INITIAL", params.Default("6s"), retroKeyOption)
+	if err != nil {
+		return fmt.Errorf("environment variable HEALTH_VPN_DURATION_INITIAL: %w", err)
+	}
+
+	retroKeyOption = params.RetroKeys([]string{"HEALTH_OPENVPN_DURATION_ADDITION"}, r.onRetroActive)
+	settings.VPN.Addition, err = r.env.Duration("HEALTH_VPN_DURATION_ADDITION", params.Default("5s"), retroKeyOption)
+	if err != nil {
+		return fmt.Errorf("environment variable HEALTH_VPN_DURATION_ADDITION: %w", err)
+	}
+
+	return nil
+}

internal/configuration/health_test.go

@@ -0,0 +1,272 @@
+package configuration
+
+import (
+	"errors"
+	"testing"
+	"time"
+
+	"github.com/golang/mock/gomock"
+	"github.com/qdm12/golibs/params/mock_params"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_Health_String(t *testing.T) {
+	t.Parallel()
+
+	health := Health{
+		ServerAddress: "a",
+		AddressToPing: "b",
+	}
+	const expected = `|--Health:
+   |--Server address: a
+   |--Address to ping: b
+   |--VPN:
+      |--Initial duration: 0s`
+
+	s := health.String()
+
+	assert.Equal(t, expected, s)
+}
+
+func Test_Health_lines(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		settings Health
+		lines    []string
+	}{
+		"empty": {
+			lines: []string{
+				"|--Health:",
+				"   |--Server address: ",
+				"   |--Address to ping: ",
+				"   |--VPN:",
+				"      |--Initial duration: 0s",
+			},
+		},
+		"filled settings": {
+			settings: Health{
+				ServerAddress: "address:9999",
+				AddressToPing: "github.com",
+				VPN: HealthyWait{
+					Initial:  time.Second,
+					Addition: time.Minute,
+				},
+			},
+			lines: []string{
+				"|--Health:",
+				"   |--Server address: address:9999",
+				"   |--Address to ping: github.com",
+				"   |--VPN:",
+				"      |--Initial duration: 1s",
+				"      |--Addition duration: 1m0s",
+			},
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			lines := testCase.settings.lines()
+
+			assert.Equal(t, testCase.lines, lines)
+		})
+	}
+}
+
+func Test_Health_read(t *testing.T) {
+	t.Parallel()
+
+	errDummy := errors.New("dummy")
+
+	type stringCall struct {
+		call bool
+		s    string
+		err  error
+	}
+
+	type stringCallWithWarning struct {
+		call    bool
+		s       string
+		warning string
+		err     error
+	}
+
+	type durationCall struct {
+		call     bool
+		duration time.Duration
+		err      error
+	}
+
+	testCases := map[string]struct {
+		serverAddress stringCallWithWarning
+		addressToPing stringCall
+		vpnInitial    durationCall
+		vpnAddition   durationCall
+		expected      Health
+		err           error
+	}{
+		"success": {
+			serverAddress: stringCallWithWarning{
+				call: true,
+				s:    "127.0.0.1:9999",
+			},
+			addressToPing: stringCall{
+				call: true,
+				s:    "1.2.3.4",
+			},
+			vpnInitial: durationCall{
+				call:     true,
+				duration: time.Second,
+			},
+			vpnAddition: durationCall{
+				call:     true,
+				duration: time.Minute,
+			},
+			expected: Health{
+				ServerAddress: "127.0.0.1:9999",
+				AddressToPing: "1.2.3.4",
+				VPN: HealthyWait{
+					Initial:  time.Second,
+					Addition: time.Minute,
+				},
+			},
+		},
+		"listening address error": {
+			serverAddress: stringCallWithWarning{
+				call:    true,
+				s:       "127.0.0.1:9999",
+				warning: "warning",
+				err:     errDummy,
+			},
+			expected: Health{
+				ServerAddress: "127.0.0.1:9999",
+			},
+			err: errors.New("environment variable HEALTH_SERVER_ADDRESS: dummy"),
+		},
+		"address to ping error": {
+			serverAddress: stringCallWithWarning{
+				call: true,
+			},
+			addressToPing: stringCall{
+				call: true,
+				s:    "address",
+				err:  errDummy,
+			},
+			expected: Health{
+				AddressToPing: "address",
+			},
+			err: errors.New("environment variable HEALTH_ADDRESS_TO_PING: dummy"),
+		},
+		"initial error": {
+			serverAddress: stringCallWithWarning{
+				call: true,
+			},
+			addressToPing: stringCall{
+				call: true,
+			},
+			vpnInitial: durationCall{
+				call:     true,
+				duration: time.Second,
+				err:      errDummy,
+			},
+			expected: Health{
+				VPN: HealthyWait{
+					Initial: time.Second,
+				},
+			},
+			err: errors.New("environment variable HEALTH_VPN_DURATION_INITIAL: dummy"),
+		},
+		"addition error": {
+			serverAddress: stringCallWithWarning{
+				call: true,
+			},
+			addressToPing: stringCall{
+				call: true,
+			},
+			vpnInitial: durationCall{
+				call:     true,
+				duration: time.Second,
+			},
+			vpnAddition: durationCall{
+				call:     true,
+				duration: time.Minute,
+				err:      errDummy,
+			},
+			expected: Health{
+				VPN: HealthyWait{
+					Initial:  time.Second,
+					Addition: time.Minute,
+				},
+			},
+			err: errors.New("environment variable HEALTH_VPN_DURATION_ADDITION: dummy"),
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			ctrl := gomock.NewController(t)
+
+			env := mock_params.NewMockInterface(ctrl)
+			warner := NewMockWarner(ctrl)
+
+			if testCase.serverAddress.call {
+				value := testCase.serverAddress.s
+				warning := testCase.serverAddress.warning
+				err := testCase.serverAddress.err
+				env.EXPECT().ListeningAddress("HEALTH_SERVER_ADDRESS", gomock.Any()).
+					Return(value, warning, err)
+				if warning != "" {
+					warner.EXPECT().Warn("environment variable HEALTH_SERVER_ADDRESS: " + warning)
+				}
+			}
+
+			if testCase.addressToPing.call {
+				value := testCase.addressToPing.s
+				err := testCase.addressToPing.err
+				env.EXPECT().Get("HEALTH_ADDRESS_TO_PING", gomock.Any()).
+					Return(value, err)
+			}
+
+			if testCase.vpnInitial.call {
+				value := testCase.vpnInitial.duration
+				err := testCase.vpnInitial.err
+				env.EXPECT().
+					Duration("HEALTH_VPN_DURATION_INITIAL", gomock.Any()).
+					Return(value, err)
+			}
+
+			if testCase.vpnAddition.call {
+				value := testCase.vpnAddition.duration
+				err := testCase.vpnAddition.err
+				env.EXPECT().
+					Duration("HEALTH_VPN_DURATION_ADDITION", gomock.Any()).
+					Return(value, err)
+			}
+
+			r := reader{
+				env:    env,
+				warner: warner,
+			}
+
+			var health Health
+
+			err := health.read(r)
+
+			if testCase.err != nil {
+				require.Error(t, err)
+				assert.Equal(t, testCase.err.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+			}
+
+			assert.Equal(t, testCase.expected, health)
+		})
+	}
+}

internal/configuration/healthwait_test.go

@@ -0,0 +1,55 @@
+package configuration
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_HealthyWait_String(t *testing.T) {
+	t.Parallel()
+
+	var healthyWait HealthyWait
+	const expected = "|--Initial duration: 0s"
+
+	s := healthyWait.String()
+
+	assert.Equal(t, expected, s)
+}
+
+func Test_HealthyWait_lines(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		settings HealthyWait
+		lines    []string
+	}{
+		"empty": {
+			lines: []string{
+				"|--Initial duration: 0s",
+			},
+		},
+		"filled settings": {
+			settings: HealthyWait{
+				Initial:  time.Second,
+				Addition: time.Minute,
+			},
+			lines: []string{
+				"|--Initial duration: 1s",
+				"|--Addition duration: 1m0s",
+			},
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			lines := testCase.settings.lines()
+
+			assert.Equal(t, testCase.lines, lines)
+		})
+	}
+}

internal/configuration/healthywait.go

@@ -0,0 +1,30 @@
+package configuration
+
+import (
+	"strings"
+	"time"
+)
+
+type HealthyWait struct {
+	// Initial is the initial duration to wait for the program
+	// to be healthy before taking action.
+	Initial time.Duration
+	// Addition is the duration to add to the Initial duration
+	// after Initial has expired to wait longer for the program
+	// to be healthy.
+	Addition time.Duration
+}
+
+func (settings *HealthyWait) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *HealthyWait) lines() (lines []string) {
+	lines = append(lines, lastIndent+"Initial duration: "+settings.Initial.String())
+
+	if settings.Addition > 0 {
+		lines = append(lines, lastIndent+"Addition duration: "+settings.Addition.String())
+	}
+
+	return lines
+}

internal/configuration/hidemyass.go

@@ -0,0 +1,40 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) readHideMyAss(r reader) (err error) {
+	settings.Name = constants.HideMyAss
+	servers := r.servers.GetHideMyAss()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.HideMyAssCountryChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.HideMyAssCountryChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.HideMyAssCityChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME",
+		constants.HideMyAssHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return settings.ServerSelection.OpenVPN.readProtocolAndPort(r)
+}

internal/configuration/httpproxy.go

@@ -0,0 +1,106 @@
+package configuration
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/qdm12/golibs/params"
+)
+
+// HTTPProxy contains settings to configure the HTTP proxy.
+type HTTPProxy struct {
+	User     string
+	Password string
+	Port     uint16
+	Enabled  bool
+	Stealth  bool
+	Log      bool
+}
+
+func (settings *HTTPProxy) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *HTTPProxy) lines() (lines []string) {
+	if !settings.Enabled {
+		return nil
+	}
+
+	lines = append(lines, lastIndent+"HTTP proxy:")
+
+	lines = append(lines, indent+lastIndent+"Port: "+strconv.Itoa(int(settings.Port)))
+
+	if settings.User != "" {
+		lines = append(lines, indent+lastIndent+"Authentication: enabled")
+	}
+
+	if settings.Log {
+		lines = append(lines, indent+lastIndent+"Log: enabled")
+	}
+
+	if settings.Stealth {
+		lines = append(lines, indent+lastIndent+"Stealth: enabled")
+	}
+
+	return lines
+}
+
+func (settings *HTTPProxy) read(r reader) (err error) {
+	settings.Enabled, err = r.env.OnOff("HTTPPROXY", params.Default("off"),
+		params.RetroKeys([]string{"TINYPROXY", "PROXY"}, r.onRetroActive))
+	if err != nil {
+		return fmt.Errorf("environment variable HTTPPROXY (or TINYPROXY, PROXY): %w", err)
+	}
+
+	settings.User, err = r.getFromEnvOrSecretFile("HTTPPROXY_USER", false, // compulsory
+		[]string{"TINYPROXY_USER", "PROXY_USER"})
+	if err != nil {
+		return fmt.Errorf("environment variable HTTPPROXY_USER (or TINYPROXY_USER, PROXY_USER): %w", err)
+	}
+
+	settings.Password, err = r.getFromEnvOrSecretFile("HTTPPROXY_PASSWORD", false,
+		[]string{"TINYPROXY_PASSWORD", "PROXY_PASSWORD"})
+	if err != nil {
+		return fmt.Errorf("environment variable HTTPPROXY_PASSWORD (or TINYPROXY_PASSWORD, PROXY_PASSWORD): %w", err)
+	}
+
+	settings.Stealth, err = r.env.OnOff("HTTPPROXY_STEALTH", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable HTTPPROXY_STEALTH: %w", err)
+	}
+
+	if err := settings.readLog(r); err != nil {
+		return err
+	}
+
+	var warning string
+	settings.Port, warning, err = r.env.ListeningPort("HTTPPROXY_PORT", params.Default("8888"),
+		params.RetroKeys([]string{"TINYPROXY_PORT", "PROXY_PORT"}, r.onRetroActive))
+	if len(warning) > 0 {
+		r.warner.Warn(warning)
+	}
+	if err != nil {
+		return fmt.Errorf("environment variable HTTPPROXY_PORT (or TINYPROXY_PORT, PROXY_PORT): %w", err)
+	}
+
+	return nil
+}
+
+func (settings *HTTPProxy) readLog(r reader) error {
+	s, err := r.env.Get("HTTPPROXY_LOG",
+		params.RetroKeys([]string{"PROXY_LOG_LEVEL", "TINYPROXY_LOG"}, r.onRetroActive))
+	if err != nil {
+		return fmt.Errorf("environment variable HTTPPROXY_LOG (or TINYPROXY_LOG, PROXY_LOG_LEVEL): %w", err)
+	}
+
+	switch strings.ToLower(s) {
+	case "on":
+		settings.Log = true
+	// Retro compatibility
+	case "info", "connect", "notice":
+		settings.Log = true
+	}
+
+	return nil
+}

internal/configuration/ipvanish.go

@@ -0,0 +1,35 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) readIpvanish(r reader) (err error) {
+	settings.Name = constants.Ipvanish
+	servers := r.servers.GetIpvanish()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.IpvanishCountryChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.IpvanishCityChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME",
+		constants.IpvanishHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return settings.ServerSelection.OpenVPN.readProtocolOnly(r)
+}

internal/configuration/ipvanish_test.go

@@ -0,0 +1,170 @@
+package configuration
+
+import (
+	"errors"
+	"net"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/golibs/params/mock_params"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_Provider_readIpvanish(t *testing.T) {
+	t.Parallel()
+
+	var errDummy = errors.New("dummy test error")
+
+	type singleStringCall struct {
+		call  bool
+		value string
+		err   error
+	}
+
+	type sliceStringCall struct {
+		call   bool
+		values []string
+		err    error
+	}
+
+	testCases := map[string]struct {
+		targetIP  singleStringCall
+		countries sliceStringCall
+		cities    sliceStringCall
+		hostnames sliceStringCall
+		protocol  singleStringCall
+		settings  Provider
+		err       error
+	}{
+		"target IP error": {
+			targetIP: singleStringCall{call: true, value: "something", err: errDummy},
+			settings: Provider{
+				Name: constants.Ipvanish,
+			},
+			err: errors.New("environment variable OPENVPN_TARGET_IP: dummy test error"),
+		},
+		"countries error": {
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ipvanish,
+			},
+			err: errors.New("environment variable COUNTRY: dummy test error"),
+		},
+		"cities error": {
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ipvanish,
+			},
+			err: errors.New("environment variable CITY: dummy test error"),
+		},
+		"hostnames error": {
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ipvanish,
+			},
+			err: errors.New("environment variable SERVER_HOSTNAME: dummy test error"),
+		},
+		"protocol error": {
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true},
+			protocol:  singleStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ipvanish,
+			},
+			err: errors.New("environment variable OPENVPN_PROTOCOL: dummy test error"),
+		},
+		"default settings": {
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true},
+			protocol:  singleStringCall{call: true},
+			settings: Provider{
+				Name: constants.Ipvanish,
+			},
+		},
+		"set settings": {
+			targetIP:  singleStringCall{call: true, value: "1.2.3.4"},
+			countries: sliceStringCall{call: true, values: []string{"A", "B"}},
+			cities:    sliceStringCall{call: true, values: []string{"C", "D"}},
+			hostnames: sliceStringCall{call: true, values: []string{"E", "F"}},
+			protocol:  singleStringCall{call: true, value: constants.TCP},
+			settings: Provider{
+				Name: constants.Ipvanish,
+				ServerSelection: ServerSelection{
+					OpenVPN: OpenVPNSelection{
+						TCP: true,
+					},
+					TargetIP:  net.IPv4(1, 2, 3, 4),
+					Countries: []string{"A", "B"},
+					Cities:    []string{"C", "D"},
+					Hostnames: []string{"E", "F"},
+				},
+			},
+		},
+	}
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			ctrl := gomock.NewController(t)
+
+			servers := []models.IpvanishServer{{Hostname: "a"}}
+			allServers := models.AllServers{
+				Ipvanish: models.IpvanishServers{
+					Servers: servers,
+				},
+			}
+
+			env := mock_params.NewMockInterface(ctrl)
+			if testCase.targetIP.call {
+				env.EXPECT().Get("OPENVPN_TARGET_IP").
+					Return(testCase.targetIP.value, testCase.targetIP.err)
+			}
+			if testCase.countries.call {
+				env.EXPECT().CSVInside("COUNTRY", constants.IpvanishCountryChoices(servers)).
+					Return(testCase.countries.values, testCase.countries.err)
+			}
+			if testCase.cities.call {
+				env.EXPECT().CSVInside("CITY", constants.IpvanishCityChoices(servers)).
+					Return(testCase.cities.values, testCase.cities.err)
+			}
+			if testCase.hostnames.call {
+				env.EXPECT().CSVInside("SERVER_HOSTNAME", constants.IpvanishHostnameChoices(servers)).
+					Return(testCase.hostnames.values, testCase.hostnames.err)
+			}
+			if testCase.protocol.call {
+				env.EXPECT().Inside("OPENVPN_PROTOCOL", []string{constants.TCP, constants.UDP}, gomock.Any()).
+					Return(testCase.protocol.value, testCase.protocol.err)
+			}
+
+			r := reader{
+				servers: allServers,
+				env:     env,
+			}
+
+			var settings Provider
+			err := settings.readIpvanish(r)
+
+			if testCase.err != nil {
+				require.Error(t, err)
+				assert.Equal(t, testCase.err.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+			}
+
+			assert.Equal(t, testCase.settings, settings)
+		})
+	}
+}

internal/configuration/ivpn.go

@@ -0,0 +1,73 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+func (settings *Provider) readIvpn(r reader) (err error) {
+	settings.Name = constants.Ivpn
+	servers := r.servers.GetIvpn()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.IvpnCountryChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.IvpnCityChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.ISPs, err = r.env.CSVInside("ISP", constants.IvpnISPChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable ISP: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.IvpnHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	err = settings.ServerSelection.OpenVPN.readIVPN(r)
+	if err != nil {
+		return err
+	}
+
+	return settings.ServerSelection.Wireguard.readIVPN(r.env)
+}
+
+func (settings *OpenVPNSelection) readIVPN(r reader) (err error) {
+	settings.TCP, err = readOpenVPNProtocol(r)
+	if err != nil {
+		return err
+	}
+
+	settings.CustomPort, err = readOpenVPNCustomPort(r, openvpnPortValidation{
+		tcp:        settings.TCP,
+		allowedTCP: []uint16{80, 443, 1443},
+		allowedUDP: []uint16{53, 1194, 2049, 2050},
+	})
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (settings *WireguardSelection) readIVPN(env params.Interface) (err error) {
+	settings.EndpointPort, err = readWireguardCustomPort(env,
+		[]uint16{2049, 2050, 53, 30587, 41893, 48574, 58237})
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/configuration/ivpn_test.go

@@ -0,0 +1,274 @@
+package configuration
+
+import (
+	"errors"
+	"net"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/golibs/params/mock_params"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_Provider_readIvpn(t *testing.T) { //nolint:gocognit
+	t.Parallel()
+
+	var errDummy = errors.New("dummy test error")
+
+	type singleStringCall struct {
+		call  bool
+		value string
+		err   error
+	}
+
+	type portCall struct {
+		getCall   bool
+		getValue  string // "" or "0"
+		getErr    error
+		portCall  bool
+		portValue uint16
+		portErr   error
+	}
+
+	type sliceStringCall struct {
+		call   bool
+		values []string
+		err    error
+	}
+
+	testCases := map[string]struct {
+		targetIP    singleStringCall
+		countries   sliceStringCall
+		cities      sliceStringCall
+		isps        sliceStringCall
+		hostnames   sliceStringCall
+		protocol    singleStringCall
+		ovpnPort    portCall
+		ovpnOldPort portCall
+		wgPort      portCall
+		wgOldPort   portCall
+		settings    Provider
+		err         error
+	}{
+		"target IP error": {
+			targetIP: singleStringCall{call: true, value: "something", err: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable OPENVPN_TARGET_IP: dummy test error"),
+		},
+		"countries error": {
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable COUNTRY: dummy test error"),
+		},
+		"cities error": {
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable CITY: dummy test error"),
+		},
+		"isps error": {
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			isps:      sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable ISP: dummy test error"),
+		},
+		"hostnames error": {
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			isps:      sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable SERVER_HOSTNAME: dummy test error"),
+		},
+		"openvpn protocol error": {
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			isps:      sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true},
+			protocol:  singleStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable OPENVPN_PROTOCOL: dummy test error"),
+		},
+		"openvpn custom port error": {
+			targetIP:  singleStringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			isps:      sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true},
+			protocol:  singleStringCall{call: true},
+			ovpnPort:  portCall{getCall: true, getErr: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable OPENVPN_PORT: dummy test error"),
+		},
+		"wireguard custom port error": {
+			targetIP:    singleStringCall{call: true},
+			countries:   sliceStringCall{call: true},
+			cities:      sliceStringCall{call: true},
+			isps:        sliceStringCall{call: true},
+			hostnames:   sliceStringCall{call: true},
+			protocol:    singleStringCall{call: true},
+			ovpnPort:    portCall{getCall: true, getValue: "0"},
+			ovpnOldPort: portCall{getCall: true, getValue: "0"},
+			wgPort:      portCall{getCall: true, getErr: errDummy},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+			err: errors.New("environment variable WIREGUARD_ENDPOINT_PORT: dummy test error"),
+		},
+		"default settings": {
+			targetIP:    singleStringCall{call: true},
+			countries:   sliceStringCall{call: true},
+			cities:      sliceStringCall{call: true},
+			isps:        sliceStringCall{call: true},
+			hostnames:   sliceStringCall{call: true},
+			protocol:    singleStringCall{call: true},
+			ovpnPort:    portCall{getCall: true, getValue: "0"},
+			ovpnOldPort: portCall{getCall: true, getValue: "0"},
+			wgPort:      portCall{getCall: true, getValue: "0"},
+			wgOldPort:   portCall{getCall: true, getValue: "0"},
+			settings: Provider{
+				Name: constants.Ivpn,
+			},
+		},
+		"set settings": {
+			targetIP:  singleStringCall{call: true, value: "1.2.3.4"},
+			countries: sliceStringCall{call: true, values: []string{"A", "B"}},
+			cities:    sliceStringCall{call: true, values: []string{"C", "D"}},
+			isps:      sliceStringCall{call: true, values: []string{"ISP 1"}},
+			hostnames: sliceStringCall{call: true, values: []string{"E", "F"}},
+			protocol:  singleStringCall{call: true, value: constants.TCP},
+			ovpnPort:  portCall{getCall: true, portCall: true, portValue: 443},
+			wgPort:    portCall{getCall: true, portCall: true, portValue: 2049},
+			settings: Provider{
+				Name: constants.Ivpn,
+				ServerSelection: ServerSelection{
+					OpenVPN: OpenVPNSelection{
+						TCP:        true,
+						CustomPort: 443,
+					},
+					Wireguard: WireguardSelection{
+						EndpointPort: 2049,
+					},
+					TargetIP:  net.IPv4(1, 2, 3, 4),
+					Countries: []string{"A", "B"},
+					Cities:    []string{"C", "D"},
+					ISPs:      []string{"ISP 1"},
+					Hostnames: []string{"E", "F"},
+				},
+			},
+		},
+	}
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			ctrl := gomock.NewController(t)
+
+			env := mock_params.NewMockInterface(ctrl)
+
+			servers := []models.IvpnServer{{Hostname: "a"}}
+			allServers := models.AllServers{
+				Ivpn: models.IvpnServers{
+					Servers: servers,
+				},
+			}
+
+			if testCase.targetIP.call {
+				env.EXPECT().Get("OPENVPN_TARGET_IP").
+					Return(testCase.targetIP.value, testCase.targetIP.err)
+			}
+			if testCase.countries.call {
+				env.EXPECT().CSVInside("COUNTRY", constants.IvpnCountryChoices(servers)).
+					Return(testCase.countries.values, testCase.countries.err)
+			}
+			if testCase.cities.call {
+				env.EXPECT().CSVInside("CITY", constants.IvpnCityChoices(servers)).
+					Return(testCase.cities.values, testCase.cities.err)
+			}
+			if testCase.isps.call {
+				env.EXPECT().CSVInside("ISP", constants.IvpnISPChoices(servers)).
+					Return(testCase.isps.values, testCase.isps.err)
+			}
+			if testCase.hostnames.call {
+				env.EXPECT().CSVInside("SERVER_HOSTNAME", constants.IvpnHostnameChoices(servers)).
+					Return(testCase.hostnames.values, testCase.hostnames.err)
+			}
+			if testCase.protocol.call {
+				env.EXPECT().Inside("OPENVPN_PROTOCOL", []string{constants.TCP, constants.UDP}, gomock.Any()).
+					Return(testCase.protocol.value, testCase.protocol.err)
+			}
+			if testCase.ovpnPort.getCall {
+				env.EXPECT().Get("OPENVPN_PORT", gomock.Any()).
+					Return(testCase.ovpnPort.getValue, testCase.ovpnPort.getErr)
+			}
+			if testCase.ovpnPort.portCall {
+				env.EXPECT().Port("OPENVPN_PORT").
+					Return(testCase.ovpnPort.portValue, testCase.ovpnPort.portErr)
+			}
+			if testCase.ovpnOldPort.getCall {
+				env.EXPECT().Get("PORT", gomock.Any()).
+					Return(testCase.ovpnOldPort.getValue, testCase.ovpnOldPort.getErr)
+			}
+			if testCase.ovpnOldPort.portCall {
+				env.EXPECT().Port("PORT").
+					Return(testCase.ovpnOldPort.portValue, testCase.ovpnOldPort.portErr)
+			}
+			if testCase.wgPort.getCall {
+				env.EXPECT().Get("WIREGUARD_ENDPOINT_PORT", gomock.Any()).
+					Return(testCase.wgPort.getValue, testCase.wgPort.getErr)
+			}
+			if testCase.wgPort.portCall {
+				env.EXPECT().Port("WIREGUARD_ENDPOINT_PORT").
+					Return(testCase.wgPort.portValue, testCase.wgPort.portErr)
+			}
+			if testCase.wgOldPort.getCall {
+				env.EXPECT().Get("WIREGUARD_PORT", gomock.Any()).
+					Return(testCase.wgOldPort.getValue, testCase.wgOldPort.getErr)
+			}
+			if testCase.wgOldPort.portCall {
+				env.EXPECT().Port("WIREGUARD_PORT").
+					Return(testCase.wgOldPort.portValue, testCase.wgOldPort.portErr)
+			}
+
+			r := reader{
+				servers: allServers,
+				env:     env,
+			}
+
+			var settings Provider
+			err := settings.readIvpn(r)
+
+			if testCase.err != nil {
+				require.Error(t, err)
+				assert.Equal(t, testCase.err.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+			}
+
+			assert.Equal(t, testCase.settings, settings)
+		})
+	}
+}

internal/configuration/keys.go

@@ -0,0 +1,29 @@
+package configuration
+
+import (
+	"errors"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/openvpn/parse"
+)
+
+var (
+	errClientCert = errors.New("cannot read client certificate")
+	errClientKey  = errors.New("cannot read client key")
+)
+
+func readClientKey(r reader) (clientKey string, err error) {
+	b, err := r.getFromFileOrSecretFile("OPENVPN_CLIENTKEY", constants.ClientKey)
+	if err != nil {
+		return "", err
+	}
+	return parse.ExtractPrivateKey(b)
+}
+
+func readClientCertificate(r reader) (clientCertificate string, err error) {
+	b, err := r.getFromFileOrSecretFile("OPENVPN_CLIENTCRT", constants.ClientCertificate)
+	if err != nil {
+		return "", err
+	}
+	return parse.ExtractCert(b)
+}

internal/configuration/lines.go

@@ -0,0 +1,22 @@
+package configuration
+
+import (
+	"net"
+	"strconv"
+)
+
+func uint16sToStrings(uint16s []uint16) (strings []string) {
+	strings = make([]string, len(uint16s))
+	for i := range uint16s {
+		strings[i] = strconv.Itoa(int(uint16s[i]))
+	}
+	return strings
+}
+
+func ipNetsToStrings(ipNets []net.IPNet) (strings []string) {
+	strings = make([]string, len(ipNets))
+	for i := range ipNets {
+		strings[i] = ipNets[i].String()
+	}
+	return strings
+}

internal/configuration/log.go

@@ -0,0 +1,30 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/golibs/logging"
+	"github.com/qdm12/golibs/params"
+)
+
+type Log struct {
+	Level logging.Level `json:"level"`
+}
+
+func (settings *Log) lines() (lines []string) {
+	lines = append(lines, lastIndent+"Log:")
+
+	lines = append(lines, indent+lastIndent+"Level: "+settings.Level.String())
+
+	return lines
+}
+
+func (settings *Log) read(env params.Interface) (err error) {
+	defaultLevel := logging.LevelInfo.String()
+	settings.Level, err = env.LogLevel("LOG_LEVEL", params.Default(defaultLevel))
+	if err != nil {
+		return fmt.Errorf("environment variable LOG_LEVEL: %w", err)
+	}
+
+	return nil
+}

internal/configuration/mullvad.go

@@ -0,0 +1,77 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+func (settings *Provider) readMullvad(r reader) (err error) {
+	settings.Name = constants.Mullvad
+	servers := r.servers.GetMullvad()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.MullvadCountryChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.MullvadCityChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.MullvadHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	settings.ServerSelection.ISPs, err = r.env.CSVInside("ISP", constants.MullvadISPChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable ISP: %w", err)
+	}
+
+	settings.ServerSelection.Owned, err = r.env.YesNo("OWNED", params.Default("no"))
+	if err != nil {
+		return fmt.Errorf("environment variable OWNED: %w", err)
+	}
+
+	err = settings.ServerSelection.OpenVPN.readMullvad(r)
+	if err != nil {
+		return err
+	}
+
+	return settings.ServerSelection.Wireguard.readMullvad(r.env)
+}
+
+func (settings *OpenVPNSelection) readMullvad(r reader) (err error) {
+	settings.TCP, err = readOpenVPNProtocol(r)
+	if err != nil {
+		return err
+	}
+
+	settings.CustomPort, err = readOpenVPNCustomPort(r, openvpnPortValidation{
+		tcp:        settings.TCP,
+		allowedTCP: []uint16{80, 443, 1401},
+		allowedUDP: []uint16{53, 1194, 1195, 1196, 1197, 1300, 1301, 1302, 1303, 1400},
+	})
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (settings *WireguardSelection) readMullvad(env params.Interface) (err error) {
+	settings.EndpointPort, err = readWireguardCustomPort(env, nil)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/configuration/nordvpn.go

@@ -0,0 +1,58 @@
+package configuration
+
+import (
+	"fmt"
+	"strconv"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+func (settings *Provider) readNordvpn(r reader) (err error) {
+	settings.Name = constants.Nordvpn
+	servers := r.servers.GetNordvpn()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.NordvpnRegionChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.NordvpnHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	settings.ServerSelection.Numbers, err = readNordVPNServerNumbers(r.env)
+	if err != nil {
+		return err
+	}
+
+	return settings.ServerSelection.OpenVPN.readProtocolOnly(r)
+}
+
+func readNordVPNServerNumbers(env params.Interface) (numbers []uint16, err error) {
+	const possiblePortsCount = 65537
+	possibilities := make([]string, possiblePortsCount)
+	for i := range possibilities {
+		possibilities[i] = fmt.Sprintf("%d", i)
+	}
+	possibilities[65536] = ""
+	values, err := env.CSVInside("SERVER_NUMBER", possibilities)
+	if err != nil {
+		return nil, err
+	}
+	numbers = make([]uint16, len(values))
+	for i := range values {
+		n, err := strconv.Atoi(values[i])
+		if err != nil {
+			return nil, err
+		}
+		numbers[i] = uint16(n)
+	}
+	return numbers, nil
+}

internal/configuration/openvpn.go

@@ -0,0 +1,207 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+	"regexp"
+	"strconv"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+// OpenVPN contains settings to configure the OpenVPN client.
+type OpenVPN struct {
+	User      string   `json:"user"`
+	Password  string   `json:"password"`
+	Verbosity int      `json:"verbosity"`
+	Flags     []string `json:"flags"`
+	MSSFix    uint16   `json:"mssfix"`
+	Root      bool     `json:"run_as_root"`
+	Cipher    string   `json:"cipher"`
+	Auth      string   `json:"auth"`
+	ConfFile  string   `json:"conf_file"`
+	Version   string   `json:"version"`
+	ClientCrt string   `json:"-"`                 // Cyberghost
+	ClientKey string   `json:"-"`                 // Cyberghost, VPNUnlimited
+	EncPreset string   `json:"encryption_preset"` // PIA
+	IPv6      bool     `json:"ipv6"`              // Mullvad
+	ProcUser  string   `json:"procuser"`          // Process username
+	Interface string   `json:"interface"`
+}
+
+func (settings *OpenVPN) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *OpenVPN) lines() (lines []string) {
+	lines = append(lines, lastIndent+"OpenVPN:")
+
+	lines = append(lines, indent+lastIndent+"Version: "+settings.Version)
+
+	lines = append(lines, indent+lastIndent+"Verbosity level: "+strconv.Itoa(settings.Verbosity))
+
+	lines = append(lines, indent+lastIndent+"Network interface: "+settings.Interface)
+
+	if len(settings.Flags) > 0 {
+		lines = append(lines, indent+lastIndent+"Flags: "+strings.Join(settings.Flags, " "))
+	}
+
+	if settings.Root {
+		lines = append(lines, indent+lastIndent+"Run as root: enabled")
+	}
+
+	if len(settings.Cipher) > 0 {
+		lines = append(lines, indent+lastIndent+"Custom cipher: "+settings.Cipher)
+	}
+	if len(settings.Auth) > 0 {
+		lines = append(lines, indent+lastIndent+"Custom auth algorithm: "+settings.Auth)
+	}
+
+	if settings.ConfFile != "" {
+		lines = append(lines, indent+lastIndent+"Configuration file: "+settings.ConfFile)
+	}
+
+	if settings.ClientKey != "" {
+		lines = append(lines, indent+lastIndent+"Client key is set")
+	}
+
+	if settings.ClientCrt != "" {
+		lines = append(lines, indent+lastIndent+"Client certificate is set")
+	}
+
+	if settings.IPv6 {
+		lines = append(lines, indent+lastIndent+"IPv6: enabled")
+	}
+
+	if settings.EncPreset != "" { // PIA only
+		lines = append(lines, indent+lastIndent+"Encryption preset: "+settings.EncPreset)
+	}
+
+	return lines
+}
+
+func (settings *OpenVPN) read(r reader, serviceProvider string) (err error) {
+	credentialsRequired := false
+	switch serviceProvider {
+	case constants.Custom:
+	case constants.VPNUnlimited:
+	default:
+		credentialsRequired = true
+	}
+
+	settings.User, err = r.getFromEnvOrSecretFile("OPENVPN_USER", credentialsRequired, []string{"USER"})
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_USER: %w", err)
+	}
+	// Remove spaces in user ID to simplify user's life, thanks @JeordyR
+	settings.User = strings.ReplaceAll(settings.User, " ", "")
+
+	if serviceProvider == constants.Mullvad {
+		settings.Password = "m"
+	} else {
+		settings.Password, err = r.getFromEnvOrSecretFile("OPENVPN_PASSWORD", credentialsRequired, []string{"PASSWORD"})
+		if err != nil {
+			return err
+		}
+	}
+
+	settings.Version, err = r.env.Inside("OPENVPN_VERSION",
+		[]string{constants.Openvpn24, constants.Openvpn25}, params.Default(constants.Openvpn25))
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_VERSION: %w", err)
+	}
+
+	settings.Verbosity, err = r.env.IntRange("OPENVPN_VERBOSITY", 0, 6, params.Default("1")) //nolint:gomnd
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_VERBOSITY: %w", err)
+	}
+
+	settings.Flags = []string{}
+	flagsStr, err := r.env.Get("OPENVPN_FLAGS")
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_FLAGS: %w", err)
+	}
+	if flagsStr != "" {
+		settings.Flags = strings.Fields(flagsStr)
+	}
+
+	settings.Root, err = r.env.YesNo("OPENVPN_ROOT", params.Default("yes"))
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_ROOT: %w", err)
+	}
+
+	settings.Cipher, err = r.env.Get("OPENVPN_CIPHER")
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_CIPHER: %w", err)
+	}
+
+	settings.Auth, err = r.env.Get("OPENVPN_AUTH")
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_AUTH: %w", err)
+	}
+
+	const maxMSSFix = 10000
+	mssFix, err := r.env.IntRange("OPENVPN_MSSFIX", 0, maxMSSFix, params.Default("0"))
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_MSSFIX: %w", err)
+	}
+	settings.MSSFix = uint16(mssFix)
+
+	settings.IPv6, err = r.env.OnOff("OPENVPN_IPV6", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable OPENVPN_IPV6: %w", err)
+	}
+
+	settings.Interface, err = readInterface(r.env)
+	if err != nil {
+		return err
+	}
+
+	switch serviceProvider {
+	case constants.Custom:
+		err = settings.readCustom(r) // read OPENVPN_CUSTOM_CONFIG
+	case constants.Cyberghost:
+		err = settings.readCyberghost(r)
+	case constants.PrivateInternetAccess:
+		settings.EncPreset, err = getPIAEncryptionPreset(r)
+	case constants.VPNUnlimited:
+		err = settings.readVPNUnlimited(r)
+	case constants.Wevpn:
+		err = settings.readWevpn(r)
+	}
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func readOpenVPNProtocol(r reader) (tcp bool, err error) {
+	protocol, err := r.env.Inside("OPENVPN_PROTOCOL", []string{constants.TCP, constants.UDP},
+		params.Default(constants.UDP), params.RetroKeys([]string{"PROTOCOL"}, r.onRetroActive))
+	if err != nil {
+		return false, fmt.Errorf("environment variable OPENVPN_PROTOCOL: %w", err)
+	}
+	return protocol == constants.TCP, nil
+}
+
+const openvpnIntfRegexString = `^.*[0-9]$`
+
+var openvpnIntfRegexp = regexp.MustCompile(openvpnIntfRegexString)
+var errInterfaceNameNotValid = errors.New("interface name is not valid")
+
+func readInterface(env params.Interface) (intf string, err error) {
+	intf, err = env.Get("OPENVPN_INTERFACE", params.Default("tun0"))
+	if err != nil {
+		return "", fmt.Errorf("environment variable OPENVPN_INTERFACE: %w", err)
+	}
+
+	if !openvpnIntfRegexp.MatchString(intf) {
+		return "", fmt.Errorf("%w: does not match regex %s: %s",
+			errInterfaceNameNotValid, openvpnIntfRegexString, intf)
+	}
+
+	return intf, nil
+}

internal/configuration/openvpn_test.go

@@ -0,0 +1,39 @@
+package configuration
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_OpenVPN_JSON(t *testing.T) {
+	t.Parallel()
+	in := OpenVPN{
+		Root:  true,
+		Flags: []string{},
+	}
+	data, err := json.MarshalIndent(in, "", "  ")
+	require.NoError(t, err)
+	assert.Equal(t, `{
+  "user": "",
+  "password": "",
+  "verbosity": 0,
+  "flags": [],
+  "mssfix": 0,
+  "run_as_root": true,
+  "cipher": "",
+  "auth": "",
+  "conf_file": "",
+  "version": "",
+  "encryption_preset": "",
+  "ipv6": false,
+  "procuser": "",
+  "interface": ""
+}`, string(data))
+	var out OpenVPN
+	err = json.Unmarshal(data, &out)
+	require.NoError(t, err)
+	assert.Equal(t, in, out)
+}

internal/configuration/privado.go

@@ -0,0 +1,39 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) readPrivado(r reader) (err error) {
+	settings.Name = constants.Privado
+	servers := r.servers.GetPrivado()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.PrivadoCountryChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.PrivadoRegionChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.PrivadoCityChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.PrivadoHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return nil
+}

internal/configuration/privateinternetaccess.go

@@ -0,0 +1,75 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+func (settings *Provider) readPrivateInternetAccess(r reader) (err error) {
+	settings.Name = constants.PrivateInternetAccess
+	servers := r.servers.GetPia()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.PIAGeoChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.PIAHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	settings.ServerSelection.Names, err = r.env.CSVInside("SERVER_NAME", constants.PIANameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_NAME: %w", err)
+	}
+
+	settings.PortForwarding.Enabled, err = r.env.OnOff("PORT_FORWARDING", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable PORT_FORWARDING: %w", err)
+	}
+
+	if settings.PortForwarding.Enabled {
+		settings.PortForwarding.Filepath, err = r.env.Path("PORT_FORWARDING_STATUS_FILE",
+			params.Default("/tmp/gluetun/forwarded_port"), params.CaseSensitiveValue())
+		if err != nil {
+			return fmt.Errorf("environment variable PORT_FORWARDING_STATUS_FILE: %w", err)
+		}
+	}
+
+	return settings.ServerSelection.OpenVPN.readPrivateInternetAccess(r)
+}
+
+func (settings *OpenVPNSelection) readPrivateInternetAccess(r reader) (err error) {
+	settings.EncPreset, err = getPIAEncryptionPreset(r)
+	if err != nil {
+		return err
+	}
+
+	settings.CustomPort, err = readOpenVPNCustomPort(r, openvpnPortValidation{allAllowed: true})
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func getPIAEncryptionPreset(r reader) (encryptionPreset string, err error) {
+	encryptionPreset, err = r.env.Inside("PIA_ENCRYPTION",
+		[]string{constants.PIAEncryptionPresetNone, constants.PIAEncryptionPresetNormal, constants.PIAEncryptionPresetStrong},
+		params.RetroKeys([]string{"ENCRYPTION"}, r.onRetroActive),
+		params.Default(constants.PIAEncryptionPresetStrong),
+	)
+	if err != nil {
+		return "", fmt.Errorf("environment variable PIA_ENCRYPTION: %w", err)
+	}
+
+	return encryptionPreset, nil
+}

internal/configuration/privatevpn.go

@@ -0,0 +1,35 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) readPrivatevpn(r reader) (err error) {
+	settings.Name = constants.Privatevpn
+	servers := r.servers.GetPrivatevpn()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.PrivatevpnCountryChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.PrivatevpnCityChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME",
+		constants.PrivatevpnHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return settings.ServerSelection.OpenVPN.readProtocolAndPort(r)
+}

internal/configuration/protonvpn.go

@@ -0,0 +1,51 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+func (settings *Provider) readProtonvpn(r reader) (err error) {
+	settings.Name = constants.Protonvpn
+	servers := r.servers.GetProtonvpn()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.ProtonvpnCountryChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.ProtonvpnRegionChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.ProtonvpnCityChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Names, err = r.env.CSVInside("SERVER_NAME", constants.ProtonvpnNameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_NAME: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME",
+		constants.ProtonvpnHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	settings.ServerSelection.FreeOnly, err = r.env.YesNo("FREE_ONLY", params.Default("no"))
+	if err != nil {
+		return fmt.Errorf("environment variable FREE_ONLY: %w", err)
+	}
+
+	return settings.ServerSelection.OpenVPN.readProtocolAndPort(r)
+}

internal/configuration/provider.go

@@ -0,0 +1,246 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+	"net"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params"
+)
+
+// Provider contains settings specific to a VPN provider.
+type Provider struct {
+	Name            string          `json:"name"`
+	ServerSelection ServerSelection `json:"server_selection"`
+	PortForwarding  PortForwarding  `json:"port_forwarding"`
+}
+
+func (settings *Provider) lines() (lines []string) {
+	if settings.Name == "" { // custom OpenVPN configuration
+		return nil
+	}
+
+	lines = append(lines, lastIndent+strings.Title(settings.Name)+" settings:")
+
+	for _, line := range settings.ServerSelection.toLines() {
+		lines = append(lines, indent+line)
+	}
+
+	if settings.PortForwarding.Enabled { // PIA
+		lines = append(lines, indent+lastIndent+"Port forwarding:")
+		for _, line := range settings.PortForwarding.lines() {
+			lines = append(lines, indent+indent+line)
+		}
+	}
+
+	return lines
+}
+
+var (
+	ErrInvalidVPNProvider = errors.New("invalid VPN provider")
+)
+
+func (settings *Provider) read(r reader, vpnType string) error {
+	err := settings.readVPNServiceProvider(r, vpnType)
+	if err != nil {
+		return err
+	}
+
+	switch settings.Name {
+	case constants.Custom:
+		err = settings.readCustom(r, vpnType)
+	case constants.Cyberghost:
+		err = settings.readCyberghost(r)
+	case constants.Expressvpn:
+		err = settings.readExpressvpn(r)
+	case constants.Fastestvpn:
+		err = settings.readFastestvpn(r)
+	case constants.HideMyAss:
+		err = settings.readHideMyAss(r)
+	case constants.Ipvanish:
+		err = settings.readIpvanish(r)
+	case constants.Ivpn:
+		err = settings.readIvpn(r)
+	case constants.Mullvad:
+		err = settings.readMullvad(r)
+	case constants.Nordvpn:
+		err = settings.readNordvpn(r)
+	case constants.Privado:
+		err = settings.readPrivado(r)
+	case constants.PrivateInternetAccess:
+		err = settings.readPrivateInternetAccess(r)
+	case constants.Privatevpn:
+		err = settings.readPrivatevpn(r)
+	case constants.Protonvpn:
+		err = settings.readProtonvpn(r)
+	case constants.Purevpn:
+		err = settings.readPurevpn(r)
+	case constants.Surfshark:
+		err = settings.readSurfshark(r)
+	case constants.Torguard:
+		err = settings.readTorguard(r)
+	case constants.VPNUnlimited:
+		err = settings.readVPNUnlimited(r)
+	case constants.Vyprvpn:
+		err = settings.readVyprvpn(r)
+	case constants.Wevpn:
+		err = settings.readWevpn(r)
+	case constants.Windscribe:
+		err = settings.readWindscribe(r)
+	default:
+		return fmt.Errorf("%w: %s", ErrInvalidVPNProvider, settings.Name)
+	}
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.VPN = vpnType
+	return nil
+}
+
+func (settings *Provider) readVPNServiceProvider(r reader, vpnType string) (err error) {
+	var allowedVPNServiceProviders []string
+	switch vpnType {
+	case constants.OpenVPN:
+		allowedVPNServiceProviders = []string{
+			constants.Custom,
+			"cyberghost", constants.Expressvpn, "fastestvpn", "hidemyass", "ipvanish",
+			"ivpn", "mullvad", "nordvpn",
+			"privado", "pia", "private internet access", "privatevpn", "protonvpn",
+			"purevpn", "surfshark", "torguard", constants.VPNUnlimited, "vyprvpn",
+			constants.Wevpn, "windscribe"}
+	case constants.Wireguard:
+		allowedVPNServiceProviders = []string{
+			constants.Custom, constants.Ivpn,
+			constants.Mullvad, constants.Windscribe,
+		}
+	}
+
+	vpnsp, err := r.env.Inside("VPNSP", allowedVPNServiceProviders,
+		params.Default("private internet access"))
+	if err != nil {
+		return fmt.Errorf("environment variable VPNSP: %w", err)
+	}
+	if vpnsp == "pia" { // retro compatibility
+		vpnsp = "private internet access"
+	}
+
+	if settings.isOpenVPNCustomConfig(r.env) { // retro compatibility
+		vpnsp = constants.Custom
+	}
+
+	settings.Name = vpnsp
+
+	return nil
+}
+
+func commaJoin(slice []string) string {
+	return strings.Join(slice, ", ")
+}
+
+func protoToString(tcp bool) string {
+	if tcp {
+		return constants.TCP
+	}
+	return constants.UDP
+}
+
+func readTargetIP(env params.Interface) (targetIP net.IP, err error) {
+	targetIP, err = readIP(env, "OPENVPN_TARGET_IP")
+	if err != nil {
+		return nil, fmt.Errorf("environment variable OPENVPN_TARGET_IP: %w", err)
+	}
+	return targetIP, nil
+}
+
+type openvpnPortValidation struct {
+	allAllowed bool
+	tcp        bool
+	allowedTCP []uint16
+	allowedUDP []uint16
+}
+
+func readOpenVPNCustomPort(r reader, validation openvpnPortValidation) (
+	port uint16, err error) {
+	port, err = readPortOrZero(r.env, "OPENVPN_PORT")
+	if err != nil {
+		return 0, fmt.Errorf("environment variable OPENVPN_PORT: %w", err)
+	} else if port == 0 {
+		// Try using old variable name
+		port, err = readPortOrZero(r.env, "PORT")
+		if err != nil {
+			r.onRetroActive("PORT", "OPENVPN_PORT")
+			return 0, fmt.Errorf("environment variable PORT: %w", err)
+		}
+	}
+
+	if port == 0 || validation.allAllowed {
+		return port, nil
+	}
+
+	if validation.tcp {
+		for _, allowedPort := range validation.allowedTCP {
+			if port == allowedPort {
+				return port, nil
+			}
+		}
+		return 0, fmt.Errorf(
+			"environment variable PORT: %w: port %d for TCP protocol, can only be one of %s",
+			ErrInvalidPort, port, portsToString(validation.allowedTCP))
+	}
+	for _, allowedPort := range validation.allowedUDP {
+		if port == allowedPort {
+			return port, nil
+		}
+	}
+	return 0, fmt.Errorf(
+		"environment variable PORT: %w: port %d for UDP protocol, can only be one of %s",
+		ErrInvalidPort, port, portsToString(validation.allowedUDP))
+}
+
+// note: set allowed to an empty slice to allow all valid ports
+func readWireguardCustomPort(env params.Interface, allowed []uint16) (port uint16, err error) {
+	port, err = readPortOrZero(env, "WIREGUARD_ENDPOINT_PORT")
+	if err != nil {
+		return 0, fmt.Errorf("environment variable WIREGUARD_ENDPOINT_PORT: %w", err)
+	} else if port == 0 {
+		port, _ = readPortOrZero(env, "WIREGUARD_PORT")
+		if err == nil {
+			return port, nil // 0 or WIREGUARD_PORT value
+		}
+		return 0, nil // default 0
+	}
+
+	if len(allowed) == 0 {
+		return port, nil
+	}
+
+	for i := range allowed {
+		if allowed[i] == port {
+			return port, nil
+		}
+	}
+
+	return 0, fmt.Errorf(
+		"environment variable WIREGUARD_PORT: %w: port %d, can only be one of %s",
+		ErrInvalidPort, port, portsToString(allowed))
+}
+
+func portsToString(ports []uint16) string {
+	slice := make([]string, len(ports))
+	for i := range ports {
+		slice[i] = fmt.Sprint(ports[i])
+	}
+	return strings.Join(slice, ", ")
+}
+
+// isOpenVPNCustomConfig is for retro compatibility to set VPNSP=custom
+// if OPENVPN_CUSTOM_CONFIG is set.
+func (settings Provider) isOpenVPNCustomConfig(env params.Interface) (ok bool) {
+	s, _ := env.Get("VPN_TYPE")
+	isOpenVPN := s == constants.OpenVPN
+	s, _ = env.Get("OPENVPN_CUSTOM_CONFIG")
+	return isOpenVPN && s != ""
+}

internal/configuration/provider_test.go

@@ -0,0 +1,447 @@
+package configuration
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/golibs/params/mock_params"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+var errDummy = errors.New("dummy")
+
+func Test_Provider_lines(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		settings Provider
+		lines    []string
+	}{
+		"cyberghost": {
+			settings: Provider{
+				Name: constants.Cyberghost,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Countries: []string{"a", "El country"},
+				},
+			},
+			lines: []string{
+				"|--Cyberghost settings:",
+				"   |--Countries: a, El country",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"expressvpn": {
+			settings: Provider{
+				Name: constants.Expressvpn,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Hostnames: []string{"a", "b"},
+					Countries: []string{"c", "d"},
+					Cities:    []string{"e", "f"},
+				},
+			},
+			lines: []string{
+				"|--Expressvpn settings:",
+				"   |--Countries: c, d",
+				"   |--Cities: e, f",
+				"   |--Hostnames: a, b",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"fastestvpn": {
+			settings: Provider{
+				Name: constants.Fastestvpn,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Hostnames: []string{"a", "b"},
+					Countries: []string{"c", "d"},
+				},
+			},
+			lines: []string{
+				"|--Fastestvpn settings:",
+				"   |--Countries: c, d",
+				"   |--Hostnames: a, b",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"hidemyass": {
+			settings: Provider{
+				Name: constants.HideMyAss,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Countries: []string{"a", "b"},
+					Cities:    []string{"c", "d"},
+					Hostnames: []string{"e", "f"},
+				},
+			},
+			lines: []string{
+				"|--Hidemyass settings:",
+				"   |--Countries: a, b",
+				"   |--Cities: c, d",
+				"   |--Hostnames: e, f",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"ipvanish": {
+			settings: Provider{
+				Name: constants.Ipvanish,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Countries: []string{"a", "b"},
+					Cities:    []string{"c", "d"},
+					Hostnames: []string{"e", "f"},
+				},
+			},
+			lines: []string{
+				"|--Ipvanish settings:",
+				"   |--Countries: a, b",
+				"   |--Cities: c, d",
+				"   |--Hostnames: e, f",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"ivpn": {
+			settings: Provider{
+				Name: constants.Ivpn,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Countries: []string{"a", "b"},
+					Cities:    []string{"c", "d"},
+					Hostnames: []string{"e", "f"},
+				},
+			},
+			lines: []string{
+				"|--Ivpn settings:",
+				"   |--Countries: a, b",
+				"   |--Cities: c, d",
+				"   |--Hostnames: e, f",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"mullvad": {
+			settings: Provider{
+				Name: constants.Mullvad,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Countries: []string{"a", "b"},
+					Cities:    []string{"c", "d"},
+					ISPs:      []string{"e", "f"},
+					OpenVPN: OpenVPNSelection{
+						CustomPort: 1,
+					},
+				},
+			},
+			lines: []string{
+				"|--Mullvad settings:",
+				"   |--Countries: a, b",
+				"   |--Cities: c, d",
+				"   |--ISPs: e, f",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+				"      |--Custom port: 1",
+			},
+		},
+		"nordvpn": {
+			settings: Provider{
+				Name: constants.Nordvpn,
+				ServerSelection: ServerSelection{
+					VPN:     constants.OpenVPN,
+					Regions: []string{"a", "b"},
+					Numbers: []uint16{1, 2},
+				},
+			},
+			lines: []string{
+				"|--Nordvpn settings:",
+				"   |--Regions: a, b",
+				"   |--Numbers: 1, 2",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"privado": {
+			settings: Provider{
+				Name: constants.Privado,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Hostnames: []string{"a", "b"},
+				},
+			},
+			lines: []string{
+				"|--Privado settings:",
+				"   |--Hostnames: a, b",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"privatevpn": {
+			settings: Provider{
+				Name: constants.Privatevpn,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Hostnames: []string{"a", "b"},
+					Countries: []string{"c", "d"},
+					Cities:    []string{"e", "f"},
+				},
+			},
+			lines: []string{
+				"|--Privatevpn settings:",
+				"   |--Countries: c, d",
+				"   |--Cities: e, f",
+				"   |--Hostnames: a, b",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"protonvpn": {
+			settings: Provider{
+				Name: constants.Protonvpn,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Countries: []string{"a", "b"},
+					Regions:   []string{"c", "d"},
+					Cities:    []string{"e", "f"},
+					Names:     []string{"g", "h"},
+					Hostnames: []string{"i", "j"},
+				},
+			},
+			lines: []string{
+				"|--Protonvpn settings:",
+				"   |--Countries: a, b",
+				"   |--Regions: c, d",
+				"   |--Cities: e, f",
+				"   |--Hostnames: i, j",
+				"   |--Names: g, h",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"private internet access": {
+			settings: Provider{
+				Name: constants.PrivateInternetAccess,
+				ServerSelection: ServerSelection{
+					VPN:     constants.OpenVPN,
+					Regions: []string{"a", "b"},
+					OpenVPN: OpenVPNSelection{
+						CustomPort: 1,
+					},
+				},
+				PortForwarding: PortForwarding{
+					Enabled:  true,
+					Filepath: string("/here"),
+				},
+			},
+			lines: []string{
+				"|--Private Internet Access settings:",
+				"   |--Regions: a, b",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+				"      |--Custom port: 1",
+				"   |--Port forwarding:",
+				"      |--File path: /here",
+			},
+		},
+		"purevpn": {
+			settings: Provider{
+				Name: constants.Purevpn,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Regions:   []string{"a", "b"},
+					Countries: []string{"c", "d"},
+					Cities:    []string{"e", "f"},
+				},
+			},
+			lines: []string{
+				"|--Purevpn settings:",
+				"   |--Countries: c, d",
+				"   |--Regions: a, b",
+				"   |--Cities: e, f",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"surfshark": {
+			settings: Provider{
+				Name: constants.Surfshark,
+				ServerSelection: ServerSelection{
+					VPN:     constants.OpenVPN,
+					Regions: []string{"a", "b"},
+				},
+			},
+			lines: []string{
+				"|--Surfshark settings:",
+				"   |--Regions: a, b",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"torguard": {
+			settings: Provider{
+				Name: constants.Torguard,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Countries: []string{"a", "b"},
+					Cities:    []string{"c", "d"},
+					Hostnames: []string{"e"},
+				},
+			},
+			lines: []string{
+				"|--Torguard settings:",
+				"   |--Countries: a, b",
+				"   |--Cities: c, d",
+				"   |--Hostnames: e",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		constants.VPNUnlimited: {
+			settings: Provider{
+				Name: constants.VPNUnlimited,
+				ServerSelection: ServerSelection{
+					VPN:        constants.OpenVPN,
+					Countries:  []string{"a", "b"},
+					Cities:     []string{"c", "d"},
+					Hostnames:  []string{"e", "f"},
+					FreeOnly:   true,
+					StreamOnly: true,
+				},
+			},
+			lines: []string{
+				"|--Vpn Unlimited settings:",
+				"   |--Countries: a, b",
+				"   |--Cities: c, d",
+				"   |--Free servers only",
+				"   |--Stream servers only",
+				"   |--Hostnames: e, f",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"vyprvpn": {
+			settings: Provider{
+				Name: constants.Vyprvpn,
+				ServerSelection: ServerSelection{
+					VPN:     constants.OpenVPN,
+					Regions: []string{"a", "b"},
+				},
+			},
+			lines: []string{
+				"|--Vyprvpn settings:",
+				"   |--Regions: a, b",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+			},
+		},
+		"wevpn": {
+			settings: Provider{
+				Name: constants.Wevpn,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Cities:    []string{"a", "b"},
+					Hostnames: []string{"c", "d"},
+					OpenVPN: OpenVPNSelection{
+						CustomPort: 1,
+					},
+				},
+			},
+			lines: []string{
+				"|--Wevpn settings:",
+				"   |--Cities: a, b",
+				"   |--Hostnames: c, d",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+				"      |--Custom port: 1",
+			},
+		},
+		"windscribe": {
+			settings: Provider{
+				Name: constants.Windscribe,
+				ServerSelection: ServerSelection{
+					VPN:       constants.OpenVPN,
+					Regions:   []string{"a", "b"},
+					Cities:    []string{"c", "d"},
+					Hostnames: []string{"e", "f"},
+					OpenVPN: OpenVPNSelection{
+						CustomPort: 1,
+					},
+				},
+			},
+			lines: []string{
+				"|--Windscribe settings:",
+				"   |--Regions: a, b",
+				"   |--Cities: c, d",
+				"   |--Hostnames: e, f",
+				"   |--OpenVPN selection:",
+				"      |--Protocol: udp",
+				"      |--Custom port: 1",
+			},
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			lines := testCase.settings.lines()
+
+			assert.Equal(t, testCase.lines, lines)
+		})
+	}
+}
+
+func Test_readProtocol(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		mockStr string
+		mockErr error
+		tcp     bool
+		err     error
+	}{
+		"error": {
+			mockErr: errDummy,
+			err:     errors.New("environment variable OPENVPN_PROTOCOL: dummy"),
+		},
+		"success": {
+			mockStr: "tcp",
+			tcp:     true,
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			ctrl := gomock.NewController(t)
+
+			env := mock_params.NewMockInterface(ctrl)
+			env.EXPECT().
+				Inside("OPENVPN_PROTOCOL", []string{"tcp", "udp"}, gomock.Any(), gomock.Any()).
+				Return(testCase.mockStr, testCase.mockErr)
+			reader := reader{
+				env: env,
+			}
+
+			tcp, err := readOpenVPNProtocol(reader)
+
+			if testCase.err != nil {
+				require.Error(t, err)
+				assert.Equal(t, testCase.err.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+			}
+
+			assert.Equal(t, testCase.tcp, tcp)
+		})
+	}
+}

internal/configuration/publicip.go

@@ -0,0 +1,47 @@
+package configuration
+
+import (
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/qdm12/golibs/params"
+)
+
+type PublicIP struct {
+	Period     time.Duration `json:"period"`
+	IPFilepath string        `json:"ip_filepath"`
+}
+
+func (settings *PublicIP) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *PublicIP) lines() (lines []string) {
+	if settings.Period == 0 {
+		lines = append(lines, lastIndent+"Public IP getter: disabled")
+		return lines
+	}
+
+	lines = append(lines, lastIndent+"Public IP getter:")
+	lines = append(lines, indent+lastIndent+"Fetch period: "+settings.Period.String())
+	lines = append(lines, indent+lastIndent+"IP file: "+settings.IPFilepath)
+
+	return lines
+}
+
+func (settings *PublicIP) read(r reader) (err error) {
+	settings.Period, err = r.env.Duration("PUBLICIP_PERIOD", params.Default("12h"))
+	if err != nil {
+		return fmt.Errorf("environment variable PUBLICIP_PERIOD: %w", err)
+	}
+
+	settings.IPFilepath, err = r.env.Path("PUBLICIP_FILE", params.CaseSensitiveValue(),
+		params.Default("/tmp/gluetun/ip"),
+		params.RetroKeys([]string{"IP_STATUS_FILE"}, r.onRetroActive))
+	if err != nil {
+		return fmt.Errorf("environment variable PUBLICIP_FILE (or IP_STATUS_FILE): %w", err)
+	}
+
+	return nil
+}

internal/configuration/purevpn.go

@@ -0,0 +1,39 @@
+package configuration
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+func (settings *Provider) readPurevpn(r reader) (err error) {
+	settings.Name = constants.Purevpn
+	servers := r.servers.GetPurevpn()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", constants.PurevpnRegionChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.PurevpnCountryChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.PurevpnCityChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME", constants.PurevpnHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	return settings.ServerSelection.OpenVPN.readProtocolOnly(r)
+}

internal/configuration/reader.go

@@ -0,0 +1,134 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+	"net"
+	"strconv"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/models"
+	ovpnextract "github.com/qdm12/gluetun/internal/openvpn/extract"
+	"github.com/qdm12/golibs/params"
+	"github.com/qdm12/golibs/verification"
+)
+
+//go:generate mockgen -destination=warner_mock_test.go -package configuration . Warner
+
+type reader struct {
+	servers models.AllServers
+	env     params.Interface
+	warner  Warner
+	regex   verification.Regex
+	ovpnExt ovpnextract.Interface
+}
+
+type Warner interface {
+	Warn(s string)
+}
+
+func newReader(env params.Interface,
+	servers models.AllServers, warner Warner) reader {
+	return reader{
+		servers: servers,
+		env:     env,
+		warner:  warner,
+		regex:   verification.NewRegex(),
+		ovpnExt: ovpnextract.New(),
+	}
+}
+
+func (r *reader) onRetroActive(oldKey, newKey string) {
+	r.warner.Warn(
+		"You are using the old environment variable " + oldKey +
+			", please consider changing it to " + newKey)
+}
+
+var (
+	ErrInvalidPort = errors.New("invalid port")
+)
+
+func readCSVPorts(env params.Interface, key string) (ports []uint16, err error) {
+	s, err := env.Get(key)
+	if err != nil {
+		return nil, err
+	} else if s == "" {
+		return nil, nil
+	}
+
+	portsStr := strings.Split(s, ",")
+	ports = make([]uint16, len(portsStr))
+	for i, portStr := range portsStr {
+		portInt, err := strconv.Atoi(portStr)
+		if err != nil {
+			return nil, fmt.Errorf("%w: %s: %s", ErrInvalidPort, portStr, err)
+		} else if portInt <= 0 || portInt > 65535 {
+			return nil, fmt.Errorf("%w: %d: must be between 1 and 65535", ErrInvalidPort, portInt)
+		}
+		ports[i] = uint16(portInt)
+	}
+
+	return ports, nil
+}
+
+var (
+	ErrInvalidIPNet = errors.New("invalid IP network")
+)
+
+func readCSVIPNets(env params.Interface, key string, options ...params.OptionSetter) (
+	ipNets []net.IPNet, err error) {
+	s, err := env.Get(key, options...)
+	if err != nil {
+		return nil, err
+	} else if s == "" {
+		return nil, nil
+	}
+
+	ipNetsStr := strings.Split(s, ",")
+	ipNets = make([]net.IPNet, len(ipNetsStr))
+	for i, ipNetStr := range ipNetsStr {
+		_, ipNet, err := net.ParseCIDR(ipNetStr)
+		if err != nil {
+			return nil, fmt.Errorf("%w: %s: %s",
+				ErrInvalidIPNet, ipNetStr, err)
+		} else if ipNet == nil {
+			return nil, fmt.Errorf("%w: %s: subnet is nil", ErrInvalidIPNet, ipNetStr)
+		}
+		ipNets[i] = *ipNet
+	}
+
+	return ipNets, nil
+}
+
+var (
+	ErrInvalidIP = errors.New("invalid IP address")
+)
+
+func readIP(env params.Interface, key string) (ip net.IP, err error) {
+	s, err := env.Get(key)
+	if s == "" {
+		return nil, nil
+	} else if err != nil {
+		return nil, err
+	}
+
+	ip = net.ParseIP(s)
+	if ip == nil {
+		return nil, fmt.Errorf("%w: %s", ErrInvalidIP, s)
+	}
+
+	return ip, nil
+}
+
+func readPortOrZero(env params.Interface, key string) (port uint16, err error) {
+	s, err := env.Get(key, params.Default("0"))
+	if err != nil {
+		return 0, err
+	}
+
+	if s == "0" {
+		return 0, nil
+	}
+
+	return env.Port(key)
+}

internal/configuration/secrets.go

@@ -0,0 +1,119 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+	"io"
+	"os"
+	"strings"
+
+	"github.com/qdm12/golibs/params"
+)
+
+var (
+	ErrGetSecretFilepath = errors.New("cannot get secret file path from env")
+	ErrReadSecretFile    = errors.New("cannot read secret file")
+	ErrSecretFileIsEmpty = errors.New("secret file is empty")
+	ErrReadNonSecretFile = errors.New("cannot read non secret file")
+	ErrFilesDoNotExist   = errors.New("files do not exist")
+)
+
+func cleanSuffix(value string) string {
+	value = strings.TrimSuffix(value, "\n")
+	value = strings.TrimSuffix(value, "\r")
+	return value
+}
+
+func (r *reader) getFromEnvOrSecretFile(envKey string, compulsory bool, retroKeys []string) (value string, err error) {
+	envOptions := []params.OptionSetter{
+		params.Compulsory(), // to fallback on file reading
+		params.CaseSensitiveValue(),
+		params.Unset(),
+		params.RetroKeys(retroKeys, r.onRetroActive),
+	}
+	value, envErr := r.env.Get(envKey, envOptions...)
+	if envErr == nil {
+		value = cleanSuffix(value)
+		return value, nil
+	}
+
+	secretFilepathEnvKey := envKey + "_SECRETFILE"
+	defaultSecretFile := "/run/secrets/" + strings.ToLower(envKey)
+	filepath, err := r.env.Get(secretFilepathEnvKey,
+		params.CaseSensitiveValue(),
+		params.Default(defaultSecretFile),
+	)
+	if err != nil {
+		return "", fmt.Errorf("%w: environment variable %s: %s",
+			ErrGetSecretFilepath, secretFilepathEnvKey, err)
+	}
+
+	file, fileErr := os.OpenFile(filepath, os.O_RDONLY, 0)
+	if os.IsNotExist(fileErr) {
+		if compulsory {
+			return "", fmt.Errorf("environment variable %s: %w", envKey, envErr)
+		}
+		return "", nil
+	} else if fileErr != nil {
+		return "", fmt.Errorf("%w: %s: %s", ErrReadSecretFile, filepath, fileErr)
+	}
+
+	b, err := io.ReadAll(file)
+	if err != nil {
+		return "", fmt.Errorf("%w: %s: %s", ErrReadSecretFile, filepath, err)
+	}
+
+	value = string(b)
+	value = cleanSuffix(value)
+	if compulsory && value == "" {
+		return "", fmt.Errorf("%s: %w", filepath, ErrSecretFileIsEmpty)
+	}
+
+	return value, nil
+}
+
+// Tries to read from the secret file then the non secret file.
+func (r *reader) getFromFileOrSecretFile(secretName, filepath string) (
+	b []byte, err error) {
+	defaultSecretFile := "/run/secrets/" + strings.ToLower(secretName)
+	key := strings.ToUpper(secretName) + "_SECRETFILE"
+	secretFilepath, err := r.env.Get(key,
+		params.CaseSensitiveValue(),
+		params.Default(defaultSecretFile),
+	)
+	if err != nil {
+		return b, fmt.Errorf("environment variable %s: %w: %s", key, ErrGetSecretFilepath, err)
+	}
+
+	b, err = readFromFile(secretFilepath)
+	if err != nil && !os.IsNotExist(err) {
+		return b, fmt.Errorf("%w: %s", ErrReadSecretFile, err)
+	} else if err == nil {
+		return b, nil
+	}
+
+	// Secret file does not exist, try the non secret file
+	b, err = readFromFile(filepath)
+	if err != nil && !os.IsNotExist(err) {
+		return nil, fmt.Errorf("%w: %s", ErrReadSecretFile, err)
+	} else if err == nil {
+		return b, nil
+	}
+	return nil, fmt.Errorf("%w: %s and %s", ErrFilesDoNotExist, secretFilepath, filepath)
+}
+
+func readFromFile(filepath string) (b []byte, err error) {
+	file, err := os.Open(filepath)
+	if err != nil {
+		return nil, err
+	}
+	b, err = io.ReadAll(file)
+	if err != nil {
+		_ = file.Close()
+		return nil, err
+	}
+	if err := file.Close(); err != nil {
+		return nil, err
+	}
+	return b, nil
+}

internal/configuration/selection.go

@@ -0,0 +1,188 @@
+package configuration
+
+import (
+	"fmt"
+	"net"
+
+	"github.com/qdm12/gluetun/internal/constants"
+)
+
+type ServerSelection struct { //nolint:maligned
+	// Common
+	VPN      string `json:"vpn"` // note: this is required
+	TargetIP net.IP `json:"target_ip,omitempty"`
+	// TODO comments
+	// Cyberghost, PIA, Protonvpn, Surfshark, Windscribe, Vyprvpn, NordVPN
+	Regions []string `json:"regions"`
+
+	// Expressvpn, Fastestvpn, HideMyAss, IPVanish, IVPN, Mullvad, PrivateVPN, Protonvpn, PureVPN, VPNUnlimited
+	Countries []string `json:"countries"`
+	// Expressvpn, HideMyAss, IPVanish, IVPN, Mullvad, PrivateVPN, Protonvpn, PureVPN, VPNUnlimited, WeVPN, Windscribe
+	Cities []string `json:"cities"`
+	// Expressvpn, Fastestvpn, HideMyAss, IPVanish, IVPN, PrivateVPN, Windscribe, Privado, Protonvpn, VPNUnlimited, WeVPN
+	Hostnames []string `json:"hostnames"`
+	Names     []string `json:"names"` // Protonvpn
+
+	// Mullvad
+	ISPs  []string `json:"isps"`
+	Owned bool     `json:"owned"`
+
+	// NordVPN
+	Numbers []uint16 `json:"numbers"`
+
+	// ProtonVPN
+	FreeOnly bool `json:"free_only"`
+
+	// VPNUnlimited
+	StreamOnly bool `json:"stream_only"`
+
+	// Surfshark
+	MultiHopOnly bool `json:"multihop_only"`
+
+	OpenVPN   OpenVPNSelection   `json:"openvpn"`
+	Wireguard WireguardSelection `json:"wireguard"`
+}
+
+func (selection ServerSelection) toLines() (lines []string) {
+	if selection.TargetIP != nil {
+		lines = append(lines, lastIndent+"Target IP address: "+selection.TargetIP.String())
+	}
+
+	if len(selection.Countries) > 0 {
+		lines = append(lines, lastIndent+"Countries: "+commaJoin(selection.Countries))
+	}
+
+	if len(selection.Regions) > 0 {
+		lines = append(lines, lastIndent+"Regions: "+commaJoin(selection.Regions))
+	}
+
+	if len(selection.Cities) > 0 {
+		lines = append(lines, lastIndent+"Cities: "+commaJoin(selection.Cities))
+	}
+
+	if len(selection.ISPs) > 0 {
+		lines = append(lines, lastIndent+"ISPs: "+commaJoin(selection.ISPs))
+	}
+
+	if selection.FreeOnly {
+		lines = append(lines, lastIndent+"Free servers only")
+	}
+
+	if selection.StreamOnly {
+		lines = append(lines, lastIndent+"Stream servers only")
+	}
+
+	if len(selection.Hostnames) > 0 {
+		lines = append(lines, lastIndent+"Hostnames: "+commaJoin(selection.Hostnames))
+	}
+
+	if len(selection.Names) > 0 {
+		lines = append(lines, lastIndent+"Names: "+commaJoin(selection.Names))
+	}
+
+	if len(selection.Numbers) > 0 {
+		numbersString := make([]string, len(selection.Numbers))
+		for i, numberUint16 := range selection.Numbers {
+			numbersString[i] = fmt.Sprint(numberUint16)
+		}
+		lines = append(lines, lastIndent+"Numbers: "+commaJoin(numbersString))
+	}
+
+	if selection.VPN == constants.OpenVPN {
+		lines = append(lines, selection.OpenVPN.lines()...)
+	} else { // wireguard
+		lines = append(lines, selection.Wireguard.lines()...)
+	}
+
+	return lines
+}
+
+type OpenVPNSelection struct {
+	ConfFile   string `json:"conf_file"`         // Custom configuration file path
+	TCP        bool   `json:"tcp"`               // UDP if TCP is false
+	CustomPort uint16 `json:"custom_port"`       // HideMyAss, Mullvad, PIA, ProtonVPN, WeVPN, Windscribe
+	EncPreset  string `json:"encryption_preset"` // PIA - needed to get the port number
+}
+
+func (settings *OpenVPNSelection) lines() (lines []string) {
+	lines = append(lines, lastIndent+"OpenVPN selection:")
+
+	if settings.ConfFile != "" {
+		lines = append(lines, indent+lastIndent+"Custom configuration file: "+settings.ConfFile)
+	}
+
+	lines = append(lines, indent+lastIndent+"Protocol: "+protoToString(settings.TCP))
+
+	if settings.CustomPort != 0 {
+		lines = append(lines, indent+lastIndent+"Custom port: "+fmt.Sprint(settings.CustomPort))
+	}
+
+	if settings.EncPreset != "" {
+		lines = append(lines, indent+lastIndent+"PIA encryption preset: "+settings.EncPreset)
+	}
+
+	return lines
+}
+
+func (settings *OpenVPNSelection) readProtocolOnly(r reader) (err error) {
+	settings.TCP, err = readOpenVPNProtocol(r)
+	return err
+}
+
+func (settings *OpenVPNSelection) readProtocolAndPort(r reader) (err error) {
+	settings.TCP, err = readOpenVPNProtocol(r)
+	if err != nil {
+		return err
+	}
+
+	settings.CustomPort, err = readOpenVPNCustomPort(r, openvpnPortValidation{allAllowed: true})
+	if err != nil {
+		return fmt.Errorf("environment variable PORT: %w", err)
+	}
+
+	return nil
+}
+
+type WireguardSelection struct {
+	// EndpointPort is a the server port to use for the VPN server.
+	// It is optional for Wireguard VPN providers IVPN, Mullvad
+	// and Windscribe, and compulsory for the others
+	EndpointPort uint16 `json:"port,omitempty"`
+	// PublicKey is the server public key.
+	// It is only used with VPN providers generating Wireguard
+	// configurations specific to each server and user.
+	PublicKey string `json:"publickey,omitempty"`
+	// EndpointIP is the server endpoint IP address.
+	// It is only used with VPN providers generating Wireguard
+	// configurations specific to each server and user.
+	EndpointIP net.IP `json:"endpoint_ip,omitempty"`
+}
+
+func (settings *WireguardSelection) lines() (lines []string) {
+	lines = append(lines, lastIndent+"Wireguard selection:")
+
+	if settings.PublicKey != "" {
+		lines = append(lines, indent+lastIndent+"Public key: "+settings.PublicKey)
+	}
+
+	if settings.EndpointIP != nil {
+		endpoint := settings.EndpointIP.String() + ":" + fmt.Sprint(settings.EndpointPort)
+		lines = append(lines, indent+lastIndent+"Server endpoint: "+endpoint)
+	} else if settings.EndpointPort != 0 {
+		lines = append(lines, indent+lastIndent+"Custom port: "+fmt.Sprint(settings.EndpointPort))
+	}
+
+	return lines
+}
+
+// PortForwarding contains settings for port forwarding.
+type PortForwarding struct {
+	Enabled  bool   `json:"enabled"`
+	Filepath string `json:"filepath"`
+}
+
+func (p *PortForwarding) lines() (lines []string) {
+	return []string{
+		lastIndent + "File path: " + p.Filepath,
+	}
+}

internal/configuration/server.go

@@ -0,0 +1,50 @@
+package configuration
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/qdm12/golibs/params"
+)
+
+// ControlServer contains settings to customize the control server operation.
+type ControlServer struct {
+	Port uint16
+	Log  bool
+}
+
+func (settings *ControlServer) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *ControlServer) lines() (lines []string) {
+	lines = append(lines, lastIndent+"HTTP control server:")
+
+	lines = append(lines, indent+lastIndent+"Listening port: "+strconv.Itoa(int(settings.Port)))
+
+	if settings.Log {
+		lines = append(lines, indent+lastIndent+"Logging: enabled")
+	}
+
+	return lines
+}
+
+func (settings *ControlServer) read(r reader) (err error) {
+	settings.Log, err = r.env.OnOff("HTTP_CONTROL_SERVER_LOG", params.Default("on"))
+	if err != nil {
+		return fmt.Errorf("environment variable HTTP_CONTROL_SERVER_LOG: %w", err)
+	}
+
+	var warning string
+	settings.Port, warning, err = r.env.ListeningPort(
+		"HTTP_CONTROL_SERVER_PORT", params.Default("8000"))
+	if len(warning) > 0 {
+		r.warner.Warn(warning)
+	}
+	if err != nil {
+		return fmt.Errorf("environment variable HTTP_CONTROL_SERVER_PORT: %w", err)
+	}
+
+	return nil
+}

internal/configuration/settings.go

@@ -0,0 +1,125 @@
+package configuration
+
+import (
+	"errors"
+	"fmt"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/golibs/params"
+)
+
+// Settings contains all settings for the program to run.
+type Settings struct {
+	VPN                VPN
+	System             System
+	DNS                DNS
+	Firewall           Firewall
+	HTTPProxy          HTTPProxy
+	ShadowSocks        ShadowSocks
+	Updater            Updater
+	PublicIP           PublicIP
+	VersionInformation bool
+	ControlServer      ControlServer
+	Health             Health
+	Log                Log
+}
+
+func (settings *Settings) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *Settings) lines() (lines []string) {
+	lines = append(lines, "Settings summary below:")
+	lines = append(lines, settings.VPN.lines()...)
+	lines = append(lines, settings.DNS.lines()...)
+	lines = append(lines, settings.Firewall.lines()...)
+	lines = append(lines, settings.Log.lines()...)
+	lines = append(lines, settings.System.lines()...)
+	lines = append(lines, settings.HTTPProxy.lines()...)
+	lines = append(lines, settings.ShadowSocks.lines()...)
+	lines = append(lines, settings.Health.lines()...)
+	lines = append(lines, settings.ControlServer.lines()...)
+	lines = append(lines, settings.Updater.lines()...)
+	lines = append(lines, settings.PublicIP.lines()...)
+	if settings.VersionInformation {
+		lines = append(lines, lastIndent+"Github version information: enabled")
+	}
+	return lines
+}
+
+var (
+	ErrVPN           = errors.New("cannot read VPN settings")
+	ErrSystem        = errors.New("cannot read System settings")
+	ErrDNS           = errors.New("cannot read DNS settings")
+	ErrFirewall      = errors.New("cannot read firewall settings")
+	ErrHTTPProxy     = errors.New("cannot read HTTP proxy settings")
+	ErrShadowsocks   = errors.New("cannot read Shadowsocks settings")
+	ErrControlServer = errors.New("cannot read control server settings")
+	ErrUpdater       = errors.New("cannot read Updater settings")
+	ErrPublicIP      = errors.New("cannot read Public IP getter settings")
+	ErrHealth        = errors.New("cannot read health settings")
+	ErrLog           = errors.New("cannot read log settings")
+)
+
+// Read obtains all configuration options for the program and returns an error as soon
+// as an error is encountered reading them.
+func (settings *Settings) Read(env params.Interface, servers models.AllServers,
+	warner Warner) (err error) {
+	r := newReader(env, servers, warner)
+
+	settings.VersionInformation, err = r.env.OnOff("VERSION_INFORMATION", params.Default("on"))
+	if err != nil {
+		return fmt.Errorf("environment variable VERSION_INFORMATION: %w", err)
+	}
+
+	if err := settings.VPN.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrVPN, err)
+	}
+
+	if err := settings.System.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrSystem, err)
+	}
+
+	if err := settings.DNS.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrDNS, err)
+	}
+
+	if err := settings.Firewall.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrFirewall, err)
+	}
+
+	if err := settings.HTTPProxy.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrHTTPProxy, err)
+	}
+
+	if err := settings.ShadowSocks.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrShadowsocks, err)
+	}
+
+	if err := settings.ControlServer.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrControlServer, err)
+	}
+
+	if err := settings.Updater.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrUpdater, err)
+	}
+
+	if ip := settings.DNS.PlaintextAddress; ip != nil {
+		settings.Updater.DNSAddress = ip.String()
+	}
+
+	if err := settings.PublicIP.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrPublicIP, err)
+	}
+
+	if err := settings.Health.read(r); err != nil {
+		return fmt.Errorf("%w: %s", ErrHealth, err)
+	}
+
+	if err := settings.Log.read(r.env); err != nil {
+		return fmt.Errorf("%w: %s", ErrLog, err)
+	}
+
+	return nil
+}

internal/configuration/settings_test.go

@@ -0,0 +1,74 @@
+package configuration
+
+import (
+	"testing"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_Settings_lines(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		settings Settings
+		lines    []string
+	}{
+		"default settings": {
+			settings: Settings{
+				VPN: VPN{
+					Type: constants.OpenVPN,
+					Provider: Provider{
+						Name: constants.Mullvad,
+						ServerSelection: ServerSelection{
+							VPN: constants.OpenVPN,
+						},
+					},
+					OpenVPN: OpenVPN{
+						Version:   constants.Openvpn25,
+						Interface: "tun",
+					},
+				},
+			},
+			lines: []string{
+				"Settings summary below:",
+				"|--VPN:",
+				"   |--Type: openvpn",
+				"   |--OpenVPN:",
+				"      |--Version: 2.5",
+				"      |--Verbosity level: 0",
+				"      |--Network interface: tun",
+				"   |--Mullvad settings:",
+				"      |--OpenVPN selection:",
+				"         |--Protocol: udp",
+				"|--DNS:",
+				"|--Firewall: disabled ⚠️",
+				"|--Log:",
+				"   |--Level: DEBUG",
+				"|--System:",
+				"   |--Process user ID: 0",
+				"   |--Process group ID: 0",
+				"   |--Timezone: NOT SET ⚠️ - it can cause time related issues",
+				"|--Health:",
+				"   |--Server address: ",
+				"   |--Address to ping: ",
+				"   |--VPN:",
+				"      |--Initial duration: 0s",
+				"|--HTTP control server:",
+				"   |--Listening port: 0",
+				"|--Public IP getter: disabled",
+			},
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			lines := testCase.settings.lines()
+
+			assert.Equal(t, testCase.lines, lines)
+		})
+	}
+}

internal/configuration/shadowsocks.go

@@ -0,0 +1,109 @@
+package configuration
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/qdm12/golibs/params"
+	"github.com/qdm12/ss-server/pkg/tcpudp"
+)
+
+// ShadowSocks contains settings to configure the Shadowsocks server.
+type ShadowSocks struct {
+	Enabled bool
+	tcpudp.Settings
+}
+
+func (settings *ShadowSocks) String() string {
+	return strings.Join(settings.lines(), "\n")
+}
+
+func (settings *ShadowSocks) lines() (lines []string) {
+	if !settings.Enabled {
+		return nil
+	}
+
+	lines = append(lines, lastIndent+"Shadowsocks server:")
+
+	lines = append(lines, indent+lastIndent+"Listening address: "+settings.Address)
+
+	lines = append(lines, indent+lastIndent+"Cipher: "+settings.CipherName)
+
+	if settings.LogAddresses {
+		lines = append(lines, indent+lastIndent+"Log addresses: enabled")
+	}
+
+	return lines
+}
+
+func (settings *ShadowSocks) read(r reader) (err error) {
+	settings.Enabled, err = r.env.OnOff("SHADOWSOCKS", params.Default("off"))
+	if !settings.Enabled {
+		return nil
+	} else if err != nil {
+		return fmt.Errorf("environment variable SHADOWSOCKS: %w", err)
+	}
+
+	settings.Password, err = r.getFromEnvOrSecretFile("SHADOWSOCKS_PASSWORD", settings.Enabled, nil)
+	if err != nil {
+		return err
+	}
+
+	settings.LogAddresses, err = r.env.OnOff("SHADOWSOCKS_LOG", params.Default("off"))
+	if err != nil {
+		return fmt.Errorf("environment variable SHADOWSOCKS_LOG: %w", err)
+	}
+
+	settings.CipherName, err = r.env.Get("SHADOWSOCKS_CIPHER", params.Default("chacha20-ietf-poly1305"),
+		params.RetroKeys([]string{"SHADOWSOCKS_METHOD"}, r.onRetroActive))
+	if err != nil {
+		return fmt.Errorf("environment variable SHADOWSOCKS_CIPHER (or SHADOWSOCKS_METHOD): %w", err)
+	}
+
+	warning, err := settings.getAddress(r.env)
+	if warning != "" {
+		r.warner.Warn(warning)
+	}
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (settings *ShadowSocks) getAddress(env params.Interface) (
+	warning string, err error) {
+	address, err := env.Get("SHADOWSOCKS_LISTENING_ADDRESS")
+	if err != nil {
+		return "", fmt.Errorf("environment variable SHADOWSOCKS_LISTENING_ADDRESS: %w", err)
+	}
+
+	if address != "" {
+		address, warning, err := env.ListeningAddress("SHADOWSOCKS_LISTENING_ADDRESS")
+		if err != nil {
+			return "", fmt.Errorf("environment variable SHADOWSOCKS_LISTENING_ADDRESS: %w", err)
+		}
+		settings.Address = address
+		return warning, nil
+	}
+
+	// Retro-compatibility
+	const retroWarning = "You are using the old environment variable " +
+		"SHADOWSOCKS_PORT, please consider using " +
+		"SHADOWSOCKS_LISTENING_ADDRESS instead"
+	portStr, err := env.Get("SHADOWSOCKS_PORT")
+	if err != nil {
+		return retroWarning, fmt.Errorf("environment variable SHADOWSOCKS_PORT: %w", err)
+	} else if portStr != "" {
+		port, _, err := env.ListeningPort("SHADOWSOCKS_PORT")
+		if err != nil {
+			return retroWarning, fmt.Errorf("environment variable SHADOWSOCKS_PORT: %w", err)
+		}
+		settings.Address = ":" + fmt.Sprint(port)
+		return retroWarning, nil
+	}
+
+	// Default value
+	settings.Address = ":8388"
+	return "", nil
+}

internal/configuration/surfshark.go

@@ -0,0 +1,102 @@
+package configuration
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/golibs/params"
+)
+
+func (settings *Provider) readSurfshark(r reader) (err error) {
+	settings.Name = constants.Surfshark
+	servers := r.servers.GetSurfshark()
+
+	settings.ServerSelection.TargetIP, err = readTargetIP(r.env)
+	if err != nil {
+		return err
+	}
+
+	settings.ServerSelection.Countries, err = r.env.CSVInside("COUNTRY", constants.SurfsharkCountryChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable COUNTRY: %w", err)
+	}
+
+	settings.ServerSelection.Cities, err = r.env.CSVInside("CITY", constants.SurfsharkCityChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable CITY: %w", err)
+	}
+
+	settings.ServerSelection.Hostnames, err = r.env.CSVInside("SERVER_HOSTNAME",
+		constants.SurfsharkHostnameChoices(servers))
+	if err != nil {
+		return fmt.Errorf("environment variable SERVER_HOSTNAME: %w", err)
+	}
+
+	regionChoices := constants.SurfsharkRegionChoices(servers)
+	regionChoices = append(regionChoices, constants.SurfsharkRetroLocChoices(servers)...)
+	settings.ServerSelection.Regions, err = r.env.CSVInside("REGION", regionChoices)
+	if err != nil {
+		return fmt.Errorf("environment variable REGION: %w", err)
+	}
+
+	// Retro compatibility
+	// TODO remove in v4
+	settings.ServerSelection = surfsharkRetroRegion(settings.ServerSelection)
+
+	settings.ServerSelection.MultiHopOnly, err = r.env.YesNo("MULTIHOP_ONLY", params.Default("no"))
+	if err != nil {
+		return fmt.Errorf("environment variable MULTIHOP_ONLY: %w", err)
+	}
+
+	return settings.ServerSelection.OpenVPN.readProtocolOnly(r)
+}
+
+func surfsharkRetroRegion(selection ServerSelection) (
+	updatedSelection ServerSelection) {
+	locationData := constants.SurfsharkLocationData()
+
+	retroToLocation := make(map[string]models.SurfsharkLocationData, len(locationData))
+	for _, data := range locationData {
+		if data.RetroLoc == "" {
+			continue
+		}
+		retroToLocation[strings.ToLower(data.RetroLoc)] = data
+	}
+
+	for i, region := range selection.Regions {
+		location, ok := retroToLocation[region]
+		if !ok {
+			continue
+		}
+		selection.Regions[i] = strings.ToLower(location.Region)
+		selection.Countries = append(selection.Countries, strings.ToLower(location.Country))
+		selection.Cities = append(selection.Cities, strings.ToLower(location.City)) // even empty string
+		selection.Hostnames = append(selection.Hostnames, location.Hostname)
+	}
+
+	selection.Regions = dedupSlice(selection.Regions)
+	selection.Countries = dedupSlice(selection.Countries)
+	selection.Cities = dedupSlice(selection.Cities)
+	selection.Hostnames = dedupSlice(selection.Hostnames)
+
+	return selection
+}
+
+func dedupSlice(slice []string) (deduped []string) {
+	if slice == nil {
+		return nil
+	}
+
+	deduped = make([]string, 0, len(slice))
+	seen := make(map[string]struct{}, len(slice))
+	for _, s := range slice {
+		if _, ok := seen[s]; !ok {
+			seen[s] = struct{}{}
+			deduped = append(deduped, s)
+		}
+	}
+
+	return deduped
+}

internal/configuration/surfshark_test.go

@@ -0,0 +1,305 @@
+package configuration
+
+import (
+	"errors"
+	"net"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/golibs/params/mock_params"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_Provider_readSurfshark(t *testing.T) {
+	t.Parallel()
+
+	var errDummy = errors.New("dummy test error")
+
+	type stringCall struct {
+		call  bool
+		value string
+		err   error
+	}
+
+	type boolCall struct {
+		call  bool
+		value bool
+		err   error
+	}
+
+	type sliceStringCall struct {
+		call   bool
+		values []string
+		err    error
+	}
+
+	testCases := map[string]struct {
+		targetIP  stringCall
+		countries sliceStringCall
+		cities    sliceStringCall
+		hostnames sliceStringCall
+		regions   sliceStringCall
+		multiHop  boolCall
+		protocol  stringCall
+		settings  Provider
+		err       error
+	}{
+		"target IP error": {
+			targetIP: stringCall{call: true, value: "something", err: errDummy},
+			settings: Provider{
+				Name: constants.Surfshark,
+			},
+			err: errors.New("environment variable OPENVPN_TARGET_IP: dummy test error"),
+		},
+		"countries error": {
+			targetIP:  stringCall{call: true},
+			countries: sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Surfshark,
+			},
+			err: errors.New("environment variable COUNTRY: dummy test error"),
+		},
+		"cities error": {
+			targetIP:  stringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Surfshark,
+			},
+			err: errors.New("environment variable CITY: dummy test error"),
+		},
+		"hostnames error": {
+			targetIP:  stringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Surfshark,
+			},
+			err: errors.New("environment variable SERVER_HOSTNAME: dummy test error"),
+		},
+		"regions error": {
+			targetIP:  stringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true},
+			regions:   sliceStringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Surfshark,
+			},
+			err: errors.New("environment variable REGION: dummy test error"),
+		},
+		"multi hop error": {
+			targetIP:  stringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true},
+			regions:   sliceStringCall{call: true},
+			multiHop:  boolCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Surfshark,
+			},
+			err: errors.New("environment variable MULTIHOP_ONLY: dummy test error"),
+		},
+		"openvpn protocol error": {
+			targetIP:  stringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true},
+			regions:   sliceStringCall{call: true},
+			multiHop:  boolCall{call: true},
+			protocol:  stringCall{call: true, err: errDummy},
+			settings: Provider{
+				Name: constants.Surfshark,
+			},
+			err: errors.New("environment variable OPENVPN_PROTOCOL: dummy test error"),
+		},
+		"default settings": {
+			targetIP:  stringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			hostnames: sliceStringCall{call: true},
+			regions:   sliceStringCall{call: true},
+			multiHop:  boolCall{call: true},
+			protocol:  stringCall{call: true},
+			settings: Provider{
+				Name: constants.Surfshark,
+			},
+		},
+		"set settings": {
+			targetIP:  stringCall{call: true, value: "1.2.3.4"},
+			countries: sliceStringCall{call: true, values: []string{"A", "B"}},
+			cities:    sliceStringCall{call: true, values: []string{"C", "D"}},
+			regions: sliceStringCall{call: true, values: []string{
+				"E", "F", "netherlands amsterdam",
+			}}, // Netherlands Amsterdam is for retro compatibility test
+			multiHop:  boolCall{call: true},
+			hostnames: sliceStringCall{call: true, values: []string{"E", "F"}},
+			protocol:  stringCall{call: true, value: constants.TCP},
+			settings: Provider{
+				Name: constants.Surfshark,
+				ServerSelection: ServerSelection{
+					OpenVPN: OpenVPNSelection{
+						TCP: true,
+					},
+					TargetIP:  net.IPv4(1, 2, 3, 4),
+					Regions:   []string{"E", "F", "europe"},
+					Countries: []string{"A", "B", "netherlands"},
+					Cities:    []string{"C", "D", "amsterdam"},
+					Hostnames: []string{"E", "F", "nl-ams.prod.surfshark.com"},
+				},
+			},
+		},
+		"Netherlands Amsterdam": {
+			targetIP:  stringCall{call: true},
+			countries: sliceStringCall{call: true},
+			cities:    sliceStringCall{call: true},
+			regions:   sliceStringCall{call: true, values: []string{"netherlands amsterdam"}},
+			multiHop:  boolCall{call: true},
+			hostnames: sliceStringCall{call: true},
+			protocol:  stringCall{call: true},
+			settings: Provider{
+				Name: constants.Surfshark,
+				ServerSelection: ServerSelection{
+					Regions:   []string{"europe"},
+					Countries: []string{"netherlands"},
+					Cities:    []string{"amsterdam"},
+					Hostnames: []string{"nl-ams.prod.surfshark.com"},
+				},
+			},
+		},
+	}
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			ctrl := gomock.NewController(t)
+
+			env := mock_params.NewMockInterface(ctrl)
+
+			servers := []models.SurfsharkServer{{Hostname: "a"}}
+			allServers := models.AllServers{
+				Surfshark: models.SurfsharkServers{
+					Servers: servers,
+				},
+			}
+
+			if testCase.targetIP.call {
+				env.EXPECT().Get("OPENVPN_TARGET_IP").
+					Return(testCase.targetIP.value, testCase.targetIP.err)
+			}
+			if testCase.countries.call {
+				env.EXPECT().CSVInside("COUNTRY", constants.SurfsharkCountryChoices(servers)).
+					Return(testCase.countries.values, testCase.countries.err)
+			}
+			if testCase.cities.call {
+				env.EXPECT().CSVInside("CITY", constants.SurfsharkCityChoices(servers)).
+					Return(testCase.cities.values, testCase.cities.err)
+			}
+			if testCase.hostnames.call {
+				env.EXPECT().CSVInside("SERVER_HOSTNAME", constants.SurfsharkHostnameChoices(servers)).
+					Return(testCase.hostnames.values, testCase.hostnames.err)
+			}
+			if testCase.regions.call {
+				regionChoices := constants.SurfsharkRegionChoices(servers)
+				regionChoices = append(regionChoices, constants.SurfsharkRetroLocChoices(servers)...)
+				env.EXPECT().CSVInside("REGION", regionChoices).
+					Return(testCase.regions.values, testCase.regions.err)
+			}
+			if testCase.multiHop.call {
+				env.EXPECT().YesNo("MULTIHOP_ONLY", gomock.Any()).
+					Return(testCase.multiHop.value, testCase.multiHop.err)
+			}
+			if testCase.protocol.call {
+				env.EXPECT().Inside("OPENVPN_PROTOCOL", []string{constants.TCP, constants.UDP}, gomock.Any()).
+					Return(testCase.protocol.value, testCase.protocol.err)
+			}
+
+			r := reader{
+				servers: allServers,
+				env:     env,
+			}
+
+			var settings Provider
+			err := settings.readSurfshark(r)
+
+			if testCase.err != nil {
+				require.Error(t, err)
+				assert.Equal(t, testCase.err.Error(), err.Error())
+			} else {
+				assert.NoError(t, err)
+			}
+
+			assert.Equal(t, testCase.settings, settings)
+		})
+	}
+}
+
+func Test_surfsharkRetroRegion(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		original ServerSelection
+		modified ServerSelection
+	}{
+		"empty": {},
+		"1 retro region": {
+			original: ServerSelection{
+				Regions: []string{"australia adelaide"},
+			},
+			modified: ServerSelection{
+				Regions:   []string{"asia pacific"},
+				Countries: []string{"australia"},
+				Cities:    []string{"adelaide"},
+				Hostnames: []string{"au-adl.prod.surfshark.com"},
+			},
+		},
+		"2 overlapping retro regions": {
+			original: ServerSelection{
+				Regions: []string{"australia adelaide", "australia melbourne"},
+			},
+			modified: ServerSelection{
+				Regions:   []string{"asia pacific"},
+				Countries: []string{"australia"},
+				Cities:    []string{"adelaide", "melbourne"},
+				Hostnames: []string{"au-adl.prod.surfshark.com", "au-mel.prod.surfshark.com"},
+			},
+		},
+		"2 distinct retro regions": {
+			original: ServerSelection{
+				Regions: []string{"australia adelaide", "netherlands amsterdam"},
+			},
+			modified: ServerSelection{
+				Regions:   []string{"asia pacific", "europe"},
+				Countries: []string{"australia", "netherlands"},
+				Cities:    []string{"adelaide", "amsterdam"},
+				Hostnames: []string{"au-adl.prod.surfshark.com", "nl-ams.prod.surfshark.com"},
+			},
+		},
+		"retro region with existing region": {
+			// note TestRegion will be ignored in the filters downstream
+			original: ServerSelection{
+				Regions: []string{"TestRegion", "australia adelaide"},
+			},
+			modified: ServerSelection{
+				Regions:   []string{"TestRegion", "asia pacific"},
+				Countries: []string{"australia"},
+				Cities:    []string{"adelaide"},
+				Hostnames: []string{"au-adl.prod.surfshark.com"},
+			},
+		},
+	}
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			selection := surfsharkRetroRegion(testCase.original)
+
+			assert.Equal(t, testCase.modified, selection)
+		})
+	}
+}