fix(update): fetch IPv6 AAAA records and not only IPv4

- eTLD must be goip.de or goip.it, not eTLD+1
- remove old `domain` optional parameter documentation

.devcontainer/.dockerignore

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

.devcontainer/Dockerfile

@@ -0,0 +1 @@
+FROM qmcgaw/godevcontainer

.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 dev 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
+- [Docker Compose](https://docs.docker.com/compose/install/) installed
+
+## Setup
+
+1. Create the following files on your host if you don't have them:
+
+    ```sh
+    touch ~/.gitconfig ~/.zsh_history
+    ```
+
+    Note that the development container will create the empty directories `~/.docker`, `~/.ssh` and `~/.kube` if you don't have them.
+
+1. **For Docker on OSX or Windows without WSL**: ensure your home directory `~` is accessible by Docker.
+1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P).
+1. Select `Dev Containers: Open Folder in Container...` and choose the project directory.
+
+## 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
+RUN apk add curl
+```
+
+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 `/root/.welcome.sh` to replace the [current welcome script](https://github.com/qdm12/basedevcontainer/blob/master/shell/.welcome.sh).
+
+### Publish a port
+
+To access a port from your host to your development container, publish a port in [docker-compose.yml](docker-compose.yml). You can also now do it directly with VSCode without restarting the container.
+
+### 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,69 +1,75 @@
-{
-    "name": "ddns-dev",
-    "dockerComposeFile": [
-        "docker-compose.yml"
-    ],
-    "service": "vscode",
-    "runServices": [
-        "vscode"
-    ],
-    "shutdownAction": "stopCompose",
-    "postCreateCommand": "go mod download",
-    "workspaceFolder": "/workspace",
-    "appPort": 8000,
-    "extensions": [
-        "ms-vscode.go",
-        "IBM.output-colorizer",
-        "eamodio.gitlens",
-        "mhutchie.git-graph",
-        "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"
-    ],
-    "settings": {
-        // 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
-        },
-        // Golang on save
-        "go.buildOnSave": "package",
-        "go.lintOnSave": "package",
-        "go.vetOnSave": "package",
-        "editor.formatOnSave": true,
-        "[go]": {
-            "editor.codeActionsOnSave": {
-                "source.organizeImports": true
-            }
-        },
-        // Golang testing
-        "go.toolsEnvVars": {
-            "GOFLAGS": "-tags=integration"
-        },
-        "gopls.env": {
-            "GOFLAGS": "-tags=integration"
-        },
-        "go.testEnvVars": {},
-        "go.testFlags": [
-            "-v"
-        ],
-        "go.testTimeout": "600s"
-    }
+{
+    "name": "ddns-dev",
+    "dockerComposeFile": [
+        "docker-compose.yml"
+    ],
+    "service": "vscode",
+    "runServices": [
+        "vscode"
+    ],
+    "shutdownAction": "stopCompose",
+    "postCreateCommand": "~/.windows.sh && go mod download && go mod tidy",
+    "workspaceFolder": "/workspace",
+    // "overrideCommand": "",
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "golang.go",
+                "eamodio.gitlens", // IDE Git information
+                "davidanson.vscode-markdownlint",
+                "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
+                "github.copilot" // AI code completion
+                // "mohsen1.prettify-json", // Prettify JSON data
+                // "zxh404.vscode-proto3", // Supports Proto syntax
+                // "jrebocho.vscode-random", // Generates random values
+                // "alefragnani.Bookmarks", // Manage bookmarks
+                // "quicktype.quicktype", // Paste JSON as code
+                // "spikespaz.vscode-smoothtype", // smooth cursor animation
+            ],
+            "settings": {
+                "files.eol": "\n",
+                "editor.formatOnSave": true,
+                "go.buildTags": "",
+                "go.toolsEnvVars": {
+                    "CGO_ENABLED": "0"
+                },
+                "go.useLanguageServer": true,
+                "go.testEnvVars": {
+                    "CGO_ENABLED": "1"
+                },
+                "go.testFlags": [
+                    "-v",
+                    "-race"
+                ],
+                "go.testTimeout": "10s",
+                "go.coverOnSingleTest": true,
+                "go.coverOnSingleTestFile": true,
+                "go.coverOnTestPackage": true,
+                "go.lintTool": "golangci-lint",
+                "go.lintOnSave": "package",
+                "[go]": {
+                    "editor.codeActionsOnSave": {
+                        "source.organizeImports": true
+                    }
+                },
+                "gopls": {
+                    "usePlaceholders": false,
+                    "staticcheck": true,
+                    "vulncheck": "Imports"
+                },
+                "remote.extensionKind": {
+                    "ms-azuretools.vscode-docker": "workspace"
+                }
+            }
+        }
+    }
 }

.devcontainer/docker-compose.yml

@@ -2,14 +2,26 @@ version: "3.7"
 
 services:
   vscode:
-    image: qmcgaw/godevcontainer
+    build: .
     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
+      # SSH directory for Linux, OSX and WSL
+      # On Linux and OSX, a symlink /mnt/ssh <-> ~/.ssh is
+      # created in the container. On Windows, files are copied
+      # from /mnt/ssh to ~/.ssh to fix permissions.
+      - ~/.ssh:/mnt/ssh
+      # Shell history persistence
+      - ~/.zsh_history:/root/.zsh_history
+      # Git config
+      - ~/.gitconfig:/root/.gitconfig
+    environment:
+      - TZ=
     cap_add:
+      # For debugging with dlv
       - SYS_PTRACE
     security_opt:
+      # For debugging with dlv
       - seccomp:unconfined
-    entrypoint: zsh -c "while sleep 1000; do :; done"
+    entrypoint: [ "zsh", "-c", "while sleep 1000; do :; done" ]

.dockerignore

@@ -1,11 +1,12 @@
+.devcontainer
 .git
-*.exe
+.github
 .vscode
-.travis.yml
+docs
+readme
+!readme/*.go
+.gitignore
+config.json
 docker-compose.yml
 LICENSE
-*.md
-readme
-.gitignore
-.devcontainer
-.vscode
+ui/favicon.svg

.github/CONTRIBUTING.md

@@ -1,17 +1,92 @@
 # Contributing
 
-Contributions are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [open source license of this project](../LICENSE).
+## Table of content
+
+1. [Submitting a pull request](#submitting-a-pull-request)
+1. [Development setup](#development-setup)
+1. [Commands available](#commands-available)
+1. [Add a new DNS provider](#add-a-new-dns-provider)
+1. [License](#license)
 
 ## Submitting a pull request
 
 1. [Fork](https://github.com/qdm12/ddns-updater/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. Commit your modifications
 1. Push to your fork and [submit a pull request](https://github.com/qdm12/ddns-updater/compare)
 
-## Resources
+Additional resources:
 
 - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
 - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+
+## Development setup
+
+### Using VSCode and Docker
+
+That should be easier and better than a local setup, although it might use more memory if you're not on Linux.
+
+1. Install [Docker](https://docs.docker.com/install/)
+    - On Windows, share a drive with Docker Desktop and have the project on that partition
+    - On OSX, share your project directory with Docker Desktop
+1. With [Visual Studio Code](https://code.visualstudio.com/download), install the [dev containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
+1. In Visual Studio Code, press on `F1` and select `Dev Containers: Open Folder in Container...`
+1. Your dev environment is ready to go!... and it's running in a container :+1:
+
+### Locally
+
+Install [Go](https://golang.org/dl/), [Docker](https://www.docker.com/products/docker-desktop) and [Git](https://git-scm.com/downloads); then:
+
+```sh
+go mod download
+```
+
+And finally install [golangci-lint](https://github.com/golangci/golangci-lint#install).
+
+You might want to use an editor such as [Visual Studio Code](https://code.visualstudio.com/download) with the [Go extension](https://code.visualstudio.com/docs/languages/go).
+
+## Commands available
+
+- Test the code: `go test ./...`
+- Lint the code `golangci-lint run`
+- Build the program: `go build -o app cmd/ddns-updater/main.go`
+- Build the Docker image (tests and lint included): `docker build -t qmcgaw/ddns-updater .`
+- Run the Docker container: `docker run -it --rm -v /yourpath/data:/updater/data qmcgaw/ddns-updater`
+
+## Add a new DNS provider
+
+An "example" DNS provider is present in the code, you can simply copy paste it modify it to your needs.
+In more detailed steps:
+
+1. Copy the directory [`internal/provider/providers/example`](../internal/provider/providers/example) to `internal/provider/providers/yourprovider` where `yourprovider` is the name of the DNS provider you want to add, in a single word without spaces, dashes or underscores.
+1. Modify the `internal/provider/providers/yourprovider/provider.go` file to fit the requirements of your DNS provider. There are many `// TODO` comments you can follow and **need to remove** when done.
+1. Add the provider name constant to the `ProviderChoices` function in [`internal/provider/constants/providers.go`](../internal/provider/constants/providers.go). For example:
+
+    ```go
+    func ProviderChoices() []models.Provider {
+      return []models.Provider{
+        // ...
+        Example,
+        // ...
+      }
+    }
+    ```
+
+1. Add a case for your provider in the `switch` statement in the `New` function in [`internal/provider/provider.go`](../internal/provider/provider.go). For example:
+
+    ```go
+    case constants.Example:
+      return example.New(data, domain, owner, ipVersion, ipv6Suffix)
+    ```
+
+1. Copy the file [`docs/example.md`](../docs/example.md) to `docs/yourprovider.md` and modify it to fit the configuration and domain setup of your DNS provider. There are a few `<!-- ... -->` comments indicating what to change, please **remove them** when done.
+1. In the [README.md](../README.md):
+    1. Add your provider name to the  list of providers supported `- Your provider`
+    1. Add your provider name and link to its document to the second list: `- [Your provider](docs/yourprovider.md)`
+1. Make sure to run the actual program (in Docker or directly) and check it updates your DNS records as expected, of course 😉 You can do this by setting a record to `127.0.0.1` manually and then run the updater to see if the update succeeds.
+1. Profit 🎉 Don't forget to [open a pull request](https://github.com/qdm12/ddns-updater/compare)
+
+## License
+
+Contributions are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [open source license of this project](../LICENSE).

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,42 @@
+---
+name: Bug
+about: Report a bug
+title: 'Bug: FILL THIS TEXT OR ISSUE WILL BE CLOSED'
+labels:
+
+---
+
+<!--
+
+YOU CAN CHAT THERE EVENTUALLY:
+
+https://github.com/qdm12/ddns-updater/discussions
+
+-->
+
+**TLDR**: *Describe your issue in a one liner here*
+
+1. Is this urgent: Yes/No
+2. DNS provider(s) you use: Answer here
+3. Program version:
+
+    <!-- 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-compose
+5. Extra information (optional)
+
+Logs:
+
+```log
+
+```
+
+Configuration file (**remove your credentials!**):
+
+```json
+
+```
+
+Host OS:

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest a feature to add to this project
+title: 'Feature request: FILL THIS TEXT OR ISSUE WILL BE CLOSED'
+labels:
+
+---
+
+1. What's the feature?
+
+2. Extra information?
+
+<!--
+
+YOU CAN CHAT THERE EVENTUALLY:
+
+https://github.com/qdm12/ddns-updater/discussions
+
+-->

.github/ISSUE_TEMPLATE/help.md

@@ -0,0 +1,42 @@
+---
+name: Help
+about: Ask for help
+title: 'Help: FILL THIS TEXT OR ISSUE WILL BE CLOSED'
+labels:
+
+---
+
+<!--
+
+HAVE A CHAT FIRST!
+
+https://github.com/qdm12/ddns-updater/discussions
+
+-->
+
+**TLDR**: *Describe your issue in a one liner here*
+
+1. Is this urgent: Yes/No
+2. DNS provider(s) you use: Answer here
+3. Program version:
+
+    <!-- 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-compose
+5. Extra information (optional)
+
+Logs:
+
+```log
+
+```
+
+Configuration file (**remove your credentials!**):
+
+```json
+
+```
+
+Host OS:

.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,62 @@
-- name: ":robot: bot"
-  color: "69cde9"
-  description: ""
-- 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"
-  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"
-  color: "4caf50"
-  description: ""
-- name: ":hand: hold"
-  color: "24292f"
-  description: ""
-- name: ":no_entry_sign: invalid"
-  color: "e6e6e6"
-  description: ""
-- name: ":interrobang: maybe bug"
-  color: "ff5722"
-  description: ""
-- name: ":thinking: needs more info"
-  color: "795548"
-  description: ""
-- name: ":question: question"
-  color: "3f51b5"
-  description: ""
-- name: ":coffin: wontfix"
-  color: "ffffff"
-  description: ""
+- name: "Status: 🗯️ Waiting for feedback"
+  color: "f7d692"
+- name: "Status: 🔴 Blocked"
+  color: "f7d692"
+  description: "Blocked by another issue or pull request"
+- name: "Status: 🔒 After next release"
+  color: "f7d692"
+  description: "Will be done after the next release"
+
+- name: "Closed: ⚰️ Inactive"
+  color: "959a9c"
+  description: "No answer was received for weeks"
+- name: "Closed: 👥 Duplicate"
+  color: "959a9c"
+  description: "Issue duplicates an existing issue"
+- name: "Closed: 🗑️ Bad issue"
+  color: "959a9c"
+
+- name: "Priority: 🚨 Urgent"
+  color: "03adfc"
+- name: "Priority: 💤 Low priority"
+  color: "03adfc"
+
+- name: "Complexity: ☣️ Hard to do"
+  color: "ff9efc"
+- name: "Complexity: 🟩 Easy to do"
+  color: "ff9efc"
+
+- name: "Category: Config problem 📝"
+  color: "ffc7ea"
+- name: "Category: Healthcheck 🩺"
+  color: "ffc7ea"
+- name: "Category: Documentation ✒️"
+  description: "A problem with the readme or in the docs/ directory"
+  color: "ffc7ea"
+- name: "Category: Maintenance ⛓️"
+  description: "Anything related to code or other maintenance"
+  color: "ffc7ea"
+- name: "Category: Good idea 🎯"
+  description: "This is a good idea, judged by the maintainers"
+  color: "ffc7ea"
+- name: "Category: Motivated! 🙌"
+  description: "Your pumpness makes me pumped! The issue or PR shows great motivation!"
+  color: "ffc7ea"
+- name: "Category: Foolproof settings 👼"
+  color: "ffc7ea"
+- name: "Category: Label missing ❗"
+  color: "ffc7ea"
+- name: "Category: Provider update ♻️"
+  color: "ffc7ea"
+- name: "Category: Shoutrrr 📢"
+  color: "ffc7ea"
+- name: "Category: IP fetching 📥"
+  color: "ffc7ea"
+- name: "Category: Database 🗃️"
+  color: "ffc7ea"
+- name: "Category: New provider 🆕"
+  color: "ffc7ea"
+- name: "Category: Web UI 🖱️"
+  color: "ffc7ea"
+- name: "Category: Wildcard 🃏"
+  color: "ffc7ea"

.github/workflows/build-skip.yml

@@ -0,0 +1,35 @@
+name: No trigger file paths
+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - .github/workflows/build.yml
+      - cmd/**
+      - internal/**
+      - pkg/**
+      - .dockerignore
+      - .golangci.yml
+      - Dockerfile
+      - go.mod
+      - go.sum
+  pull_request:
+    paths-ignore:
+      - .github/workflows/build.yml
+      - cmd/**
+      - internal/**
+      - pkg/**
+      - .dockerignore
+      - .golangci.yml
+      - Dockerfile
+      - go.mod
+      - go.sum
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+    steps:
+      - name: No trigger path triggered for required verify workflow.
+        run: exit 0

.github/workflows/build.yml

@@ -1,12 +1,166 @@
-name: Docker build
+name: CI
 on:
+  release:
+    types:
+      - published
+  push:
+    branches:
+      - master
+    paths:
+      - .github/workflows/build.yml
+      - cmd/**
+      - internal/**
+      - pkg/**
+      - .dockerignore
+      - .golangci.yml
+      - Dockerfile
+      - go.mod
+      - go.sum
   pull_request:
-    branches: [master]
+    paths:
+      - .github/workflows/build.yml
+      - cmd/**
+      - internal/**
+      - pkg/**
+      - .dockerignore
+      - .golangci.yml
+      - Dockerfile
+      - go.mod
+      - go.sum
+
 jobs:
-  build:
+  verify:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+    env:
+      DOCKER_BUILDKIT: "1"
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: reviewdog/action-misspell@v1
+        with:
+          locale: "US"
+          level: error
+          exclude: |
+            *.md
+
+      - name: Linting
+        run: docker build --target lint .
+
+      - name: Mocks check
+        run: docker build --target mocks .
+
+      - 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: Build final image
+        run: docker build -t final-image .
+
+  codeql:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "^1.22"
+      - uses: github/codeql-action/init@v3
+        with:
+          languages: go
+      - uses: github/codeql-action/autobuild@v3
+      - uses: github/codeql-action/analyze@v3
+
+  publish:
+    if: |
+      github.repository == 'qdm12/ddns-updater' &&
+      (
+        github.event_name == 'push' ||
+        github.event_name == 'release' ||
+        (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository && github.actor != 'dependabot[bot]')
+      )
+    needs: [verify, codeql]
+    permissions:
+      actions: read
+      contents: write
+      packages: write
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Build image
-        run: docker build .
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # for gorelease last step
+
+      # extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          flavor: |
+            latest=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
+          images: |
+            ghcr.io/qdm12/ddns-updater
+            qmcgaw/ddns-updater
+          tags: |
+            type=ref,event=pr
+            type=semver,pattern={{major}}.{{minor}}.{{patch}}
+            type=semver,pattern=v{{major}}.{{minor}}.{{patch}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern=v{{major}}.{{minor}}
+            type=semver,pattern={{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }}
+            type=semver,pattern=v{{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }}
+            type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
+
+      - uses: docker/setup-qemu-action@v3
+      - uses: docker/setup-buildx-action@v3
+
+      - uses: docker/login-action@v3
+        with:
+          username: qmcgaw
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ github.token }}
+
+      - name: Short commit
+        id: shortcommit
+        run: echo "::set-output name=value::$(git rev-parse --short HEAD)"
+
+      - name: Build and push final image
+        uses: docker/build-push-action@v6
+        with:
+          platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v6,linux/arm/v7,linux/s390x,linux/ppc64le,linux/riscv64
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            CREATED=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}
+            COMMIT=${{ steps.shortcommit.outputs.value }}
+            VERSION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }}
+          tags: ${{ steps.meta.outputs.tags }}
+          push: true
+
+      - if: github.event_name == 'release'
+        uses: actions/setup-go@v5
+        with:
+          go-version: 1.22
+
+      - if: github.event_name == 'release'
+        uses: goreleaser/goreleaser-action@v6
+        with:
+          version: latest
+          args: release --clean --config .github/workflows/configs/.goreleaser.yaml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/buildx-latest.yml

@@ -1,40 +0,0 @@
-name: Buildx latest
-on:
-  push:
-    branches: [master]
-    paths-ignore:
-      - .github/workflows/buildx-release.yml
-      - .github/workflows/dockerhub-description.yml
-      - .github/workflows/greetings.yml
-      - .github/workflows/labels.yml
-      - .github/workflows/misspell.yml
-      - .github/workflows/security.yml
-      - .dockerignore
-      - .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
-        with:
-          version: latest
-      - 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 \
-            --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/ddns-updater:latest \
-            --push \
-            .
-      - run: curl -X POST https://hooks.microbadger.com/images/qmcgaw/ddns-updater/t2fcZxog8ce_kJYJ61JjkYwHF5s= || exit 0

.github/workflows/buildx-release.yml

@@ -1,40 +0,0 @@
-name: Buildx release
-on:
-  release:
-    types: [published]
-    paths-ignore:
-      - .github/workflows/buildx-latest.yml
-      - .github/workflows/dockerhub-description.yml
-      - .github/workflows/greetings.yml
-      - .github/workflows/labels.yml
-      - .github/workflows/misspell.yml
-      - .github/workflows/security.yml
-      - .dockerignore
-      - .gitignore
-      - docker-compose.yml
-      - LICENSE
-      - README.md
-      - title.svg
-jobs:
-  buildx:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - id: buildx
-        uses: crazy-max/ghaction-docker-buildx@v1
-        with:
-          version: latest
-      - 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 \
-            --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/ddns-updater:${GITHUB_REF##*/} \
-            --push \
-            .
-      - run: curl -X POST https://hooks.microbadger.com/images/qmcgaw/ddns-updater/t2fcZxog8ce_kJYJ61JjkYwHF5s= || exit 0

.github/workflows/configs/.goreleaser.yaml

@@ -0,0 +1,30 @@
+before:
+  hooks:
+    - go mod download
+builds:
+  - main: ./cmd/ddns-updater/main.go
+    flags:
+      - -trimpath
+    env:
+      - CGO_ENABLED=0
+    targets:
+      # See https://goreleaser.com/customization/build/
+      - linux_amd64
+      - linux_386
+      - linux_arm64
+      - linux_arm_7
+      - linux_arm_6
+      - linux_arm_5
+      - darwin_amd64
+      - darwin_arm64
+      - windows_amd64
+      - windows_386
+      - windows_arm64
+archives:
+  - format: binary
+checksum:
+  name_template: "checksums.txt"
+snapshot:
+  name_template: "{{ .Tag }}-next"
+changelog:
+  sort: asc

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

@@ -0,0 +1,41 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^http://localhost"
+    },
+    {
+      "pattern": "^https://api6.ipify.org$"
+    },
+    {
+      "pattern": "^http://ip1.dynupdate6.no-ip.com$"
+    },
+    {
+      "pattern": "^https://ap.www.namecheap.com/Domains/DomainControlPanel/example.com/advancedns$"
+    },
+    {
+      "pattern": "^https://www.godaddy.com"
+    },
+    {
+      "pattern": "^https://www.namecheap.com"
+    },
+    {
+      "pattern": "https://www.linode.com/docs/products/tools/api/guides/manage-api-tokens/"
+    },
+    {
+      "pattern": "https://(ip|ipv|v)6.+"
+    },
+    {
+      "pattern": "https://github.com/qdm12/ddns-updater/pkgs/container/ddns-updater"
+    },
+    {
+      "pattern": "^https://www.duckdns.org/$"
+    }
+  ],
+  "timeout": "20s",
+  "retryOn429": false,
+  "fallbackRetryDelay": "30s",
+  "aliveStatusCodes": [
+    200,
+    206
+  ]
+}

.github/workflows/dockerhub-description.yml

@@ -1,19 +0,0 @@
-name: Docker Hub description
-on:
-  push:
-    branches: [master]
-    paths:
-      - README.md
-      - .github/workflows/dockerhub-description.yml
-jobs:
-  dockerHubDescription:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Docker Hub Description
-        uses: peter-evans/dockerhub-description@v2.1.0
-        env:
-          DOCKERHUB_USERNAME: qmcgaw
-          DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
-          DOCKERHUB_REPOSITORY: qmcgaw/ddns-updater

.github/workflows/greetings.yml

@@ -1,11 +0,0 @@
-name: Greetings
-on: [pull_request, issues]
-jobs:
-  greeting:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/first-interaction@v1
-        with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-          issue-message: 'Thanks for creating your first issue :+1: Feel free to use [Slack](https://join.slack.com/t/qdm12/shared_invite/enQtODMwMDQyMTAxMjY1LTU1YjE1MTVhNTBmNTViNzJiZmQwZWRmMDhhZjEyNjVhZGM4YmIxOTMxOTYzN2U0N2U2YjQ2MDk3YmYxN2NiNTc) if you just need some quick help or want to chat'
-          pr-message: 'Thank you so much for contributing, that means a lot to me :wink:'

.github/workflows/labels.yml

@@ -1,18 +1,18 @@
 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
+        uses: actions/checkout@v4
       - name: Labeler
         if: success()
-        uses: crazy-max/ghaction-github-labeler@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: crazy-max/ghaction-github-labeler@v5
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/markdown-skip.yml

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

.github/workflows/markdown.yml

@@ -0,0 +1,48 @@
+name: Markdown
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "**.md"
+      - .github/workflows/markdown.yml
+  pull_request:
+    paths:
+      - "**.md"
+      - .github/workflows/markdown.yml
+
+jobs:
+  markdown:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: DavidAnson/markdownlint-cli2-action@v17
+        with:
+          globs: "**.md"
+          config: .markdownlint.json
+
+      - uses: reviewdog/action-misspell@v1
+        with:
+          locale: "US"
+          level: error
+          pattern: |
+            *.md
+
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-quiet-mode: yes
+          config-file: .github/workflows/configs/mlc-config.json
+
+      - uses: peter-evans/dockerhub-description@v4
+        if: github.repository == 'qdm12/ddns-updater' && github.event_name == 'push'
+        with:
+          username: qmcgaw
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          repository: qmcgaw/ddns-updater
+          short-description: Container to update DNS records periodically with WebUI for many DNS providers
+          readme-filepath: README.md
+          enable-url-completion: true

.github/workflows/misspell.yml

@@ -1,16 +0,0 @@
-name: Misspells
-on:
-  pull_request:
-    branches: [master]
-  push:
-    branches: [master]
-jobs:
-  misspell:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: reviewdog/action-misspell@master
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          locale: "US"
-          level: error

.github/workflows/security.yml

@@ -1,59 +0,0 @@
-name: Security scan of Docker image
-on:
-  push:
-    branches: [master]
-    paths-ignore:
-      - .github/workflows/buildx-release.yml
-      - .github/workflows/dockerhub-description.yml
-      - .github/workflows/greetings.yml
-      - .github/workflows/labels.yml
-      - .github/workflows/misspell.yml
-      - .github/workflows/security.yml
-      - .dockerignore
-      - .gitignore
-      - docker-compose.yml
-      - LICENSE
-      - README.md
-      - title.svg
-  pull_request:
-    branches: [master]
-    paths-ignore:
-      - .github/workflows/buildx-release.yml
-      - .github/workflows/dockerhub-description.yml
-      - .github/workflows/greetings.yml
-      - .github/workflows/labels.yml
-      - .github/workflows/misspell.yml
-      - .github/workflows/security.yml
-      - .dockerignore
-      - .gitignore
-      - docker-compose.yml
-      - LICENSE
-      - README.md
-      - title.svg
-  schedule:
-    - cron: '0 9 * * *'
-jobs:
-  security-analysis:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Check for scratch
-        id: scratchCheck
-        run: echo ::set-output name=scratch::$(cat Dockerfile | grep 'FROM scratch')
-      - name: Build image
-        if: steps.scratchCheck.outputs.scratch == ''
-        run: docker build -t image .
-      - name: Phonito
-        if: steps.scratchCheck.outputs.scratch == ''
-        uses: phonito/phonito-scanner-action@master
-        with:
-          image: image
-          fail-level: LOW
-          phonito-token: ${{ secrets.PHONITO_TOKEN }}
-      - name: Trivy
-        if: steps.scratchCheck.outputs.scratch == ''
-        uses: homoluctus/gitrivy@v1.0.0
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          image: image

.gitignore

@@ -1,3 +1 @@
-*.exe
-updater
-.vscode
+/data

.golangci.yml

@@ -0,0 +1,95 @@
+linters-settings:
+  misspell:
+    locale: US
+
+issues:
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - containedctx
+        - dupl
+        - goerr113
+    - text: Function `exitHealthchecksio` should pass the context parameter
+      linters:
+        - contextcheck
+    - source: "See https://"
+      linters:
+        - lll
+
+linters:
+  enable:
+    # - cyclop
+    - asasalint
+    - asciicheck
+    - bidichk
+    - bodyclose
+    - containedctx
+    - contextcheck
+    - decorder
+    - dogsled
+    - dupl
+    - dupword
+    - durationcheck
+    - errchkjson
+    - errname
+    - errorlint
+    - execinquery
+    - exhaustive
+    - exportloopref
+    - forcetypeassert
+    - gci
+    - gocheckcompilerdirectives
+    - gochecknoglobals
+    - gochecknoinits
+    - gochecksumtype
+    - gocognit
+    - goconst
+    - gocritic
+    - gocyclo
+    - godot
+    - goerr113
+    - goheader
+    - goimports
+    - gomnd
+    - gomoddirectives
+    - goprintffuncname
+    - gosec
+    - gosmopolitan
+    - grouper
+    - importas
+    - inamedparam
+    - interfacebloat
+    - ireturn
+    - lll
+    - maintidx
+    - makezero
+    - misspell
+    - musttag
+    - nakedret
+    - nestif
+    - nilerr
+    - nilnil
+    - noctx
+    - nolintlint
+    - nosprintfhostport
+    - paralleltest
+    - perfsprint
+    - prealloc
+    - predeclared
+    - promlinter
+    - protogetter
+    - reassign
+    - revive
+    - rowserrcheck
+    - sloglint
+    - sqlclosecheck
+    - tagalign
+    - tenv
+    - thelper
+    - tparallel
+    - unconvert
+    - unparam
+    - usestdlibvars
+    - wastedassign
+    - whitespace
+    - zerologlint

.markdownlint.json

@@ -0,0 +1,8 @@
+{
+  "MD013": false,
+  "MD033": {
+    "allowed_elements": [
+      "img"
+    ]
+  }
+}

.vscode/settings.json

@@ -1,88 +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"
-    ],
-    "go.testTimeout": "600s"
-}

Dockerfile

@@ -1,49 +1,124 @@
-ARG ALPINE_VERSION=3.11
-ARG GO_VERSION=1.13
+ARG BUILDPLATFORM=linux/amd64
+ARG ALPINE_VERSION=3.20
+ARG GO_VERSION=1.22
+ARG XCPUTRANSLATE_VERSION=v0.6.0
+ARG GOLANGCI_LINT_VERSION=v1.56.2
+ARG MOCKGEN_VERSION=v1.6.0
 
-FROM golang:${GO_VERSION}-alpine${ALPINE_VERSION} AS builder
-RUN apk --update add git g++
+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} qmcgaw/binpot:mockgen-${MOCKGEN_VERSION} AS mockgen
+
+FROM --platform=$BUILDPLATFORM golang:${GO_VERSION}-alpine${ALPINE_VERSION} AS base
 WORKDIR /tmp/gobuild
+ENV CGO_ENABLED=0
+# Note: findutils needed to have xargs support `-d` flag for mocks stage.
+RUN apk --update add git g++ findutils
+COPY --from=xcputranslate /xcputranslate /usr/local/bin/xcputranslate
+COPY --from=golangci-lint /bin /go/bin/golangci-lint
+COPY --from=mockgen /bin /go/bin/mockgen
+# Copy repository code and install Go dependencies
 COPY go.mod go.sum ./
-RUN go mod download 2>&1
+RUN go mod download
+COPY pkg/ ./pkg/
+COPY cmd/ ./cmd/
 COPY internal/ ./internal/
-COPY cmd/updater/main.go .
-RUN CGO_ENABLED=0 go test ./...
-RUN CGO_ENABLED=1 go build -a -installsuffix cgo -ldflags="-s -w" -o app
 
-FROM alpine:${ALPINE_VERSION}
-ARG BUILD_DATE
-ARG VCS_REF
-ARG VERSION
+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
+COPY readme/ ./readme/
+COPY README.md ./README.md
+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 mocks
+RUN git init && \
+    git config user.email ci@localhost && \
+    git config user.name ci && \
+    git config core.fileMode false && \
+    git add -A && \
+    git commit -m "snapshot" && \
+    grep -lr -E '^// Code generated by MockGen\. DO NOT EDIT\.$' . | xargs -r -d '\n' rm && \
+    go generate -run "mockgen" ./... && \
+    git diff --exit-code && \
+    rm -rf .git/
+
+FROM --platform=$BUILDPLATFORM base AS build
+RUN mkdir -p /tmp/data && \
+    touch /tmp/isdocker
+ARG VERSION=unknown
+ARG CREATED="an unknown date"
+ARG COMMIT=unknown
+ARG TARGETPLATFORM
+RUN GOARCH="$(xcputranslate translate -targetplatform ${TARGETPLATFORM} -field arch)" \
+    GOARM="$(xcputranslate translate -targetplatform ${TARGETPLATFORM} -field arm)" \
+    go build -trimpath -ldflags="-s -w \
+    -X 'main.version=$VERSION' \
+    -X 'main.date=$CREATED' \
+    -X 'main.commit=$COMMIT' \
+    " -o app cmd/ddns-updater/main.go
+
+FROM scratch
+EXPOSE 8000
+HEALTHCHECK --interval=60s --timeout=5s --start-period=10s --retries=2 CMD ["/updater/ddns-updater", "healthcheck"]
+ARG UID=1000
+ARG GID=1000
+USER ${UID}:${GID}
+WORKDIR /updater
+ENTRYPOINT ["/updater/ddns-updater"]
+COPY --from=build --chown=${UID}:${GID} /tmp/data /updater/data
+COPY --from=build --chown=${UID}:${GID} /tmp/isdocker /updater/isdocker
+ENV \
+    # Core
+    CONFIG= \
+    PERIOD=5m \
+    UPDATE_COOLDOWN_PERIOD=5m \
+    PUBLICIP_FETCHERS=all \
+    PUBLICIP_HTTP_PROVIDERS=all \
+    PUBLICIPV4_HTTP_PROVIDERS=all \
+    PUBLICIPV6_HTTP_PROVIDERS=all \
+    PUBLICIP_DNS_PROVIDERS=all \
+    PUBLICIP_DNS_TIMEOUT=3s \
+    HTTP_TIMEOUT=10s \
+    DATADIR=/updater/data \
+    CONFIG_FILEPATH=/updater/data/config.json \
+    RESOLVER_ADDRESS= \
+    RESOLVER_TIMEOUT=5s \
+    # Web UI
+    SERVER_ENABLED=yes \
+    LISTENING_ADDRESS=:8000 \
+    ROOT_URL=/ \
+    # Backup
+    BACKUP_PERIOD=0 \
+    BACKUP_DIRECTORY=/updater/data \
+    # Other
+    LOG_LEVEL=info \
+    LOG_CALLER=hidden \
+    SHOUTRRR_ADDRESSES= \
+    SHOUTRRR_DEFAULT_TITLE="DDNS Updater" \
+    TZ= \
+    # UMASK left empty so it dynamically defaults to the OS current umask
+    UMASK= \
+    HEALTH_SERVER_ADDRESS=127.0.0.1:9999 \
+    HEALTH_HEALTHCHECKSIO_BASE_URL=https://hc-ping.com \
+    HEALTH_HEALTHCHECKSIO_UUID=
+ARG VERSION=unknown
+ARG CREATED="an unknown date"
+ARG COMMIT=unknown
 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.created=$CREATED \
+    org.opencontainers.image.revision=$COMMIT \
     org.opencontainers.image.url="https://github.com/qdm12/ddns-updater" \
     org.opencontainers.image.documentation="https://github.com/qdm12/ddns-updater" \
     org.opencontainers.image.source="https://github.com/qdm12/ddns-updater" \
     org.opencontainers.image.title="ddns-updater" \
-    org.opencontainers.image.description="Universal DNS updater with WebUI. Works with Namecheap, Cloudflare, GoDaddy, DuckDns, Dreamhost, DNSPod and NoIP"
-RUN apk add --update sqlite ca-certificates && \
-    mkdir /lib64 && ln -s /lib/libc.musl-x86_64.so.1 /lib64/ld-linux-x86-64.so.2 && \
-    rm -rf /var/cache/apk/* && \
-    # Creating empty database file in case nothing is mounted
-    mkdir -p /updater/data && \
-    chown -R 1000 /updater && \
-    chmod 700 /updater/data
-EXPOSE 8000
-HEALTHCHECK --interval=60s --timeout=5s --start-period=10s --retries=2 CMD ["/updater/app", "healthcheck"]
-USER 1000
-ENTRYPOINT ["/updater/app"]
-ENV DELAY=10m \
-    ROOT_URL=/ \
-    LISTENING_PORT=8000 \
-    LOG_ENCODING=console \
-    LOG_LEVEL=info \
-    NODE_ID=0 \
-    HTTP_TIMEOUT=10s \
-    GOTIFY_URL= \
-    GOTIFY_TOKEN=
-COPY --from=builder --chown=1000 /tmp/gobuild/app /updater/app
-COPY --chown=1000 ui/* /updater/ui/
+    org.opencontainers.image.description="Universal DNS updater with WebUI"
+COPY --from=build --chown=${UID}:${GID} /tmp/gobuild/app /updater/ddns-updater

README.md

@@ -1,386 +1,427 @@
-# Lightweight universal DDNS Updater with Docker and web UI
-
-*Light container updating DNS A records periodically for GoDaddy, Namecheap, Cloudflare, Dreamhost, NoIP, DNSPod, Infomaniak, ddnss.de and DuckDNS*
-
-**SQLite migration support will be removed on 1 April 2020, so be sure to update your image before that**
-
-[![DDNS Updater by Quentin McGaw](https://github.com/qdm12/ddns-updater/raw/master/readme/title.png)](https://hub.docker.com/r/qmcgaw/ddns-updater)
-
-[![Build Status](https://travis-ci.org/qdm12/ddns-updater.svg?branch=master)](https://travis-ci.org/qdm12/ddns-updater)
-[![Docker Pulls](https://img.shields.io/docker/pulls/qmcgaw/ddns-updater.svg)](https://hub.docker.com/r/qmcgaw/ddns-updater)
-[![Docker Stars](https://img.shields.io/docker/stars/qmcgaw/ddns-updater.svg)](https://hub.docker.com/r/qmcgaw/ddns-updater)
-[![Image size](https://images.microbadger.com/badges/image/qmcgaw/ddns-updater.svg)](https://microbadger.com/images/qmcgaw/ddns-updater)
-[![Image version](https://images.microbadger.com/badges/version/qmcgaw/ddns-updater.svg)](https://microbadger.com/images/qmcgaw/ddns-updater)
-
-[![Join Slack channel](https://img.shields.io/badge/slack-@qdm12-yellow.svg?logo=slack)](https://join.slack.com/t/qdm12/shared_invite/enQtODMwMDQyMTAxMjY1LTU1YjE1MTVhNTBmNTViNzJiZmQwZWRmMDhhZjEyNjVhZGM4YmIxOTMxOTYzN2U0N2U2YjQ2MDk3YmYxN2NiNTc)
-[![GitHub last commit](https://img.shields.io/github/last-commit/qdm12/ddns-updater.svg)](https://github.com/qdm12/ddns-updater/issues)
-[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/qdm12/ddns-updater.svg)](https://github.com/qdm12/ddns-updater/issues)
-[![GitHub issues](https://img.shields.io/github/issues/qdm12/ddns-updater.svg)](https://github.com/qdm12/ddns-updater/issues)
-
-## Features
-
-- Updates periodically A records for different DNS providers: Namecheap, GoDaddy, Cloudflare, NoIP, Dreamhost, DuckDNS, DNSPod and Infomaniak (ask for more)
-- Web User interface
-
-![Web UI](https://raw.githubusercontent.com/qdm12/ddns-updater/master/readme/webui.png)
-
-- Lightweight based on a Go binary and *Alpine 3.11* with Sqlite and Ca-Certificates packages
-- Persistence with a JSON file *updates.json* to store old IP addresses with change times for each record
-- Docker healthcheck verifying the DNS resolution of your domains
-- Highly configurable
-- Sends notifications to your Android phone, see the [**Gotify**](#Gotify) section (it's free, open source and self hosted 🆒)
-- Compatible with `amd64`, `386`, `arm64` and `arm32v7` (Raspberry Pis) CPU architectures.
-
-## Setup
-
-1. To setup your domains initially, see the [Domain set up](#domain-set-up) section.
-1. Create a directory of your choice, say *data* with a file named **config.json** inside:
-
-    ```sh
-    mkdir data
-    touch data/config.json
-    # Owned by user ID of Docker container (1000)
-    chown -R 1000 data
-    # all access (for creating json database file data/updates.json)
-    chmod 700 data
-    # read access only
-    chmod 400 data/config.json
-    ```
-
-    *(You could change the user ID, for example with `1001`, by running the container with `--user=1001`)*
-
-1. Modify the *data/config.json* file similarly to:
-
-    ```json
-    {
-        "settings": [
-            {
-                "provider": "namecheap",
-                "domain": "example.com",
-                "host": "@",
-                "ip_method": "provider",
-                "delay": 86400,
-                "password": "e5322165c1d74692bfa6d807100c0310"
-            },
-            {
-                "provider": "duckdns",
-                "domain": "example.duckdns.org",
-                "ip_method": "provider",
-                "token": "00000000-0000-0000-0000-000000000000"
-            },
-            {
-                "provider": "godaddy",
-                "domain": "example.org",
-                "host": "subdomain",
-                "ip_method": "duckduckgo",
-                "key": "aaaaaaaaaaaaaaaa",
-                "secret": "aaaaaaaaaaaaaaaa"
-            }
-        ]
-    }
-    ```
-
-    See more information in the [configuration section](#configuration)
-
-1. Use the following command:
-
-    ```bash
-    docker run -d -p 8000:8000/tcp -v "$(pwd)"/data:/updater/data qmcgaw/ddns-updater
-    ```
-
-    You can also use [docker-compose.yml](https://github.com/qdm12/ddns-updater/blob/master/docker-compose.yml) with:
-
-    ```sh
-    docker-compose up -d
-    ```
-
-## Configuration
-
-Start by having the following content in *config.json*:
-
-```json
-{
-    "settings": [
-        {
-            "provider": "",
-            "domain": "",
-            "ip_method": "",
-        },
-        {
-            "provider": "",
-            "domain": "",
-            "ip_method": "",
-        }
-    ]
-}
-```
-
-The following parameters are to be added in *config.json*
-
-For all record update configuration, you need the following:
-
-- `"provider"` is the DNS provider and can be `"godaddy"`, `"namecheap"`, `"duckdns"`, `"dreamhost"`, `"cloudflare"`, `"noip"`, `"dnspod"` or `"ddnss"`
-- `"domain"`
-- `"ip_method"` is the method to obtain your public IP address and can be:
-  - `"provider"` means the public IP is automatically determined by the DNS provider (**only for DuckDNs, Namecheap, Infomaniak and NoIP**), most reliable.
-  - `"opendns"` using [https://diagnostic.opendns.com/myip](https://diagnostic.opendns.com/myip) (reliable)
-  - `"ifconfig"` using [https://ifconfig.io/ip](https://ifconfig.io/ip) (may be rate limited)
-  - `"ipinfo"` using [https://ipinfo.io/ip](https://ipinfo.io/ip) (may be rate limited)
-  - `"ipify"` using [https://api.ipify.org](https://api.ipify.org) (may be rate limited)
-  - `"ipify6"` using [https://api6.ipify.org](https://api.ipify.org) for IPv6 only (may be rate limited)
-  - `"ddnss"` using [https://ddnss.de/meineip.php](https://ddnss.de/meineip.php)
-  - `"ddnss4"` using [https://ip4.ddnss.de/meineip.php](https://ip4.ddnss.de/meineip.php) for IPv4 only
-  - `"ddnss6"` using [https://ip6.ddnss.de/meineip.php](https://ip6.ddnss.de/meineip.php) for IPv6 only
-  - `"cycle"` to cycle between each external methods, in order to avoid being rate limited
-  - You can also specify an HTTPS URL to obtain your public IP address (i.e. `"ip_method": "https://ipinfo.io/ip"`)
-
-You can optionnally add the parameters:
-
-- `"delay"` is the delay in seconds between each update. It defaults to the `DELAY` environment variable value.
-- `"no_dns_lookup"` can be `true` or `false` and allows, if `true`, to prevent the periodic Docker healthcheck from running a DNS lookup on your domain.
-
-For each DNS provider exist some specific parameters you need to add, as described below:
-
-Namecheap:
-
-- `"host"` is your host and can be a subdomain, `"@"` or `"*"` generally
-- `"password"`
-
-Cloudflare:
-
-- `"zone_identifier"`
-- `"identifier"`
-- `"host"` is your host and can be a subdomain, `"@"` or `"*"` generally
-- `"ttl"` integer value for record TTL in seconds (specify 1 for automatic)
-- One of the following:
-    - Email `"email"` and key `"key"`
-    - User service key `"user_service_key"`
-    - API Token `"token"`, configured with DNS edit permissions for your DNS name's zone.
-- *Optionally*, `"proxied"` can be `true` or `false` to use the proxy services of Cloudflare
-
-GoDaddy:
-
-- `"host"` is your host and can be a subdomain, `"@"` or `"*"` generally
-- `"key"`
-- `"secret"`
-
-DuckDNS:
-
-- `"token"`
-
-Dreamhost:
-
-- `"key"`
-
-NoIP:
-
-- `"host"` is your host and can be a subdomain or `"@"`
-- `"username"`
-- `"password"`
-
-DNSPOD:
-
-- `"host"` is your host and can be a subdomain or `"@"`
-- `"token"`
-
-Infomaniak:
-
-- `"user"`
-- `"password"`
-- `"host"` is your host and can be a subdomain or `"@"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records)
-
-DDNSS.de:
-
-- `"user"`
-- `"password"`
-- `"host"` is your host and can be a subdomain or `"@"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records)
-
-### Environment variables
-
-| Environment variable | Default | Description |
-| --- | --- | --- |
-| `DELAY` | `10m` | Default delay between updates, following [this format](https://golang.org/pkg/time/#ParseDuration) |
-| `ROOT_URL` | `/` | URL path to append to all paths to the webUI (i.e. `/ddns` for accessing `https://example.com/ddns` through a proxy) |
-| `LISTENING_PORT` | `8000` | Internal TCP listening port for the web UI |
-| `LOG_ENCODING` | `console` | Format of logging, `json` or `console` |
-| `LOG_LEVEL` | `info` | Level of logging, `info`, `warning` or `error` |
-| `NODE_ID` | `0` | Node ID (for distributed systems), can be any integer |
-| `HTTP_TIMEOUT` | `10s` | Timeout for all HTTP requests |
-| `GOTIFY_URL` |  | (optional) HTTP(s) URL to your Gotify server |
-| `GOTIFY_TOKEN` |  | (optional) Token to access your Gotify server |
-
-### Host firewall
-
-If you have a host firewall in place, this container needs the following ports:
-
-- TCP 443 outbound for outbound HTTPS
-- TCP 80 outbound if you use a local unsecured HTTP connection to your Gotify server
-- UDP 53 outbound for outbound DNS resolution
-- TCP 8000 inbound (or other) for the WebUI
-
-## Domain set up
-
-### Namecheap
-
-[![Namecheap Website](https://github.com/qdm12/ddns-updater/raw/master/readme/namecheap.png)](https://www.namecheap.com)
-
-1. Create a Namecheap account and buy a domain name - *example.com* as an example
-1. Login to Namecheap at [https://www.namecheap.com/myaccount/login.aspx](https://www.namecheap.com/myaccount/login.aspx)
-
-For **each domain name** you want to add, replace *example.com* in the following link with your domain name and go to [https://ap.www.namecheap.com/Domains/DomainControlPanel/**example.com**/advancedns](https://ap.www.namecheap.com/Domains/DomainControlPanel/example.com/advancedns)
-
-1. For each host you want to add (if you don't know, create one record with the host set to `*`):
-    1. In the *HOST RECORDS* section, click on *ADD NEW RECORD*
-
-        ![https://ap.www.namecheap.com/Domains/DomainControlPanel/mealracle.com/advancedns](https://raw.githubusercontent.com/qdm12/ddns-updater/master/readme/namecheap1.png)
-
-    1. Select the following settings and create the *A + Dynamic DNS Record*:
-
-        ![https://ap.www.namecheap.com/Domains/DomainControlPanel/mealracle.com/advancedns](https://raw.githubusercontent.com/qdm12/ddns-updater/master/readme/namecheap2.png)
-
-1. Scroll down and turn on the switch for *DYNAMIC DNS*
-
-    ![https://ap.www.namecheap.com/Domains/DomainControlPanel/mealracle.com/advancedns](https://raw.githubusercontent.com/qdm12/ddns-updater/master/readme/namecheap3.png)
-
-1. The Dynamic DNS Password will appear, which is `0e4512a9c45a4fe88313bcc2234bf547` in this example.
-
-    ![https://ap.www.namecheap.com/Domains/DomainControlPanel/mealracle.com/advancedns](https://raw.githubusercontent.com/qdm12/ddns-updater/master/readme/namecheap4.png)
-
-***
-
-### GoDaddy
-
-[![GoDaddy Website](https://github.com/qdm12/ddns-updater/raw/master/readme/godaddy.png)](https://godaddy.com)
-
-1. Login to [https://developer.godaddy.com/keys](https://developer.godaddy.com/keys/) with your account credentials.
-
-[![GoDaddy Developer Login](https://github.com/qdm12/ddns-updater/raw/master/readme/godaddy1.gif)](https://developer.godaddy.com/keys)
-
-1. Generate a Test key and secret.
-
-[![GoDaddy Developer Test Key](https://github.com/qdm12/ddns-updater/raw/master/readme/godaddy2.gif)](https://developer.godaddy.com/keys)
-
-1. Generate a **Production** key and secret.
-
-[![GoDaddy Developer Production Key](https://github.com/qdm12/ddns-updater/raw/master/readme/godaddy3.gif)](https://developer.godaddy.com/keys)
-
-Obtain the **key** and **secret** of that production key.
-
-In this example, the key is `dLP4WKz5PdkS_GuUDNigHcLQFpw4CWNwAQ5` and the secret is `GuUFdVFj8nJ1M79RtdwmkZ`.
-
-***
-
-### DuckDNS
-
-[![DuckDNS Website](https://github.com/qdm12/ddns-updater/raw/master/readme/duckdns.png)](https://duckdns.org)
-
-*See [duckdns website](https://duckdns.org)*
-
-### Cloudflare
-
-1. Make sure you have `curl` installed
-1. Obtain your API key from Cloudflare website ([see this](https://support.cloudflare.com/hc/en-us/articles/200167836-Where-do-I-find-my-Cloudflare-API-key-))
-1. Obtain your zone identifier for your domain name, from the domain's overview page written as *Zone ID*
-1. Find your **identifier** in the `id` field with
-
-    ```sh
-    ZONEID=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
-    EMAIL=example@example.com
-    APIKEY=aaaaaaaaaaaaaaaaaa
-    curl -X GET "https://api.cloudflare.com/client/v4/zones/$ZONEID/dns_records" \
-        -H "X-Auth-Email: $EMAIL" \
-        -H "X-Auth-Key: $APIKEY"
-    ```
-
-You can now fill in the necessary parameters in *config.json*
-
-Special thanks to @Starttoaster for helping out with the [documentation](https://gist.github.com/Starttoaster/07d568c2a99ad7631dd776688c988326) and testing.
-
-## Gotify
-
-[![Gotify](https://github.com/qdm12/ddns-updater/blob/master/readme/gotify.png?raw=true)](https://gotify.net)
-
-[**Gotify**](https://gotify.net) is a simple server for sending and receiving messages, and it is **free**, **private** and **open source**
-
-- It has an [Android app](https://play.google.com/store/apps/details?id=com.github.gotify) to receive notifications
-- The app does not drain your battery 👍
-- The notification server is self hosted, see [how to set it up with Docker](https://gotify.net/docs/install)
-- The notifications only go through your own server (ideally through HTTPS though)
-
-To set it up with DDNS updater:
-
-1. Go to the Web GUI of Gotify
-1. Login with the admin credentials
-1. Create an app and copy the generated token to the environment variable `GOTIFYTOKEN` (for this container)
-1. Set the `GOTIFYURL` variable to the URL of your Gotify server address (i.e. `http://127.0.0.1:8080` or `https://bla.com/gotify`)
-
-## Testing
-
-- The automated healthcheck verifies all your records are up to date [using DNS lookups](https://github.com/qdm12/ddns-updater/blob/master/internal/healthcheck/healthcheck.go#L15)
-- You can check manually at:
-  - GoDaddy: [https://dcc.godaddy.com/manage/yourdomain.com/dns](https://dcc.godaddy.com/manage/yourdomain.com/dns) (replace yourdomain.com)
-
-    [![GoDaddy DNS management](https://github.com/qdm12/ddns-updater/raw/master/readme/godaddydnsmanagement.png)](https://dcc.godaddy.com/manage/)
-
-    You might want to try to change the IP address to `127.0.0.1` to see if the update actually occurs.
-
-## Development
-
-1. Setup your environment
-
-    <details><summary>Using VSCode and Docker (easier)</summary><p>
-
-    1. Install [Docker](https://docs.docker.com/install/)
-       - On Windows, share a drive with Docker Desktop and have the project on that partition
-       - On OSX, share your project directory with Docker Desktop
-    1. With [Visual Studio Code](https://code.visualstudio.com/download), install the [remote containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
-    1. In Visual Studio Code, press on `F1` and select `Remote-Containers: Open Folder in Container...`
-    1. Your dev environment is ready to go!... and it's running in a container :+1: So you can discard it and update it easily!
-
-    </p></details>
-
-    <details><summary>Locally</summary><p>
-
-    1. Install [Go](https://golang.org/dl/), [Docker](https://www.docker.com/products/docker-desktop) and [Git](https://git-scm.com/downloads)
-    1. Install Go dependencies with
-
-        ```sh
-        go mod download
-        ```
-
-    1. Install [golangci-lint](https://github.com/golangci/golangci-lint#install)
-    1. You might want to use an editor such as [Visual Studio Code](https://code.visualstudio.com/download) with the [Go extension](https://code.visualstudio.com/docs/languages/go). Working settings are already in [.vscode/settings.json](https://github.com/qdm12/ddns-updater/master/.vscode/settings.json).
-
-    </p></details>
-
-1. Commands available:
-
-    ```sh
-    # Build the binary
-    go build cmd/app/main.go
-    # Test the code
-    go test ./...
-    # Lint the code
-    golangci-lint run
-    # Build the Docker image
-    docker build -t qmcgaw/ddns-updater .
-    ```
-
-1. See [Contributing](https://github.com/qdm12/ddns-updater/master/.github/CONTRIBUTING.md) for more information on how to contribute to this repository.
-
-## Used in external projects
-
-- [Starttoaster/docker-traefik](https://github.com/Starttoaster/docker-traefik#home-networks-extra-credit-dynamic-dns)
-
-## TODOs
-
-- [ ] Other types or records
-- [ ] icon.ico for webpage
-- [ ] Record events log
-- [ ] Hot reload of config.json
-- [ ] Unit tests
-- [ ] ReactJS frontend
-    - [ ] Live update of website
-    - [ ] Change settings
+# Lightweight universal DDNS Updater program
+
+Program to keep DNS A and/or AAAA records updated for multiple DNS providers
+
+<img height="200" alt="DDNS Updater logo" src="https://raw.githubusercontent.com/qdm12/ddns-updater/master/readme/ddnsgopher.svg">
+
+[![Build status](https://github.com/qdm12/ddns-updater/actions/workflows/build.yml/badge.svg)](https://github.com/qdm12/ddns-updater/actions/workflows/build.yml)
+
+[![dockeri.co](https://dockeri.co/image/qmcgaw/ddns-updater)](https://hub.docker.com/r/qmcgaw/ddns-updater)
+
+![Last release](https://img.shields.io/github/release/qdm12/ddns-updater?label=Last%20release)
+![Last Docker tag](https://img.shields.io/docker/v/qmcgaw/ddns-updater?sort=semver&label=Last%20Docker%20tag)
+[![Last release size](https://img.shields.io/docker/image-size/qmcgaw/ddns-updater?sort=semver&label=Last%20released%20image)](https://hub.docker.com/r/qmcgaw/ddns-updater/tags?page=1&ordering=last_updated)
+![GitHub last release date](https://img.shields.io/github/release-date/qdm12/ddns-updater?label=Last%20release%20date)
+![Commits since release](https://img.shields.io/github/commits-since/qdm12/ddns-updater/latest?sort=semver)
+
+[![Latest size](https://img.shields.io/docker/image-size/qmcgaw/ddns-updater/latest?label=Latest%20image)](https://hub.docker.com/r/qmcgaw/ddns-updater/tags)
+
+[![GitHub last commit](https://img.shields.io/github/last-commit/qdm12/ddns-updater.svg)](https://github.com/qdm12/ddns-updater/commits/main)
+[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/qdm12/ddns-updater.svg)](https://github.com/qdm12/ddns-updater/graphs/contributors)
+[![GitHub closed PRs](https://img.shields.io/github/issues-pr-closed/qdm12/ddns-updater.svg)](https://github.com/qdm12/ddns-updater/pulls?q=is%3Apr+is%3Aclosed)
+[![GitHub issues](https://img.shields.io/github/issues/qdm12/ddns-updater.svg)](https://github.com/qdm12/ddns-updater/issues)
+[![GitHub closed issues](https://img.shields.io/github/issues-closed/qdm12/ddns-updater.svg)](https://github.com/qdm12/ddns-updater/issues?q=is%3Aissue+is%3Aclosed)
+
+[![Lines of code](https://img.shields.io/tokei/lines/github/qdm12/ddns-updater)](https://github.com/qdm12/ddns-updater)
+![Code size](https://img.shields.io/github/languages/code-size/qdm12/ddns-updater)
+![GitHub repo size](https://img.shields.io/github/repo-size/qdm12/ddns-updater)
+![Go version](https://img.shields.io/github/go-mod/go-version/qdm12/ddns-updater)
+
+[![MIT](https://img.shields.io/github/license/qdm12/ddns-updater)](LICENSE)
+![Visitors count](https://visitor-badge.laobi.icu/badge?page_id=ddns-updater.readme)
+
+## Versioned documentation
+
+This readme and the [docs/](docs/) directory are **versioned** to match the program version:
+
+| Version | Readme link | Docs link |
+| --- | --- | --- |
+| Latest | [README](https://github.com/qdm12/ddns-updater/blob/master/README.md) | [docs/](https://github.com/qdm12/ddns-updater/tree/master/docs) |
+| `v2.8` | [README](https://github.com/qdm12/ddns-updater/blob/v2.8.0/README.md) | [docs/](https://github.com/qdm12/ddns-updater/blob/v2.8.0/docs) |
+| `v2.7` | [README](https://github.com/qdm12/ddns-updater/blob/v2.7.1/README.md) | [docs/](https://github.com/qdm12/ddns-updater/blob/v2.7.1/docs) |
+| `v2.6` | [README](https://github.com/qdm12/ddns-updater/blob/v2.6.1/README.md) | [docs/](https://github.com/qdm12/ddns-updater/blob/v2.6.1/docs) |
+| `v2.5` | [README](https://github.com/qdm12/ddns-updater/blob/v2.5.0/README.md) | [docs/](https://github.com/qdm12/ddns-updater/blob/v2.5.0/docs) |
+
+## Features
+
+- Available as a Docker image [`qmcgaw/ddns-updater`](https://hub.docker.com/r/qmcgaw/ddns-updater) and [`ghcr.io/qdm12/ddns-updater`]((https://github.com/qdm12/ddns-updater/pkgs/container/ddns-updater))
+- Available as [zero-dependency binaries for Linux, Windows and MacOS](https://github.com/qdm12/ddns-updater/releases)
+- 🆕 Available in the AUR as [`ddns-updater`](https://aur.archlinux.org/packages/ddns-updater) - see [#808](https://github.com/qdm12/ddns-updater/discussions/808)
+- Updates periodically A records for different DNS providers:
+  - Aliyun
+  - AllInkl
+  - Changeip
+  - Cloudflare
+  - DD24
+  - DDNSS.de
+  - deSEC
+  - DigitalOcean
+  - DonDominio
+  - DNSOMatic
+  - DNSPod
+  - Dreamhost
+  - DuckDNS
+  - DynDNS
+  - Dynu
+  - EasyDNS
+  - FreeDNS
+  - Gandi
+  - GCP
+  - GoDaddy
+  - GoIP.de
+  - He.net
+  - Hetzner
+  - Infomaniak
+  - INWX
+  - Ionos
+  - Linode
+  - LuaDNS
+  - Name.com
+  - Namecheap
+  - Netcup
+  - NoIP
+  - Now-DNS
+  - Njalla
+  - OpenDNS
+  - OVH
+  - Porkbun
+  - Route53
+  - Selfhost.de
+  - Servercow.de
+  - Spdyn
+  - Strato.de
+  - Variomedia.de
+  - Zoneedit
+  - **Want more?** [Create an issue for it](https://github.com/qdm12/ddns-updater/issues/new/choose)!
+- Web user interface (Desktop)
+
+    ![Web UI](readme/webui-desktop.gif)
+
+- Web user interface (Mobile)
+
+    ![Mobile Web UI](readme/webui-mobile.png)
+
+- Send notifications with [**Shoutrrr**](https://containrrr.dev/shoutrrr/v0.8/services/overview/) using `SHOUTRRR_ADDRESSES`
+- Container (Docker/K8s) specific features:
+  - Lightweight 12MB Docker image based on the Scratch Docker image
+  - Docker healthcheck verifying the DNS resolution of your domains
+  - Images compatible with `amd64`, `386`, `arm64`, `armv7`, `armv6`, `s390x`, `ppc64le`, `riscv64` CPU architectures
+- Persistence with a JSON file *updates.json* to store old IP addresses with change times for each record
+
+## Setup
+
+### Binary programs
+
+1. Download the pre-built program for your platform from the assets of a release in the [releases page](https://github.com/qdm12/ddns-updater/releases). You can alternatively download, build and install the latest version of the program by installing [Go](https://golang.org/doc/install) and then run `go install github.com/qdm12/ddns-updater/cmd/ddns-updater@latest`.
+1. For Linux and MacOS, make the program executable with `chmod +x ddns-updater`.
+1. In the directory where the program is saved, create a directory `data`.
+1. Write a JSON configuration in `data/config.json`, for example:
+
+    ```json
+    {
+        "settings": [
+            {
+                "provider": "namecheap",
+                "domain": "sub.example.com",
+                "password": "e5322165c1d74692bfa6d807100c0310"
+            }
+        ]
+    }
+    ```
+
+    You can find more information in the [configuration section](#configuration) to customize it.
+1. Run the program with `./ddns-updater` (`./ddns-updater.exe` on Windows) or by double-clicking on it.
+1. The following is **optional**.
+    - You can customize the program behavior using either [environment variables](#environment-variables) or flags. For flags, there is a flag corresponding to each environment variable, where it's all lowercase and underscores are replaced with dashes. For example the environment variable `LOG_LEVEL` translates into `--log-level`.
+
+### Container
+
+[➡️ Qnap guide by @Araminta](https://github.com/qdm12/ddns-updater/issues/708)
+
+1. Create a directory, for example, *data* which is:
+    - owned by user id `1000`, which is the built-in user ID of the ddns-updater container
+    - has user read+write+execute permissions
+
+    ```sh
+    mkdir data
+    chown 1000 data
+    chmod u+r+w+x data
+    ```
+
+    If you want to use another user ID, [build the image yourself](#build-the-image) with `--build-arg UID=<your-uid>`. You could also just run the container as root with `--user="0"` but this is not advised security wise.
+
+1. Similarly, create a *data/config.json* file which is:
+    - owned by user id `1000`
+    - has user read permissions
+
+    ```sh
+    touch data/config.json
+    chmod u+r data/config.json
+    ```
+
+1. Edit *data/config.json*, for example:
+
+    ```json
+    {
+        "settings": [
+            {
+                "provider": "namecheap",
+                "domain": "sub.example.com",
+                "password": "e5322165c1d74692bfa6d807100c0310"
+            }
+        ]
+    }
+    ```
+
+    You can find more information in the [configuration section](#configuration) to customize it.
+
+1. Run the container with
+
+    ```sh
+    docker run -d -p 8000:8000/tcp -v "$(pwd)"/data:/updater/data qmcgaw/ddns-updater
+    ```
+
+1. The following is **optional**.
+    - You can customize the program behavior using [environment variables](#environment-variables)
+    - You can use [docker-compose.yml](docker-compose.yml) with `docker-compose up -d`
+    - **Kubernetes**: check out the [k8s directory](k8s) for an installation guide and examples.
+    - Other [Docker image tags are available](https://hub.docker.com/repository/docker/qmcgaw/ddns-updater/tags)
+    - You can update the image with `docker pull qmcgaw/ddns-updater`
+    - You can set your JSON configuration as a single environment variable line (i.e. `{"settings": [{"provider": "namecheap", ...}]}`), which takes precedence over config.json. Note however that if you don't bind mount the `/updater/data` directory, there won't be a persistent database file `/updater/updates.json` but it will still work.
+
+## Configuration
+
+Start by having the following content in *config.json*, or in your `CONFIG` environment variable:
+
+```json
+{
+    "settings": [
+        {
+            "provider": "",
+        },
+        {
+            "provider": "",
+        }
+    ]
+}
+```
+
+For each setting, you need to fill in parameters.
+Check the documentation for your DNS provider:
+
+- [Aliyun](docs/aliyun.md)
+- [Allinkl](docs/allinkl.md)
+- [ChangeIP](docs/changeip.md)
+- [Cloudflare](docs/cloudflare.md)
+- [Custom](docs/custom.md)
+- [DDNSS.de](docs/ddnss.de.md)
+- [deSEC](docs/desec.md)
+- [DigitalOcean](docs/digitalocean.md)
+- [DD24](docs/dd24.md)
+- [DonDominio](docs/dondominio.md)
+- [DNSOMatic](docs/dnsomatic.md)
+- [DNSPod](docs/dnspod.md)
+- [Dreamhost](docs/dreamhost.md)
+- [DuckDNS](docs/duckdns.md)
+- [DynDNS](docs/dyndns.md)
+- [Dynu](docs/dynu.md)
+- [DynV6](docs/dynv6.md)
+- [EasyDNS](docs/easydns.md)
+- [FreeDNS](docs/freedns.md)
+- [Gandi](docs/gandi.md)
+- [GCP](docs/gcp.md)
+- [GoDaddy](docs/godaddy.md)
+- [GoIP.de](docs/goip.md)
+- [He.net](docs/he.net.md)
+- [Infomaniak](docs/infomaniak.md)
+- [INWX](docs/inwx.md)
+- [Ionos](docs/ionos.md)
+- [Linode](docs/linode.md)
+- [LuaDNS](docs/luadns.md)
+- [Name.com](docs/name.com.md)
+- [Namecheap](docs/namecheap.md)
+- [Netcup](docs/netcup.md)
+- [NoIP](docs/noip.md)
+- [Now-DNS](docs/nowdns.md)
+- [Njalla](docs/njalla.md)
+- [OpenDNS](docs/opendns.md)
+- [OVH](docs/ovh.md)
+- [Porkbun](docs/porkbun.md)
+- [Selfhost.de](docs/selfhost.de.md)
+- [Servercow.de](docs/servercow.md)
+- [Spdyn](docs/spdyn.md)
+- [Strato.de](docs/strato.md)
+- [Variomedia.de](docs/variomedia.md)
+- [Zoneedit](docs/zoneedit.md)
+
+Note that:
+
+- you can specify multiple owners/hosts for the same domain using a comma separated list. For example with `"domain": "example.com,sub.example.com,sub2.example.com",`.
+
+### Environment variables
+
+🆕 There are now flags equivalent for each variable below, for example `--log-level`.
+
+| Environment variable | Default | Description |
+| --- | --- | --- |
+| `CONFIG` | | One line JSON object containing the entire config (takes precedence over config.json file) if specified |
+| `PERIOD` | `5m` | Default period of IP address check, following [this format](https://golang.org/pkg/time/#ParseDuration) |
+| `PUBLICIP_FETCHERS` | `all` | Comma separated fetcher types to obtain the public IP address from `http` and `dns` |
+| `PUBLICIP_HTTP_PROVIDERS` | `all` | Comma separated providers to obtain the public IP address (ipv4 or ipv6). See the [Public IP section](#public-ip) |
+| `PUBLICIPV4_HTTP_PROVIDERS` | `all` | Comma separated providers to obtain the public IPv4 address only. See the [Public IP section](#public-ip) |
+| `PUBLICIPV6_HTTP_PROVIDERS` | `all` | Comma separated providers to obtain the public IPv6 address only. See the [Public IP section](#public-ip) |
+| `PUBLICIP_DNS_PROVIDERS` | `all` | Comma separated providers to obtain the public IP address (IPv4 and/or IPv6). See the [Public IP section](#public-ip) |
+| `PUBLICIP_DNS_TIMEOUT` | `3s` | Public IP DNS query timeout |
+| `UPDATE_COOLDOWN_PERIOD` | `5m` | Duration to cooldown between updates for each record. This is useful to avoid being rate limited or banned. |
+| `HTTP_TIMEOUT` | `10s` | Timeout for all HTTP requests |
+| `SERVER_ENABLED` | `yes` | Enable the web server and web UI |
+| `LISTENING_ADDRESS` | `:8000` | Internal TCP listening port for the web UI |
+| `ROOT_URL` | `/` | URL path to append to all paths to the webUI (i.e. `/ddns` for accessing `https://example.com/ddns` through a proxy) |
+| `HEALTH_SERVER_ADDRESS` | `127.0.0.1:9999` | Health server listening address |
+| `HEALTH_HEALTHCHECKSIO_BASE_URL` | `https://hc-ping.com` | Base URL for the [healthchecks.io](https://healthchecks.io) server |
+| `HEALTH_HEALTHCHECKSIO_UUID` | | UUID to idenfity with the [healthchecks.io](https://healthchecks.io) server |
+| `DATADIR` | `/updater/data` | Directory to read and write data files from internally |
+| `CONFIG_FILEPATH` | `/updater/data/config.json` | Path to the JSON configuration file |
+| `BACKUP_PERIOD` | `0` | Set to a period (i.e. `72h15m`) to enable zip backups of data/config.json and data/updates.json in a zip file |
+| `BACKUP_DIRECTORY` | `/updater/data` | Directory to write backup zip files to if `BACKUP_PERIOD` is not `0`. |
+| `RESOLVER_ADDRESS` | Your network DNS | A plaintext DNS address to use to resolve your domain names defined in your settings only. For example it can be `1.1.1.1:53`. This is useful for split dns, see [#389](https://github.com/qdm12/ddns-updater/issues/389) |
+| `LOG_LEVEL` | `info` | Level of logging, `debug`, `info`, `warning` or `error` |
+| `LOG_CALLER` | `hidden` | Show caller per log line, `hidden` or `short` |
+| `SHOUTRRR_ADDRESSES` |  | (optional) Comma separated list of [Shoutrrr addresses](https://containrrr.dev/shoutrrr/v0.8/services/overview/) (notification services) |
+| `SHOUTRRR_DEFAULT_TITLE` | `DDNS Updater` | Default title for Shoutrrr notifications |
+| `TZ` | | Timezone to have accurate times, i.e. `America/Montreal` |
+| `UMASK` | System current umask | Umask to set for the program in octal, i.e. `0022` |
+
+#### Public IP
+
+By default, all public IP fetching types are used and cycled (over DNS and over HTTPs).
+
+On top of that, for each fetching method, all echo services available are cycled on each request.
+
+This allows you not to be blocked for making too many requests.
+
+You can otherwise customize it with the following:
+
+- `PUBLICIP_HTTP_PROVIDERS` gets your public IPv4 or IPv6 address. It can be one or more of the following:
+  - `ipify` using [https://api64.ipify.org](https://api64.ipify.org)
+  - `ifconfig` using [https://ifconfig.io/ip](https://ifconfig.io/ip)
+  - `ipinfo` using [https://ipinfo.io/ip](https://ipinfo.io/ip)
+  - `spdyn` using [https://checkip.spdyn.de](https://checkip.spdyn.de/)
+  - `ipleak` using [https://ipleak.net/json](https://ipleak.net/json)
+  - `icanhazip` using [https://icanhazip.com](https://icanhazip.com)
+  - `ident` using [https://ident.me](https://ident.me)
+  - `nnev` using [https://ip.nnev.de](https://ip.nnev.de)
+  - `wtfismyip` using [https://wtfismyip.com/text](https://wtfismyip.com/text)
+  - `seeip` using [https://api.seeip.org](https://api.seeip.org)
+  - `changeip` using [https://ip.changeip.com](https://ip.changeip.com)
+  - You can also specify an HTTPS URL with prefix `url:` for example `url:https://ipinfo.io/ip`
+- `PUBLICIPV4_HTTP_PROVIDERS` gets your public IPv4 address only. It can be one or more of the following:
+  - `ipleak` using [https://ipv4.ipleak.net/json](https://ipv4.ipleak.net/json)
+  - `ipify` using [https://api.ipify.org](https://api.ipify.org)
+  - `icanhazip` using [https://ipv4.icanhazip.com](https://ipv4.icanhazip.com)
+  - `ident` using [https://v4.ident.me](https://v4.ident.me)
+  - `nnev` using [https://ip4.nnev.de](https://ip4.nnev.de)
+  - `wtfismyip` using [https://ipv4.wtfismyip.com/text](https://ipv4.wtfismyip.com/text)
+  - `seeip` using [https://ipv4.seeip.org](https://ipv4.seeip.org)
+  - You can also specify an HTTPS URL with prefix `url:` for example `url:https://ipinfo.io/ip`
+- `PUBLICIPV6_HTTP_PROVIDERS` gets your public IPv6 address only. It can be one or more of the following:
+  - `ipleak` using [https://ipv6.ipleak.net/json](https://ipv6.ipleak.net/json)
+  - `ipify` using [https://api6.ipify.org](https://api6.ipify.org)
+  - `icanhazip` using [https://ipv6.icanhazip.com](https://ipv6.icanhazip.com)
+  - `ident` using [https://v6.ident.me](https://v6.ident.me)
+  - `nnev` using [https://ip6.nnev.de](https://ip6.nnev.de)
+  - `wtfismyip` using [https://ipv6.wtfismyip.com/text](https://ipv6.wtfismyip.com/text)
+  - `seeip` using [https://ipv6.seeip.org](https://ipv6.seeip.org)
+  - You can also specify an HTTPS URL with prefix `url:` for example `url:https://ipinfo.io/ip`
+- `PUBLICIP_DNS_PROVIDERS` gets your public IPv4 address only or IPv6 address only or one of them (see #136). It can be one or more of the following:
+  - `cloudflare`
+  - `opendns`
+
+### Host firewall
+
+If you have a host firewall in place, this container needs the following ports:
+
+- TCP 443 outbound for outbound HTTPS
+- UDP 53 outbound for outbound DNS resolution
+- TCP 8000 inbound (or other) for the WebUI
+
+## Architecture
+
+At program start and every period (5 minutes by default):
+
+1. Fetch your public IP address
+1. For each record:
+    1. DNS resolve it to obtain its current IP address(es)
+        - If the resolution fails, update the record with your public IP address by calling the DNS provider API and finish
+    1. Check if your public IP address is within the resolved IP addresses
+        - Yes: skip the update
+        - No: update the record with your public IP address by calling the DNS provider API
+
+💡 We do DNS resolution every period so it detects a change made to the record manually, for example on the DNS provider web UI
+💡 As DNS resolutions are essentially free and without rate limiting, these are great to avoid getting banned for too many requests.
+
+### Special case: Cloudflare
+
+For Cloudflare records with the `proxied` option, the following is done.
+
+At program start and every period (5 minutes by default), for each record:
+
+1. Fetch your public IP address
+1. For each record:
+    1. Check the last IP address (persisted in `updates.json`) for that record
+        - If it doesn't exist, update the record with your public IP address by calling the DNS provider API and finish
+    1. Check if your public IP address matches the last IP address you updated the record with
+        - Yes: skip the update
+        - No: update the record with your public IP address by calling the DNS provider API
+
+This is the only way as doing a DNS resolution on the record will give the IP address of a Cloudflare server instead of your server.
+
+⚠️ This has the disadvantage that if the record is changed manually, the program will not detect it.
+We could do an API call to get the record IP address every period, but that would get you banned especially with a low period duration.
+
+## Testing
+
+- The automated healthcheck verifies all your records are up to date [using DNS lookups](internal/health/check.go#L42)
+- You can also manually check, by:
+    1. Going to your DNS management webpage
+    1. Setting your record to `127.0.0.1`
+    1. Run the container
+    1. Refresh the DNS management webpage and verify the update happened
+
+## Build the image
+
+You can build the image yourself with:
+
+```sh
+docker build -t qmcgaw/ddns-updater https://github.com/qdm12/ddns-updater.git
+```
+
+You can use optional build arguments with `--build-arg KEY=VALUE` from the table below:
+
+| Build argument | Default | Description |
+| --- | --- | --- |
+| `UID` | `1000` | User ID running the container |
+| `GID` | `1000` | User group ID running the container |
+| `VERSION` | `unknown` | Version of the program and Docker image |
+| `CREATED` | `an unknown date` | Build date of the program and Docker image |
+| `COMMIT` | `unknown` | Commit hash of the program and Docker image |
+
+## Development and contributing
+
+- [Contribute with code](.github/CONTRIBUTING.md)
+- [Github workflows to know what's building](https://github.com/qdm12/ddns-updater/actions)
+- [List of issues and feature requests](https://github.com/qdm12/ddns-updater/issues)
+
+## License
+
+This repository is under an [MIT license](LICENSE)
+
+## Used in external projects
+
+- [Starttoaster/docker-traefik](https://github.com/Starttoaster/docker-traefik#home-networks-extra-credit-dynamic-dns)
+
+## Support
+
+Sponsor me on [Github](https://github.com/sponsors/qdm12) or donate to [paypal.me/qmcgaw](https://www.paypal.me/qmcgaw)
+
+Many thanks to J. Famiglietti for supporting me financially 🥇👍

cmd/ddns-updater/main.go

@@ -0,0 +1,374 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"os"
+	"os/signal"
+	"strconv"
+	"syscall"
+	"time"
+	_ "time/tzdata"
+
+	_ "github.com/breml/rootcerts"
+	"github.com/qdm12/ddns-updater/internal/backup"
+	"github.com/qdm12/ddns-updater/internal/config"
+	"github.com/qdm12/ddns-updater/internal/data"
+	"github.com/qdm12/ddns-updater/internal/health"
+	"github.com/qdm12/ddns-updater/internal/healthchecksio"
+	"github.com/qdm12/ddns-updater/internal/models"
+	"github.com/qdm12/ddns-updater/internal/noop"
+	jsonparams "github.com/qdm12/ddns-updater/internal/params"
+	persistence "github.com/qdm12/ddns-updater/internal/persistence/json"
+	"github.com/qdm12/ddns-updater/internal/provider"
+	recordslib "github.com/qdm12/ddns-updater/internal/records"
+	"github.com/qdm12/ddns-updater/internal/resolver"
+	"github.com/qdm12/ddns-updater/internal/server"
+	"github.com/qdm12/ddns-updater/internal/shoutrrr"
+	"github.com/qdm12/ddns-updater/internal/system"
+	"github.com/qdm12/ddns-updater/internal/update"
+	"github.com/qdm12/ddns-updater/pkg/publicip"
+	"github.com/qdm12/goservices"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosplash"
+	"github.com/qdm12/log"
+)
+
+//nolint:gochecknoglobals
+var (
+	version = "unknown"
+	commit  = "unknown"
+	date    = "an unknown date"
+)
+
+func main() {
+	buildInfo := models.BuildInformation{
+		Version: version,
+		Commit:  commit,
+		Created: date,
+	}
+	logger := log.New()
+
+	reader := reader.New(reader.Settings{
+		HandleDeprecatedKey: func(source, oldKey, newKey string) {
+			logger.Warnf("%q key %s is deprecated, please use %q instead",
+				source, oldKey, newKey)
+		},
+	})
+
+	ctx := context.Background()
+	ctx, stop := signal.NotifyContext(ctx, syscall.SIGINT, syscall.SIGTERM, os.Interrupt)
+	ctx, cancel := context.WithCancel(ctx)
+
+	errorCh := make(chan error)
+	go func() {
+		errorCh <- _main(ctx, reader, os.Args, logger, buildInfo, time.Now)
+	}()
+
+	select {
+	case <-ctx.Done():
+		stop()
+		logger.Warn("Caught OS signal, shutting down")
+	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 err := <-errorCh:
+		if !timer.Stop() {
+			<-timer.C
+		}
+		if err != nil {
+			logger.Error(err.Error())
+		}
+		logger.Info("Shutdown successful")
+	case <-timer.C:
+		logger.Warn("Shutdown timed out")
+	}
+
+	os.Exit(1)
+}
+
+func _main(ctx context.Context, reader *reader.Reader, args []string, logger log.LoggerInterface,
+	buildInfo models.BuildInformation, timeNow func() time.Time) (err error) {
+	if len(args) > 1 {
+		switch args[1] {
+		case "version", "-version", "--version":
+			fmt.Println(buildInfo.VersionString())
+			return nil
+		case "healthcheck":
+			// Running the program in a separate instance through the Docker
+			// built-in healthcheck, in an ephemeral fashion to query the
+			// long running instance of the program about its status
+
+			var healthSettings config.Health
+			healthSettings.Read(reader)
+			healthSettings.SetDefaults()
+			err = healthSettings.Validate()
+			if err != nil {
+				return fmt.Errorf("health settings: %w", err)
+			}
+
+			client := health.NewClient()
+			return client.Query(ctx, *healthSettings.ServerAddress)
+		}
+	}
+
+	printSplash(buildInfo)
+
+	config, err := readConfig(reader, logger)
+	if err != nil {
+		return err
+	}
+
+	if *config.Paths.Umask > 0 {
+		system.SetUmask(*config.Paths.Umask)
+	}
+
+	shoutrrrSettings := shoutrrr.Settings{
+		Addresses:    config.Shoutrrr.Addresses,
+		DefaultTitle: config.Shoutrrr.DefaultTitle,
+		Logger:       logger.New(log.SetComponent("shoutrrr")),
+	}
+	shoutrrrClient, err := shoutrrr.New(shoutrrrSettings)
+	if err != nil {
+		return fmt.Errorf("setting up Shoutrrr: %w", err)
+	}
+
+	persistentDB, err := persistence.NewDatabase(*config.Paths.DataDir)
+	if err != nil {
+		shoutrrrClient.Notify(err.Error())
+		return err
+	}
+
+	jsonReader := jsonparams.NewReader(logger)
+	providers, warnings, err := jsonReader.JSONProviders(*config.Paths.Config)
+	for _, w := range warnings {
+		logger.Warn(w)
+		shoutrrrClient.Notify(w)
+	}
+	if err != nil {
+		shoutrrrClient.Notify(err.Error())
+		return err
+	}
+
+	logProvidersCount(len(providers), logger)
+
+	client := &http.Client{Timeout: config.Client.Timeout}
+	defer client.CloseIdleConnections()
+
+	err = health.CheckHTTP(ctx, client)
+	if err != nil {
+		logger.Warn(err.Error())
+	}
+
+	records, err := readRecords(providers, persistentDB, logger, shoutrrrClient)
+	if err != nil {
+		return fmt.Errorf("reading records: %w", err)
+	}
+
+	db := data.NewDatabase(records, persistentDB)
+
+	httpSettings := publicip.HTTPSettings{
+		Enabled: *config.PubIP.HTTPEnabled,
+		Client:  client,
+		Options: config.PubIP.ToHTTPOptions(),
+	}
+	dnsSettings := publicip.DNSSettings{
+		Enabled: *config.PubIP.DNSEnabled,
+		Options: config.PubIP.ToDNSPOptions(),
+	}
+
+	ipGetter, err := publicip.NewFetcher(dnsSettings, httpSettings)
+	if err != nil {
+		return err
+	}
+
+	resolverSettings := resolver.Settings{
+		Address: config.Resolver.Address,
+		Timeout: config.Resolver.Timeout,
+	}
+	resolver, err := resolver.New(resolverSettings)
+	if err != nil {
+		return fmt.Errorf("creating resolver: %w", err)
+	}
+
+	hioClient := healthchecksio.New(client, config.Health.HealthchecksioBaseURL,
+		*config.Health.HealthchecksioUUID)
+
+	updater := update.NewUpdater(db, client, shoutrrrClient, logger, timeNow)
+	updaterService := update.NewService(db, updater, ipGetter, config.Update.Period,
+		config.Update.Cooldown, logger, resolver, timeNow, hioClient)
+
+	healthServer, err := createHealthServer(db, resolver, logger, *config.Health.ServerAddress)
+	if err != nil {
+		return fmt.Errorf("creating health server: %w", err)
+	}
+
+	server, err := createServer(ctx, config.Server, logger, db, updaterService)
+	if err != nil {
+		return fmt.Errorf("creating server: %w", err)
+	}
+
+	var backupService goservices.Service
+	backupLogger := logger.New(log.SetComponent("backup"))
+	backupService = backup.New(*config.Backup.Period, *config.Paths.DataDir,
+		*config.Backup.Directory, backupLogger)
+	backupService, err = goservices.NewRestarter(goservices.RestarterSettings{Service: backupService})
+	if err != nil {
+		return fmt.Errorf("creating backup restarter: %w", err)
+	}
+
+	servicesSequence, err := goservices.NewSequence(goservices.SequenceSettings{
+		ServicesStart: []goservices.Service{db, updaterService, healthServer, server, backupService},
+		ServicesStop:  []goservices.Service{server, healthServer, updaterService, backupService, db},
+	})
+	if err != nil {
+		return fmt.Errorf("creating services sequence: %w", err)
+	}
+
+	runError, startErr := servicesSequence.Start(ctx)
+	if startErr != nil {
+		return fmt.Errorf("starting services: %w", startErr)
+	}
+
+	// note: errors are logged within the goroutine,
+	// no need to collect the resulting errors.
+	go updaterService.ForceUpdate(ctx)
+
+	shoutrrrClient.Notify("Launched with " + strconv.Itoa(len(records)) + " records to watch")
+
+	select {
+	case <-ctx.Done():
+	case err = <-runError:
+		exitHealthchecksio(hioClient, logger, healthchecksio.Exit1)
+		shoutrrrClient.Notify(err.Error())
+		return fmt.Errorf("exiting due to critical error: %w", err)
+	}
+
+	err = servicesSequence.Stop()
+	if err != nil {
+		exitHealthchecksio(hioClient, logger, healthchecksio.Exit1)
+		shoutrrrClient.Notify(err.Error())
+		return fmt.Errorf("stopping failed: %w", err)
+	}
+
+	exitHealthchecksio(hioClient, logger, healthchecksio.Exit0)
+	return nil
+}
+
+func printSplash(buildInfo models.BuildInformation) {
+	announcementExp, err := time.Parse(time.RFC3339, "2024-10-15T00:00:00Z")
+	if err != nil {
+		panic(err)
+	}
+	splashSettings := gosplash.Settings{
+		User:         "qdm12",
+		Repository:   "ddns-updater",
+		Emails:       []string{"quentin.mcgaw@gmail.com"},
+		Version:      buildInfo.Version,
+		Commit:       buildInfo.Commit,
+		Created:      buildInfo.Created,
+		Announcement: "Public IP http provider GOOGLE is no longer working",
+		AnnounceExp:  announcementExp,
+		// Sponsor information
+		PaypalUser:    "qmcgaw",
+		GithubSponsor: "qdm12",
+	}
+	for _, line := range gosplash.MakeLines(splashSettings) {
+		fmt.Println(line)
+	}
+}
+
+func readConfig(reader *reader.Reader, logger log.LoggerInterface) (
+	config config.Config, err error) {
+	err = config.Read(reader, logger)
+	if err != nil {
+		return config, fmt.Errorf("reading settings: %w", err)
+	}
+	config.SetDefaults()
+	err = config.Validate()
+	if err != nil {
+		return config, fmt.Errorf("settings validation: %w", err)
+	}
+
+	logger.Patch(config.Logger.ToOptions()...)
+	logger.Info(config.String())
+
+	return config, nil
+}
+
+func logProvidersCount(providersCount int, logger log.LeveledLogger) {
+	switch providersCount {
+	case 0:
+		logger.Warn("Found no setting to update record")
+	case 1:
+		logger.Info("Found single setting to update record")
+	default:
+		logger.Info("Found " + strconv.Itoa(providersCount) + " settings to update records")
+	}
+}
+
+func readRecords(providers []provider.Provider, persistentDB *persistence.Database,
+	logger log.LoggerInterface, shoutrrrClient *shoutrrr.Client) (
+	records []recordslib.Record, err error) {
+	records = make([]recordslib.Record, len(providers))
+	for i, provider := range providers {
+		logger.Info("Reading history from database: domain " +
+			provider.Domain() + " owner " + provider.Owner() +
+			" " + provider.IPVersion().String())
+		events, err := persistentDB.GetEvents(provider.Domain(),
+			provider.Owner(), provider.IPVersion())
+		if err != nil {
+			shoutrrrClient.Notify(err.Error())
+			return nil, err
+		}
+		records[i] = recordslib.New(provider, events)
+	}
+	return records, nil
+}
+
+func exitHealthchecksio(hioClient *healthchecksio.Client,
+	logger log.LoggerInterface, state healthchecksio.State) {
+	const timeout = 3 * time.Second
+	ctx, cancel := context.WithTimeout(context.Background(), timeout)
+	defer cancel()
+	err := hioClient.Ping(ctx, state)
+	if err != nil {
+		logger.Error(err.Error())
+	}
+}
+
+//nolint:ireturn
+func createHealthServer(db health.AllSelecter, resolver health.LookupIPer,
+	logger log.LoggerInterface, serverAddress string) (
+	healthServer goservices.Service, err error) {
+	if !health.IsDocker() {
+		return noop.New("healthcheck server"), nil
+	}
+	isHealthy := health.MakeIsHealthy(db, resolver)
+	healthLogger := logger.New(log.SetComponent("healthcheck server"))
+	return health.NewServer(serverAddress, healthLogger, isHealthy)
+}
+
+//nolint:ireturn
+func createServer(ctx context.Context, config config.Server,
+	logger log.LoggerInterface, db server.Database,
+	updaterService server.UpdateForcer) (
+	service goservices.Service, err error) {
+	if !*config.Enabled {
+		return noop.New("server"), nil
+	}
+	serverLogger := logger.New(log.SetComponent("http server"))
+	return server.New(ctx, config.ListeningAddress, config.RootURL,
+		db, serverLogger, updaterService)
+}

cmd/updater/main.go

@@ -1,151 +0,0 @@
-package main
-
-import (
-	"context"
-	"net"
-
-	_ "github.com/mattn/go-sqlite3"
-
-	"fmt"
-	"net/http"
-	"os"
-	"time"
-
-	"github.com/qdm12/golibs/admin"
-	"github.com/qdm12/golibs/files"
-	libhealthcheck "github.com/qdm12/golibs/healthcheck"
-	"github.com/qdm12/golibs/logging"
-	"github.com/qdm12/golibs/network"
-	libparams "github.com/qdm12/golibs/params"
-	"github.com/qdm12/golibs/server"
-	"github.com/qdm12/golibs/signals"
-
-	"github.com/qdm12/ddns-updater/internal/data"
-	"github.com/qdm12/ddns-updater/internal/env"
-	"github.com/qdm12/ddns-updater/internal/handlers"
-	"github.com/qdm12/ddns-updater/internal/healthcheck"
-	"github.com/qdm12/ddns-updater/internal/models"
-	"github.com/qdm12/ddns-updater/internal/params"
-	"github.com/qdm12/ddns-updater/internal/persistence"
-	"github.com/qdm12/ddns-updater/internal/splash"
-	"github.com/qdm12/ddns-updater/internal/trigger"
-	"github.com/qdm12/ddns-updater/internal/update"
-)
-
-func main() {
-	logger, err := logging.NewLogger(logging.ConsoleEncoding, logging.InfoLevel, -1)
-	if err != nil {
-		panic(err)
-	}
-	paramsReader := params.NewParamsReader(logger)
-	encoding, level, nodeID, err := paramsReader.GetLoggerConfig()
-	if err != nil {
-		logger.Error(err)
-	} else {
-		logger, err = logging.NewLogger(encoding, level, nodeID)
-	}
-	if libhealthcheck.Mode(os.Args) {
-		// Running the program in a separate instance through the Docker
-		// built-in healthcheck, in an ephemeral fashion to query the
-		// long running instance of the program about its status
-		if err := libhealthcheck.Query(); err != nil {
-			logger.Error(err)
-			os.Exit(1)
-		}
-		os.Exit(0)
-	}
-	fmt.Println(splash.Splash(paramsReader))
-	e := env.NewEnv(logger)
-	gotifyURL, err := paramsReader.GetGotifyURL()
-	e.FatalOnError(err)
-	if gotifyURL != nil {
-		gotifyToken, err := paramsReader.GetGotifyToken()
-		e.FatalOnError(err)
-		e.SetGotify(admin.NewGotify(*gotifyURL, gotifyToken, &http.Client{Timeout: time.Second}))
-	}
-	listeningPort, warning, err := paramsReader.GetListeningPort()
-	e.FatalOnError(err)
-	if len(warning) > 0 {
-		logger.Warn(warning)
-	}
-	rootURL, err := paramsReader.GetRootURL()
-	e.FatalOnError(err)
-	defaultPeriod, err := paramsReader.GetDelay(libparams.Default("10m"))
-	e.FatalOnError(err)
-	dir, err := paramsReader.GetExeDir()
-	e.FatalOnError(err)
-	dataDir, err := paramsReader.GetDataDir(dir)
-	e.FatalOnError(err)
-	fileManager := files.NewFileManager()
-	dbSQLiteExists, err := fileManager.FileExists(dataDir + "/updates.db")
-	e.FatalOnError(err)
-	dbJSONExists, err := fileManager.FileExists(dataDir + "/updates.json")
-	e.FatalOnError(err)
-	var persistentDB persistence.Database
-	if dbSQLiteExists && !dbJSONExists {
-		logger.Warn("Migrating from SQLite to JSON based database file")
-		sqlite, err := persistence.NewSQLite(dataDir)
-		e.FatalOnError(err)
-		persistentDB, err = persistence.NewJSON(dataDir)
-		e.FatalOnError(err)
-		err = persistence.Migrate(sqlite, persistentDB, logger)
-		e.FatalOnError(err)
-		logger.Info("Success; you can now safely delete %s", dataDir+"/updates.db")
-	} else {
-		persistentDB, err = persistence.NewJSON(dataDir)
-		e.FatalOnError(err)
-	}
-	go signals.WaitForExit(e.ShutdownFromSignal)
-	settings, warnings, err := paramsReader.GetSettings(dataDir + "/config.json")
-	for _, w := range warnings {
-		e.Warn(w)
-	}
-	if err != nil {
-		e.Fatal(err)
-	}
-	if len(settings) > 1 {
-		logger.Info("Found %d settings to update records", len(settings))
-	} else if len(settings) == 1 {
-		logger.Info("Found single setting to update records")
-	}
-	for _, err := range network.NewConnectivity(5 * time.Second).Checks("google.com") {
-		e.Warn(err)
-	}
-	var records []models.Record
-	idToPeriod := make(map[int]time.Duration)
-	for id, setting := range settings {
-		logger.Info("Reading history from database: domain %s host %s", setting.Domain, setting.Host)
-		events, err := persistentDB.GetEvents(setting.Domain, setting.Host)
-		if err != nil {
-			e.FatalOnError(err)
-		}
-		records = append(records, models.NewRecord(setting, events))
-		idToPeriod[id] = defaultPeriod
-		if setting.Delay > 0 {
-			idToPeriod[id] = setting.Delay
-		}
-	}
-	HTTPTimeout, err := paramsReader.GetHTTPTimeout()
-	e.FatalOnError(err)
-	client := network.NewClient(HTTPTimeout)
-	db := data.NewDatabase(records, persistentDB)
-	e.SetDB(db)
-	updater := update.NewUpdater(db, logger, client, e.Notify)
-	ctx, cancel := context.WithCancel(context.Background())
-	defer cancel()
-	forceUpdate := trigger.StartUpdates(ctx, updater, idToPeriod, e.CheckError)
-	forceUpdate()
-	productionHandlerFunc := handlers.NewHandler(rootURL, dir, db, logger, forceUpdate, e.CheckError).GetHandlerFunc()
-	healthcheckHandlerFunc := libhealthcheck.GetHandler(func() error {
-		return healthcheck.IsHealthy(db, net.LookupIP, logger)
-	})
-	logger.Info("Web UI listening at address 0.0.0.0:%s with root URL %s", listeningPort, rootURL)
-	e.Notify(1, fmt.Sprintf("Just launched\nIt has %d records to watch", len(records)))
-	serverErrs := server.RunServers(
-		server.Settings{Name: "production", Addr: "0.0.0.0:" + listeningPort, Handler: productionHandlerFunc},
-		server.Settings{Name: "healthcheck", Addr: "127.0.0.1:9999", Handler: healthcheckHandlerFunc},
-	)
-	if len(serverErrs) > 0 {
-		e.Fatal(serverErrs)
-	}
-}

config.json

@@ -3,29 +3,22 @@
         {
             "provider": "namecheap",
             "domain": "example.com",
-            "host": "@",
-            "ip_method": "provider",
-            "delay": 86400,
             "password": "e5322165c1d74692bfa6d807100c0310"
         },
         {
             "provider": "duckdns",
             "domain": "example.duckdns.org",
-            "ip_method": "provider",
             "token": "00000000-0000-0000-0000-000000000000"
         },
         {
             "provider": "godaddy",
-            "domain": "example.org",
-            "host": "subdomain",
-            "ip_method": "google",
+            "domain": "subdomain.example.org",
             "key": "aaaaaaaaaaaaaaaa",
             "secret": "aaaaaaaaaaaaaaaa"
         },
         {
             "provider": "dreamhost",
             "domain": "example.info",
-            "ip_method": "opendns",
             "key": "aaaaaaaaaaaaaaaa"
         }
     ]

docker-compose.yml

@@ -9,13 +9,27 @@ services:
     volumes:
       - ./data:/updater/data
     environment:
-      - DELAY=300s
-      - ROOT_URL=/
-      - LISTENING_PORT=8000
-      - LOG_ENCODING=console
-      - LOG_LEVEL=info
-      - NODE_ID=0
+      - CONFIG=
+      - PERIOD=5m
+      - UPDATE_COOLDOWN_PERIOD=5m
+      - PUBLICIP_FETCHERS=all
+      - PUBLICIP_HTTP_PROVIDERS=all
+      - PUBLICIPV4_HTTP_PROVIDERS=all
+      - PUBLICIPV6_HTTP_PROVIDERS=all
+      - PUBLICIP_DNS_PROVIDERS=all
+      - PUBLICIP_DNS_TIMEOUT=3s
       - HTTP_TIMEOUT=10s
-      - GOTIFY_URL=
-      - GOTIFY_TOKEN=
+
+      # Web UI
+      - LISTENING_ADDRESS=:8000
+      - ROOT_URL=/
+
+      # Backup
+      - BACKUP_PERIOD=0 # 0 to disable
+      - BACKUP_DIRECTORY=/updater/data
+
+      # Other
+      - LOG_LEVEL=info
+      - LOG_CALLER=hidden
+      - SHOUTRRR_ADDRESSES=
     restart: always

docs/aliyun.md

@@ -0,0 +1,33 @@
+# Aliyun
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "aliyun",
+      "domain": "domain.com",
+      "access_key_id": "your access_key_id",
+      "access_secret": "your access_secret",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"access_key_id"`
+- `"access_secret"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/allinkl.md

@@ -0,0 +1,33 @@
+# All-Inkl
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "allinkl",
+      "domain": "sub.domain.com",
+      "username": "dynXXXXXXX",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"username"` username (usually starts with dyn followed by numbers)
+- `"password"` password in plain text
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/changeip.md

@@ -0,0 +1,33 @@
+# ChangeIP
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "changeip",
+      "domain": "sub.domain.com",
+      "username": "dynXXXXXXX",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"username"`
+- `"password"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/cloudflare.md

@@ -0,0 +1,40 @@
+# Cloudflare
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "cloudflare",
+      "zone_identifier": "some id",
+      "domain": "domain.com",
+      "ttl": 600,
+      "token": "yourtoken",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"zone_identifier"` is the Zone ID of your site, from the domain overview page written as *Zone ID*
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+See [this issue comment for context](https://github.com/qdm12/ddns-updater/issues/243#issuecomment-928313949). This is left as is for compatibility.
+- `"ttl"` integer value for record TTL in seconds (specify 1 for automatic)
+- One of the following ([how to find API keys](https://developers.cloudflare.com/fundamentals/api/get-started/)):
+  - Email `"email"` and Global API Key `"key"`
+  - User service key `"user_service_key"`
+  - API Token `"token"`, configured with DNS edit permissions for your DNS name's zone
+
+### Optional parameters
+
+- `"proxied"` can be set to `true` to use the proxy services of Cloudflare
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+Special thanks to @Starttoaster for helping out with the [documentation](https://gist.github.com/Starttoaster/07d568c2a99ad7631dd776688c988326) and testing.

docs/custom.md

@@ -0,0 +1,40 @@
+# Custom provider
+
+The custom provider allows to configure a URL with a few additional parameters to update your records.
+
+For now it sends an HTTP GET request to the URL given with some additional parameters.
+Feel free to open issues to extend its configuration options.
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "custom",
+      "domain": "example.com",
+      "url": "https://example.com/update?domain=example.com&host=@&username=username&client_key=client_key",
+      "ipv4key": "ipv4",
+      "ipv6key": "ipv6",
+      "success_regex": "good",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"url"` is the URL to update your records and should contain all the information EXCEPT the IP address to update
+- `"ipv4key"` is the URL query parameter name for the IPv4 address, for example `ipv4` will be added to the URL with `&ipv4=1.2.3.4`.
+- `"ipv6key"` is the URL query parameter name for the IPv6 address, for example `ipv6` will be added to the URL with `&ipv6=::aaff`. Even if you don't use IPv6, this must be set to something.
+- `"success_regex"` is a regular expression to match the response from the server to determine if the update was successful. You can use [regex101.com](https://regex101.com/) to find the regular expression you want. For example `good` would match any response containing the word "good".
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.

docs/dd24.md

@@ -0,0 +1,29 @@
+# Domain Discount 24
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "dd24",
+      "domain": "domain.com",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"password"` is your password
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.

docs/ddnss.de.md

@@ -0,0 +1,37 @@
+# DDNSS
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "ddnss",
+      "domain": "domain.com",
+      "username": "user",
+      "password": "password",
+      "dual_stack": false,
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"username"`
+- `"password"`
+
+### Optional parameters
+
+- `"dual_stack"` can be set to `true` **if you have turn on dual stack for your record** to update both IPv4 and IPv6 addresses. More precisely:
+  - if it is `false`, the updates are done using the `ip` parameter and only one IP address can be set (ipv4 or ipv6, whichever is last sent).
+  - if it is `true`, the updates are done using the `ip` and `ip6` parameters, for IPv4 and IPv6 respectively, and both can be set on the same record
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/desec.md

@@ -0,0 +1,33 @@
+# deSEC
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "desec",
+      "domain": "sub.dedyn.io",
+      "token": "token",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"token"` is your token that you can create [here](https://desec.io/tokens)
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+[desec.io/domains](https://desec.io/domains)

docs/digitalocean.md

@@ -0,0 +1,31 @@
+# Digital Ocean
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "digitalocean",
+      "domain": "domain.com",
+      "token": "yourtoken",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"token"` is your token that you can create [here](https://cloud.digitalocean.com/settings/applications)
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/dnsomatic.md

@@ -0,0 +1,33 @@
+# DNS-O-Matic
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "dnsomatic",
+      "domain": "domain.com",
+      "username": "username",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"username"`
+- `"password"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/dnspod.md

@@ -0,0 +1,31 @@
+# DNSPod
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "dnspod",
+      "domain": "domain.com",
+      "token": "yourtoken",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"token"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/dondominio.md

@@ -0,0 +1,35 @@
+# Don Dominio
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "dondominio",
+      "domain": "domain.com",
+      "username": "username",
+      "key": "key",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"username"`
+- `"password"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+See [dondominio.dev/en/dondns/docs/api/#before-start](https://dondominio.dev/en/dondns/docs/api/#before-start)

docs/dreamhost.md

@@ -0,0 +1,32 @@
+# Dreamhost
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "dreamhost",
+      "domain": "domain.com",
+      "key": "key",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"`
+- `"key"`
+
+### Optional parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/duckdns.md

@@ -0,0 +1,35 @@
+# DuckDNS
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "duckdns",
+      "domain": "sub.duckdns.org",
+      "token": "token",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. For example, for the owner/host `sub`, it would be `sub.duckdns.org`. The [eTLD](https://developer.mozilla.org/en-US/docs/Glossary/eTLD) must be `duckdns.org`.
+- `"token"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+[![DuckDNS Website](../readme/duckdns.png)](https://www.duckdns.org/)
+
+*See the [duckdns website](https://www.duckdns.org/)*

docs/dyndns.md

@@ -0,0 +1,33 @@
+# DynDNS
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "dyn",
+      "domain": "domain.com",
+      "username": "username",
+      "client_key": "client_key",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"username"`
+- `"client_key"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/dynu.md

@@ -0,0 +1,35 @@
+# Dynu
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "dynu",
+      "domain": "domain.com",
+      "group": "group",
+      "username": "username",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"username"`
+- `"password"` could be plain text or password in MD5 or SHA256 format (There's also an option for setting a password for IP Update only)
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+- `"group"` specify the Group for which you want to set the IP (will update any domains and subdomains in the same group)
+
+## Domain setup

docs/dynv6.md

@@ -0,0 +1,31 @@
+# DynV6
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "dynv6",
+      "domain": "domain.com",
+      "token": "token",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"token"` that you can obtain [here](https://dynv6.com/keys#token)
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/easydns.md

@@ -0,0 +1,33 @@
+# EasyDNS
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "easydns",
+      "domain": "domain.com",
+      "username": "username",
+      "token": "token",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"username"`
+- `"token"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/example.md

@@ -0,0 +1,41 @@
+# Example.com
+
+## Configuration
+
+### Example
+
+<!-- UPDATE THIS JSON EXAMPLE -->
+
+```json
+{
+  "settings": [
+    {
+      "provider": "example",
+      "domain": "domain.com",
+      "username": "username",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"username"`
+- `"password"`
+
+<!-- UPDATE THIS IF NEEDED -->
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+<!-- UPDATE THIS IF NEEDED -->
+
+## Domain setup
+
+<!-- FILL THIS UP WITH A FEW NUMBERED STEPS -->

docs/freedns.md

@@ -0,0 +1,34 @@
+# FreeDNS
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "freedns",
+      "domain": "sub.domain.com",
+      "token": "token",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"token"` is the randomized update token you use to update your record
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+This integration uses FreeDNS's v2 dynamic dns interface, which is not shown by default when you select `Dynamic DNS` from the side menu.
+Instead you must go to [freedns.afraid.org/dynamic/v2/](https://freedns.afraid.org/dynamic/v2/) and enable dynamic DNS for the subdomains you wish and you will then see a url like `https://sync.afraid.org/u/token/` for each enabled subdomain.

docs/gandi.md

@@ -0,0 +1,37 @@
+# Gandi
+
+This provider uses Gandi v5 API
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "gandi",
+      "domain": "domain.com",
+      "personal_access_token": "token",
+      "ttl": 3600,
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"personal_access_token"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+- `"ttl"` default is `3600`
+
+## Domain setup
+
+[Gandi Documentation Website](https://docs.gandi.net/en/rest_api/index.html)

docs/gcp.md

@@ -0,0 +1,37 @@
+# GCP
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "gcp",
+      "project": "my-project-id",
+      "zone": "zone",
+      "credentials": {
+        "type": "service_account",
+        "project_id": "my-project-id",
+        // ...
+      },
+      "domain": "domain.com",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"project"` is the id of your Google Cloud project
+- `"zone"` is the zone, that your DNS record is located in
+- `"credentials"` is the JSON credentials for your Google Cloud project. This is usually downloaded as a JSON file, which you can copy paste the content as the value of the `"credentials"` key. More information on how to get it is available [here](https://cloud.google.com/docs/authentication/getting-started). Please ensure your service account has all necessary permissions to create/update/list/get DNS records within your project.
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.

docs/godaddy.md

@@ -0,0 +1,61 @@
+# GoDaddy
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "godaddy",
+      "domain": "domain.com",
+      "key": "key",
+      "secret": "secret",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"key"`
+- `"secret"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+[![GoDaddy Website](../readme/godaddy.png)](https://www.godaddy.com/en-ie)
+
+1. Login to [https://developer.godaddy.com/keys](https://developer.godaddy.com/keys/) with your account credentials.
+
+[![GoDaddy Developer Login](../readme/godaddy1.gif)](https://developer.godaddy.com/keys)
+
+1. Generate a Test key and secret.
+
+[![GoDaddy Developer Test Key](../readme/godaddy2.gif)](https://developer.godaddy.com/keys)
+
+1. Generate a **Production** key and secret.
+
+[![GoDaddy Developer Production Key](../readme/godaddy3.gif)](https://developer.godaddy.com/keys)
+
+Obtain the **key** and **secret** of that production key.
+
+In this example, the key is `dLP4WKz5PdkS_GuUDNigHcLQFpw4CWNwAQ5` and the secret is `GuUFdVFj8nJ1M79RtdwmkZ`.
+
+## Testing
+
+1. Go to [https://dcc.godaddy.com/manage/yourdomain.com/dns](https://dcc.godaddy.com/manage/yourdomain.com/dns) (replace yourdomain.com)
+
+    [![GoDaddy DNS management](../readme/godaddydnsmanagement.png)](https://dcc.godaddy.com/manage/)
+
+1. Change the IP address to `127.0.0.1`
+1. Run the ddns-updater
+1. Refresh the Godaddy webpage to check the update occurred.

docs/goip.md

@@ -0,0 +1,32 @@
+# GoIP.de
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "goip",
+      "domain": "mydomain.goip.de",
+      "username": "username",
+      "password": "password",
+      "ip_version": "",
+      "ipv6_suffix": ""
+
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. For example, for the owner/host `sub`, it would be `sub.goip.de`. The [eTLD](https://developer.mozilla.org/en-US/docs/Glossary/eTLD) must be `goip.de` or `goip.it`.
+- `"username"` is your goip.de username listed under "Routers"
+- `"password"` is your router account password
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.

docs/he.net.md

@@ -0,0 +1,31 @@
+# He.net
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "he",
+      "domain": "domain.com",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard. (untested)
+- `"password"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/hetzner.md

@@ -0,0 +1,34 @@
+# Hetzner
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "hetzner",
+      "zone_identifier": "some id",
+      "domain": "domain.com",
+      "ttl": 600,
+      "token": "yourtoken",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"zone_identifier"` is the Zone ID of your site, from the domain overview page written as *Zone ID*
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"ttl"` optional integer value corresponding to a number of seconds
+- One of the following ([how to find API keys](https://docs.hetzner.com/cloud/api/getting-started/generating-api-token)):
+  - API Token `"token"`, configured with DNS edit permissions for your DNS name's zone
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.

docs/infomaniak.md

@@ -0,0 +1,37 @@
+# Infomaniak
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "infomaniak",
+      "domain": "domain.com",
+      "username": "username",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"username"` for dyndns (**not** your infomaniak admin username!)
+- `"password"` for dyndns (**not** your infomaniak admin password!)
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+Follow [this guide](https://www.infomaniak.com/en/support/faq/2357/getting-started-guide-dyndns-with-an-infomaniak-domain) to set up your subdomain including `username` and `password` for use in the configuration. **do not use your infomaniak admin username and password in the configuration!**
+
+If you only plan on using IPv4, add your current IPv4 Address. If you only plan on using IPv6, add your current IPv6 Address. If you plan to use dual-stack (IPv4 and IPv6) addresses, it does not matter what ip-address you put in the dialog.

docs/inwx.md

@@ -0,0 +1,33 @@
+# INWX
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "inwx",
+      "domain": "domain.com",
+      "username": "username",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"username"`
+- `"password"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/ionos.md

@@ -0,0 +1,29 @@
+# Ionos
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "ionos",
+      "domain": "domain.com",
+      "api_key": "api_key",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"api_key"` is your API key, obtained from [creating an API key](https://www.ionos.com/help/domains/configuring-your-ip-address/set-up-dynamic-dns-with-company-name/#c181598)
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.

docs/linode.md

@@ -0,0 +1,34 @@
+# Linode
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "linode",
+      "domain": "domain.com",
+      "token": "token",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"token"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+1. Create a personal access token with `domains` set, with read and write privileges, ideally that never expires. You can refer to [@AnujRNair's comment](https://github.com/qdm12/ddns-updater/pull/144#discussion_r559292678) and to [Linode's guide](https://www.linode.com/docs/products/tools/api/guides/manage-api-tokens/).
+1. The program will create the A or AAAA record for you if it doesn't exist already.

docs/luadns.md

@@ -0,0 +1,37 @@
+# LuaDNS
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "luadns",
+      "domain": "domain.com",
+      "email": "email",
+      "token": "token",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"email"`
+- `"token"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+1. Go to [api.luadns.com/settings](https://api.luadns.com/settings)
+1. Enable API access
+1. Obtain your API token and replace it in the parameters as the value for `token`

docs/name.com.md

@@ -0,0 +1,35 @@
+# Name.com
+
+<img src="../readme/name.svg" alt="drawing" width="25%"/>
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "name.com",
+      "domain": "domain.com",
+      "username": "username",
+      "token": "token",
+      "ttl": 300,
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"username"` is your account username
+- `"token"` which you can obtain from [www.name.com/account/settings/api](https://www.name.com/account/settings/api)
+
+### Optional parameters
+
+- `"ttl"` is the time this record can be cached for in seconds. Name.com allows a minimum TTL of 300, or 5 minutes. Name.com defaults to 300 if not provided.
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.

docs/namecheap.md

@@ -0,0 +1,52 @@
+# Namecheap
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "namecheap",
+      "domain": "domain.com",
+      "password": "password"
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"password"`
+
+### Optional parameters
+
+Note that Namecheap only supports ipv4 addresses for now.
+
+## Domain setup
+
+[![Namecheap Website](../readme/namecheap.png)](https://www.namecheap.com/)
+
+1. Create a Namecheap account and buy a domain name - *example.com* as an example
+1. Login to Namecheap at [https://www.namecheap.com/myaccount/login/](https://www.namecheap.com/myaccount/login/)
+
+For **each domain name** you want to add, replace *example.com* in the following link with your domain name and go to [https://ap.www.namecheap.com/Domains/DomainControlPanel/**example.com**/advancedns](https://ap.www.namecheap.com/Domains/DomainControlPanel/example.com/advancedns)
+
+1. For each host you want to add (if you don't know, create one record with the host set to `*`):
+    1. In the *HOST RECORDS* section, click on *ADD NEW RECORD*
+
+        ![https://ap.www.namecheap.com/Domains/DomainControlPanel/example.com/advancedns](../readme/namecheap1.png)
+
+    1. Select the following settings and create the *A + Dynamic DNS Record*:
+
+        ![https://ap.www.namecheap.com/Domains/DomainControlPanel/example.com/advancedns](../readme/namecheap2.png)
+
+1. Scroll down and turn on the switch for *DYNAMIC DNS*
+
+    ![https://ap.www.namecheap.com/Domains/DomainControlPanel/example.com/advancedns](../readme/namecheap3.png)
+
+1. The Dynamic DNS Password will appear, which is `0e4512a9c45a4fe88313bcc2234bf547` in this example.
+
+    ![https://ap.www.namecheap.com/Domains/DomainControlPanel/example.com/advancedns](../readme/namecheap4.png)

docs/netcup.md

@@ -0,0 +1,37 @@
+# Netcup
+
+## Configuration
+
+Note: This implementation does not require a domain reseller account. The warning in the dashboard can be ignored.
+
+Also keep in mind, that TTL, Expire, Retry and Refresh values of the given Domain are not updated. They can be manually set in the dashboard. For DDNS purposes low numbers should be used.
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "netcup",
+      "domain": "domain.com",
+      "api_key": "xxxxx",
+      "password": "yyyyy",
+      "customer_number": "111111",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`) or the wildcard `*.example.com`.
+- `"api_key"` is your api key (generated in the [customercontrolpanel](https://www.customercontrolpanel.de))
+- `"password"` is your api password (generated in the [customercontrolpanel](https://www.customercontrolpanel.de)). Netcup only allows one ApiPassword. This is not the account password. This password is used for all api keys.
+- `"customer_number"` is your customer number (viewable in the [customercontrolpanel](https://www.customercontrolpanel.de) next to your name). As seen in the example above, provide the number as string value.
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.

docs/njalla.md

@@ -0,0 +1,33 @@
+# Njalla
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "njalla",
+      "domain": "domain.com",
+      "key": "key",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"key"` is the key for your record
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+See [https://njal.la/docs/ddns](https://njal.la/docs/ddns/)

docs/noip.md

@@ -0,0 +1,33 @@
+# NoIP
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "noip",
+      "domain": "domain.com",
+      "username": "username",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"username"`
+- `"password"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/nowdns.md

@@ -0,0 +1,31 @@
+# Now-DNS
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "nowdns",
+      "domain": "domain.com",
+      "username": "username",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` your full domain name (FQDN)
+- `"username"` your email address
+- `"password"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.

docs/opendns.md

@@ -0,0 +1,33 @@
+# OpenDNS
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "opendns",
+      "domain": "domain.com",
+      "username": "username",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"username"`
+- `"password"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/ovh.md

@@ -0,0 +1,49 @@
+# OVH
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "ovh",
+      "domain": "domain.com",
+      "username": "username",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+
+#### Using DynHost
+
+- `"username"`
+- `"password"`
+
+#### OR Using ZoneDNS
+
+- `"api_endpoint"` default value is `"ovh-eu"`
+- `"app_key"` which you can create at [eu.api.ovh.com/createApp](https://eu.api.ovh.com/createApp/)
+- `"app_secret"`
+- `"consumer_key"` which you can get at [www.ovh.com/auth/api/createToken](https://www.ovh.com/auth/api/createToken)
+
+The ZoneDNS implementation allows you to update any record name including *.yourdomain.tld
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+- `"mode"` select between two modes, OVH's dynamic hosting service (`"dynamic"`) or OVH's API (`"api"`). Default is `"dynamic"`
+
+## Domain setup
+
+- If you use DynHost: [docs.ovh.com/ie/en/domains/hosting_dynhost](https://docs.ovh.com/ie/en/domains/hosting_dynhost/)
+- If you use the ZoneDNS API: [docs.ovh.com/gb/en/customer/first-steps-with-ovh-api](https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/)

docs/porkbun.md

@@ -0,0 +1,52 @@
+# Porkbun
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "porkbun",
+      "domain": "domain.com",
+      "api_key": "sk1_7d119e3f656b00ae042980302e1425a04163c476efec1833q3cb0w54fc6f5022",
+      "secret_api_key": "pk1_5299b57125c8f3cdf347d2fe0e713311ee3a1e11f11a14942b26472593e35368",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory Parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"api_key"`
+- `"secret_api_key"`
+- `"ttl"` optional integer value corresponding to a number of seconds
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+- Create an API key at [porkbun.com/account/api](https://porkbun.com/account/api)
+- From the [Domain Management page](https://porkbun.com/account/domainsSpeedy), toggle on **API ACCESS** for your domain.
+
+💁 [Official setup documentation](https://kb.porkbun.com/article/190-getting-started-with-the-porkbun-dns-api)
+
+## Record creation
+
+In case you don't have an A or AAAA record for your host and domain combination, it will be created by DDNS-Updater.
+
+Porkbun creates default DNS entries for new domains, which can conflict with creating a root or wildcard A/AAAA record. Therefore, ddns-updater automatically removes any conflicting default record before creating records, as described in the table below:
+
+| Record type | Owner | Record value | Situation requiring a removal |
+| --- | --- | --- | --- |
+| `ALIAS` | `@` | pixie.porkbun.com | Creating A or AAAA record for the root domain **or** wildcard domain |
+| `CNAME` | `*` | pixie.porkbun.com | Creating A or AAAA record for the wildcard domain |
+
+More details is in [this comment by @everydaycombat](https://github.com/qdm12/ddns-updater/issues/546#issuecomment-1773960193).

docs/route53.md

@@ -0,0 +1,56 @@
+# AWS
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "route53",
+      "domain": "domain.com",
+      "ip_version": "ipv4",
+      "ipv6_suffix": "",
+      "access_key": "ffffffffffffffffffff",
+      "secret_key": "ffffffffffffffffffffffffffffffffffffffff",
+      "zone_id": "A30888735ZF12K83Z6F00",
+      "ttl": 300
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"access_key"` is the `AWS_ACCESS_KEY`
+- `"secret_key"` is the `AWS_SECRET_ACCESS_KEY`
+- `"zone_id"` is identification of your hosted zone
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifiersuffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+- `"ttl"` amount of time, in seconds, that you want DNS recursive resolvers to cache information about this record. Defaults to `300`.
+
+## Domain setup
+
+Amazon has [an extensive documentation on registering or tranfering your domain to route53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/Welcome.html).
+
+### User permissions
+
+Create a policy to grant access to change record sets, you can use a wildcard `*` in case you want to grant access to all your hosted zones.
+
+```json
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": "route53:ChangeResourceRecordSets",
+      "Resource": "arn:aws:route53:::hostedzone/A30888735ZF12K83Z6F00"
+    }
+  ]
+}
+```

docs/selfhost.de.md

@@ -0,0 +1,33 @@
+# Selfhost.de
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "selfhost.de",
+      "domain": "domain.com",
+      "username": "username",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"username"` is your DynDNS username
+- `"password"` is your DynDNS password
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup

docs/servercow.md

@@ -0,0 +1,37 @@
+# Servercow
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+      {
+          "provider": "servercow",
+          "domain": "domain.com",
+          "username": "servercow_username",
+          "password": "servercow_password",
+          "ttl": 600,
+          "ip_version": "ipv4",
+          "ipv6_suffix": ""
+      }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"username"` is the username for your DNS API User
+- `"password"` is the password for your DNS API User
+
+### Optional parameters
+
+- `"ttl"` can be set to an integer value for record TTL in seconds (if not set the default is 120)
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+See [their article](https://cp.servercow.de/en/plugin/support_manager/knowledgebase/view/34/dns-api-v1/7/)

docs/spdyn.md

@@ -0,0 +1,39 @@
+# Spdyn.de
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "spdyn",
+      "domain": "domain.com",
+      "user": "user",
+      "password": "password",
+      "token": "token",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+
+#### Using user and password
+
+- `"user"` is the name of a user who can update this host
+- `"password"` is the password of a user who can update this host
+
+#### Using update tokens
+
+- `"token"` is your update token
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.

docs/strato.md

@@ -0,0 +1,33 @@
+# Strato
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "strato",
+      "domain": "domain.com",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"password"` is your dyndns password
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+See [their article](https://www.strato.com/faq/en_us/domain/this-is-how-easy-it-is-to-set-up-dyndns-for-your-domains/)

docs/variomedia.md

@@ -0,0 +1,35 @@
+# Variomedia
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "variomedia",
+      "domain": "domain.com",
+      "email": "email@domain.com",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
+- `"email"`
+- `"password"` is your DNS settings password, not your account password ⚠️
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+See [dyndns.variomedia.de](https://dyndns.variomedia.de/)

docs/zoneedit.md

@@ -0,0 +1,41 @@
+# Zoneedit
+
+## Configuration
+
+⚠️ zoneedit.com for some reason requires at least a 10 minutes period between update request sent.
+
+DDNS-Updater only sends update requests when it detects your domain name IP address mismatches your current public IP address,
+so it should be fine in most cases since this happens rarely (in hours/days). But in case it happens and you want to avoid this,
+set the environment variable as `PERIOD=11m` to check your public IP address and update every 11 minutes only.
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "zoneedit",
+      "domain": "domain.com",
+      "username": "username",
+      "token": "token",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
+- `"username"`
+- `"token"`
+
+### Optional parameters
+
+- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
+- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
+
+## Domain setup
+
+[support.zoneedit.com/en/knowledgebase/article/dynamic-dns](https://support.zoneedit.com/en/knowledgebase/article/dynamic-dns)

go.mod

@@ -1,11 +1,41 @@
 module github.com/qdm12/ddns-updater
 
-go 1.13
+go 1.22.0
+
+toolchain go1.22.5
 
 require (
-	github.com/google/uuid v1.1.1
-	github.com/kyokomi/emoji v2.1.0+incompatible
-	github.com/mattn/go-sqlite3 v1.10.0
-	github.com/qdm12/golibs v0.0.0-20200224233831-af1ada8e2052
-	github.com/stretchr/testify v1.4.0
+	github.com/breml/rootcerts v0.2.18
+	github.com/containrrr/shoutrrr v0.8.0
+	github.com/go-chi/chi/v5 v5.1.0
+	github.com/golang/mock v1.6.0
+	github.com/miekg/dns v1.1.62
+	github.com/qdm12/goservices v0.1.0
+	github.com/qdm12/gosettings v0.4.4-rc1
+	github.com/qdm12/gosplash v0.2.0
+	github.com/qdm12/gotree v0.2.0
+	github.com/qdm12/log v0.1.0
+	github.com/stretchr/testify v1.9.0
+	golang.org/x/mod v0.21.0
+	golang.org/x/net v0.29.0
+	golang.org/x/oauth2 v0.23.0
+)
+
+require (
+	cloud.google.com/go/compute/metadata v0.3.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/fatih/color v1.15.0 // indirect
+	github.com/go-logr/logr v1.4.1 // indirect
+	github.com/golang/protobuf v1.5.4 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.17 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/exp v0.0.0-20231110203233-9a3e6036ecaa // indirect
+	golang.org/x/sync v0.7.0 // indirect
+	golang.org/x/sys v0.25.0 // indirect
+	golang.org/x/tools v0.22.0 // indirect
+	google.golang.org/protobuf v1.34.1 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	kernel.org/pub/linux/libs/security/libcap/cap v1.2.69 // indirect
+	kernel.org/pub/linux/libs/security/libcap/psx v1.2.69 // indirect
 )

go.sum

@@ -1,121 +1,101 @@
-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/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY=
-github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+cloud.google.com/go/compute/metadata v0.3.0 h1:Tz+eQXMEqDIKRsmY3cHTL6FVaynIjX2QxYC4trgAKZc=
+cloud.google.com/go/compute/metadata v0.3.0/go.mod h1:zFmK7XCadkQkj6TtorcaGlCW1hT1fIilQDwofLpJ20k=
+github.com/breml/rootcerts v0.2.18 h1:KjZaNT7AX/akUjzpStuwTMQs42YHlPyc6NmdwShVba0=
+github.com/breml/rootcerts v0.2.18/go.mod h1:S/PKh+4d1HUn4HQovEB8hPJZO6pUZYrIhmXBhsegfXw=
+github.com/containrrr/shoutrrr v0.8.0 h1:mfG2ATzIS7NR2Ec6XL+xyoHzN97H8WPjir8aYzJUSec=
+github.com/containrrr/shoutrrr v0.8.0/go.mod h1:ioyQAyu1LJY6sILuNyKaQaw+9Ttik5QePU8atnAdO2o=
 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/globalsign/mgo v0.0.0-20180905125535-1ca0a4f7cbcb h1:D4uzjWwKYQ5XnAvUbuvHW93esHg7F8N/OYeBBcJoTr0=
-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/gomodule/redigo v2.0.0+incompatible h1:K/R+8tc58AaqLkqG2Ol3Qk+DR/TlNuhuh457pBFPtt0=
-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/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/google/uuid v1.1.1 h1:Gkbcsh/GbpXz7lPftLA3P6TYMwjCLYm83jiFQZF/3gY=
-github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/gotify/go-api-client/v2 v2.0.4 h1:0w8skCr8aLBDKaQDg31LKKHUGF7rt7zdRpR+6cqIAlE=
-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/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/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.1.0+incompatible h1:+DYU2RgpI6OHG4oQkM5KlqD3Wd3UPEsX8jamTo1Mp6o=
-github.com/kyokomi/emoji v2.1.0+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-sqlite3 v1.10.0 h1:jbhqpg7tQe4SupckyijYiy0mJJ/pRyHvXf7JdWK860o=
-github.com/mattn/go-sqlite3 v1.10.0/go.mod h1:FPy6KqzDD04eiIsT53CuJW3U88zkxoIYsOqkbpncsNc=
-github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE=
-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/pborman/uuid v1.2.0 h1:J7Q5mO4ysT1dv8hyrUGHb9+ooztCXu1D8MY8DZYsu3g=
-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/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/fatih/color v1.15.0 h1:kOqh6YHBtK8aywxGerMG2Eq3H6Qgoqeo13Bk2Mv/nBs=
+github.com/fatih/color v1.15.0/go.mod h1:0h5ZqXfHYED7Bhv2ZJamyIOUej9KtShiJESRwBDUSsw=
+github.com/go-chi/chi/v5 v5.1.0 h1:acVI1TYaD+hhedDJ3r54HyA6sExp3HfXq7QWEEY/xMw=
+github.com/go-chi/chi/v5 v5.1.0/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
+github.com/go-logr/logr v1.4.1 h1:pKouT5E8xu9zeFC39JXRDukb6JFQPXM5p5I91188VAQ=
+github.com/go-logr/logr v1.4.1/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
+github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 h1:tfuBGBXKqDEevZMzYi5KSi8KkcZtzBcTgAUUtapy0OI=
+github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572/go.mod h1:9Pwr4B2jHnOSGXyyzV8ROjYa2ojvAY6HCGYYfMoC3Ls=
+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/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
+github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38 h1:yAJXTCF9TqKcTiHJAE8dj7HMvPfh66eeA2JYW7eFpSE=
+github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE=
+github.com/jarcoal/httpmock v1.3.0 h1:2RJ8GP0IIaWwcC9Fp2BmVi8Kog3v2Hn7VXM3fTd+nuc=
+github.com/jarcoal/httpmock v1.3.0/go.mod h1:3yb8rc4BI7TCBhFY8ng0gjuLKJNquuDNiPaZjnENuYg=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.17 h1:BTarxUcIeDqL27Mc+vyvdWYSL28zpIhv3RoTdsLMPng=
+github.com/mattn/go-isatty v0.0.17/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/miekg/dns v1.1.62 h1:cN8OuEF1/x5Rq6Np+h1epln8OiyPWV+lROx9LxcGgIQ=
+github.com/miekg/dns v1.1.62/go.mod h1:mvDlcItzm+br7MToIKqkglaGhlFMHJ9DTNNWONWXbNQ=
+github.com/onsi/ginkgo/v2 v2.9.2 h1:BA2GMJOtfGAfagzYtrAlufIP0lq6QERkFmHLMLPwFSU=
+github.com/onsi/ginkgo/v2 v2.9.2/go.mod h1:WHcJJG2dIlcCqVfBAwUCrJxSPFb6v4azBwgxeMeDuts=
+github.com/onsi/gomega v1.27.6 h1:ENqfyGeS5AX/rlXDd/ETokDz93u0YufY1Pgxuy/PvWE=
+github.com/onsi/gomega v1.27.6/go.mod h1:PIQNjfQwkP3aQAH7lf7j87O/5FiNr+ZR8+ipb+qQlhg=
 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-20200224233831-af1ada8e2052 h1:6KVUzd4oLyHcmmYsXdpE3HR9FUSx3FF8UBTRlJPCKLc=
-github.com/qdm12/golibs v0.0.0-20200224233831-af1ada8e2052/go.mod h1:YULaFjj6VGmhjak6f35sUWwEleHUmngN5IQ3kdvd6XE=
-github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
-github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
-github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
-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=
-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/qdm12/goservices v0.1.0 h1:9sODefm/yuIGS7ynCkEnNlMTAYn9GzPhtcK4F69JWvc=
+github.com/qdm12/goservices v0.1.0/go.mod h1:/JOFsAnHFiSjyoXxa5FlfX903h20K5u/3rLzCjYVMck=
+github.com/qdm12/gosettings v0.4.4-rc1 h1:VT+6O6ww3Cn5v5/LgY2zlXoiCkZzbaLDWaA8ufQoOLY=
+github.com/qdm12/gosettings v0.4.4-rc1/go.mod h1:CPrt2YC4UsURTrslmhxocVhMCW03lIrqdH2hzIf5prg=
+github.com/qdm12/gosplash v0.2.0 h1:DOxCEizbW6ZG+FgpH2oK1atT6bM8MHL9GZ2ywSS4zZY=
+github.com/qdm12/gosplash v0.2.0/go.mod h1:k+1PzhO0th9cpX4q2Nneu4xTsndXqrM/x7NTIYmJ4jo=
+github.com/qdm12/gotree v0.2.0 h1:+58ltxkNLUyHtATFereAcOjBVfY6ETqRex8XK90Fb/c=
+github.com/qdm12/gotree v0.2.0/go.mod h1:1SdFaqKZuI46U1apbXIf25pDMNnrPuYLEqMF/qL4lY4=
+github.com/qdm12/log v0.1.0 h1:jYBd/xscHYpblzZAd2kjZp2YmuYHjAAfbTViJWxoPTw=
+github.com/qdm12/log v0.1.0/go.mod h1:Vchi5M8uBvHfPNIblN4mjXn/oSbiWguQIbsgF1zdQPI=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
 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 h1:Jh8cai0fqIK+f6nG0UgPW5wFk8wmiMhM3AyciDBdtQg=
-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/net v0.0.0-20181005035420-146acd28ed58 h1:otZG8yDCO4LVps5+9bxOeNiCvgmOyt96J3roHTYs7oE=
-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/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/exp v0.0.0-20231110203233-9a3e6036ecaa h1:FRnLl4eNAQl8hwxVVC17teOw8kdjVDVAiFMtgUdTSRQ=
+golang.org/x/exp v0.0.0-20231110203233-9a3e6036ecaa/go.mod h1:zk2irFbV9DP96SEBUUAy67IdHUaZuSnrz1n472HUCLE=
+golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
+golang.org/x/mod v0.21.0 h1:vvrHzRwRfVKSiLrG+d4FMl/Qi4ukBCE6kZlTUkDYRT0=
+golang.org/x/mod v0.21.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
 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-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM=
+golang.org/x/net v0.29.0 h1:5ORfpBpCs4HzDYoodCDBbwHzdR5UrLBZ3sOnUJmFoHo=
+golang.org/x/net v0.29.0/go.mod h1:gLkgy8jTGERgjzMic6DS9+SP0ajcu6Xu3Orq/SpETg0=
+golang.org/x/oauth2 v0.23.0 h1:PbgcYx2W7i4LvjJWEbf0ngHV6qJYr86PkAV3bXdLEbs=
+golang.org/x/oauth2 v0.23.0/go.mod h1:XYTD2NtWslqkgxebSiOHnXEap4TF09sJSc7H1sXbhtI=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M=
+golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34=
+golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+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-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.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.18.0 h1:XvMDiNzPAl0jr17s6W9lcaIhGUfUORdGCNsuLmPG224=
+golang.org/x/text v0.18.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
+golang.org/x/tools v0.22.0 h1:gqSGLZqv+AI9lIQzniJ0nZDRG5GBPsSi+DRNHWNz6yA=
+golang.org/x/tools v0.22.0/go.mod h1:aCwcsjqvq7Yqt6TNyX7QMU2enbQ/Gt0bo6krSeEri+c=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+google.golang.org/protobuf v1.34.1 h1:9ddQBjfCyZPOHPUiPxpYESBLc+T8P3E+Vo4IbKZgFWg=
+google.golang.org/protobuf v1.34.1/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 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/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=
-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=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+kernel.org/pub/linux/libs/security/libcap/cap v1.2.69 h1:N0m3tKYbkRMmDobh/47ngz+AWeV7PcfXMDi8xu3Vrag=
+kernel.org/pub/linux/libs/security/libcap/cap v1.2.69/go.mod h1:Tk5Ip2TuxaWGpccL7//rAsLRH6RQ/jfqTGxuN/+i/FQ=
+kernel.org/pub/linux/libs/security/libcap/psx v1.2.69 h1:IdrOs1ZgwGw5CI+BH6GgVVlOt+LAXoPyh7enr8lfaXs=
+kernel.org/pub/linux/libs/security/libcap/psx v1.2.69/go.mod h1:+l6Ee2F59XiJ2I6WR5ObpC1utCQJZ/VLsEbQCD8RG24=

internal/backup/interfaces.go

@@ -0,0 +1,5 @@
+package backup
+
+type Logger interface {
+	Info(message string)
+}

internal/backup/service.go

@@ -0,0 +1,97 @@
+package backup
+
+import (
+	"context"
+	"path/filepath"
+	"strconv"
+	"time"
+)
+
+type Service struct {
+	// Injected fields
+	backupPeriod time.Duration
+	dataDir      string
+	outputDir    string
+	logger       Logger
+
+	// Internal fields
+	stopCh chan<- struct{}
+	done   <-chan struct{}
+}
+
+func New(backupPeriod time.Duration,
+	dataDir, outputDir string, logger Logger) *Service {
+	return &Service{
+		logger:       logger,
+		backupPeriod: backupPeriod,
+		dataDir:      dataDir,
+		outputDir:    outputDir,
+	}
+}
+
+func (s *Service) String() string {
+	return "backup"
+}
+
+func makeZipFileName() string {
+	return "ddns-updater-backup-" + strconv.Itoa(int(time.Now().UnixNano())) + ".zip"
+}
+
+func (s *Service) Start(ctx context.Context) (runError <-chan error, startErr error) {
+	ready := make(chan struct{})
+	runErrorCh := make(chan error)
+	stopCh := make(chan struct{})
+	s.stopCh = stopCh
+	done := make(chan struct{})
+	s.done = done
+	go run(ready, runErrorCh, stopCh, done,
+		s.outputDir, s.dataDir, s.backupPeriod, s.logger)
+	select {
+	case <-ready:
+	case <-ctx.Done():
+		return nil, s.Stop()
+	}
+	return runErrorCh, nil
+}
+
+func run(ready chan<- struct{}, runError chan<- error, stopCh <-chan struct{},
+	done chan<- struct{}, outputDir, dataDir string, backupPeriod time.Duration,
+	logger Logger) {
+	defer close(done)
+
+	if backupPeriod == 0 {
+		close(ready)
+		logger.Info("disabled")
+		return
+	}
+
+	logger.Info("each " + backupPeriod.String() +
+		"; writing zip files to directory " + outputDir)
+	timer := time.NewTimer(backupPeriod)
+	close(ready)
+
+	for {
+		select {
+		case <-timer.C:
+		case <-stopCh:
+			_ = timer.Stop()
+			return
+		}
+		err := zipFiles(
+			filepath.Join(outputDir, makeZipFileName()),
+			filepath.Join(dataDir, "config.json"),
+			filepath.Join(dataDir, "updates.json"),
+		)
+		if err != nil {
+			runError <- err
+			return
+		}
+		timer.Reset(backupPeriod)
+	}
+}
+
+func (s *Service) Stop() (err error) {
+	close(s.stopCh)
+	<-s.done
+	return nil
+}

internal/backup/zip.go

@@ -0,0 +1,50 @@
+package backup
+
+import (
+	"archive/zip"
+	"io"
+	"os"
+)
+
+func zipFiles(outputFilepath string, inputFilepaths ...string) error {
+	f, err := os.Create(outputFilepath)
+	if err != nil {
+		return err
+	}
+	defer f.Close()
+	w := zip.NewWriter(f)
+	defer w.Close()
+	for _, filepath := range inputFilepaths {
+		err = addFile(w, filepath)
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func addFile(w *zip.Writer, filepath string) error {
+	f, err := os.Open(filepath)
+	if err != nil {
+		return err
+	}
+	defer f.Close()
+	info, err := f.Stat()
+	if err != nil {
+		return err
+	}
+	header, err := zip.FileInfoHeader(info)
+	if err != nil {
+		return err
+	}
+	// Using FileInfoHeader() above only uses the basename of the file. If we want
+	// to preserve the folder structure we can overwrite this with the full path.
+	// header.Name = filepath
+	header.Method = zip.Deflate
+	ioWriter, err := w.CreateHeader(header)
+	if err != nil {
+		return err
+	}
+	_, err = io.Copy(ioWriter, f)
+	return err
+}

internal/config/backup.go

@@ -0,0 +1,47 @@
+package config
+
+import (
+	"time"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gotree"
+)
+
+type Backup struct {
+	Period    *time.Duration
+	Directory *string
+}
+
+func (b *Backup) setDefaults() {
+	b.Period = gosettings.DefaultPointer(b.Period, 0)
+	b.Directory = gosettings.DefaultPointer(b.Directory, "./data")
+}
+
+func (b Backup) Validate() (err error) {
+	return nil
+}
+
+func (b Backup) String() string {
+	return b.toLinesNode().String()
+}
+
+func (b Backup) toLinesNode() *gotree.Node {
+	if *b.Period == 0 {
+		return gotree.New("Backup: disabled")
+	}
+	node := gotree.New("Backup")
+	node.Appendf("Period: %s", b.Period)
+	node.Appendf("Directory: %s", *b.Directory)
+	return node
+}
+
+func (b *Backup) read(reader *reader.Reader) (err error) {
+	b.Period, err = reader.DurationPtr("BACKUP_PERIOD")
+	if err != nil {
+		return err
+	}
+
+	b.Directory = reader.Get("BACKUP_DIRECTORY")
+	return nil
+}

internal/config/client.go

@@ -0,0 +1,41 @@
+package config
+
+import (
+	"time"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gotree"
+)
+
+type Client struct {
+	Timeout time.Duration
+}
+
+func (c *Client) setDefaults() {
+	const defaultTimeout = 20 * time.Second
+	c.Timeout = gosettings.DefaultComparable(c.Timeout, defaultTimeout)
+}
+
+func (c Client) Validate() (err error) {
+	return nil
+}
+
+func (c Client) String() string {
+	return c.toLinesNode().String()
+}
+
+func (c Client) toLinesNode() *gotree.Node {
+	node := gotree.New("HTTP client")
+	node.Appendf("Timeout: %s", c.Timeout)
+	return node
+}
+
+func (c *Client) read(reader *reader.Reader) (err error) {
+	c.Timeout, err = reader.Duration("HTTP_TIMEOUT")
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/config/health.go

@@ -0,0 +1,58 @@
+package config
+
+import (
+	"fmt"
+	"net/url"
+	"os"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
+	"github.com/qdm12/gotree"
+)
+
+type Health struct {
+	ServerAddress         *string
+	HealthchecksioBaseURL string
+	HealthchecksioUUID    *string
+}
+
+func (h *Health) SetDefaults() {
+	h.ServerAddress = gosettings.DefaultPointer(h.ServerAddress, "127.0.0.1:9999")
+	h.HealthchecksioBaseURL = gosettings.DefaultComparable(h.HealthchecksioBaseURL, "https://hc-ping.com")
+	h.HealthchecksioUUID = gosettings.DefaultPointer(h.HealthchecksioUUID, "")
+}
+
+func (h Health) Validate() (err error) {
+	err = validate.ListeningAddress(*h.ServerAddress, os.Getuid())
+	if err != nil {
+		return fmt.Errorf("server listening address: %w", err)
+	}
+
+	_, err = url.Parse(h.HealthchecksioBaseURL)
+	if err != nil {
+		return fmt.Errorf("healthchecks.io base URL: %w", err)
+	}
+
+	return nil
+}
+
+func (h Health) String() string {
+	return h.toLinesNode().String()
+}
+
+func (h Health) toLinesNode() *gotree.Node {
+	node := gotree.New("Health")
+	node.Appendf("Server listening address: %s", *h.ServerAddress)
+	if *h.HealthchecksioUUID != "" {
+		node.Appendf("Healthchecks.io base URL: %s", h.HealthchecksioBaseURL)
+		node.Appendf("Healthchecks.io UUID: %s", *h.HealthchecksioUUID)
+	}
+	return node
+}
+
+func (h *Health) Read(reader *reader.Reader) {
+	h.ServerAddress = reader.Get("HEALTH_SERVER_ADDRESS")
+	h.HealthchecksioBaseURL = reader.String("HEALTH_HEALTHCHECKSIO_BASE_URL")
+	h.HealthchecksioUUID = reader.Get("HEALTH_HEALTHCHECKSIO_UUID")
+}

internal/config/helpers.go

@@ -0,0 +1,3 @@
+package config
+
+const all = "all"

internal/config/logger.go

@@ -0,0 +1,65 @@
+package config
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
+	"github.com/qdm12/gotree"
+	"github.com/qdm12/log"
+)
+
+type Logger struct {
+	Level  string
+	Caller string
+}
+
+func (l *Logger) setDefaults() {
+	l.Level = gosettings.DefaultComparable(l.Level, log.LevelInfo.String())
+	l.Caller = gosettings.DefaultComparable(l.Caller, "hidden")
+}
+
+func (l Logger) Validate() (err error) {
+	_, err = log.ParseLevel(l.Level)
+	if err != nil {
+		return fmt.Errorf("log level: %w", err)
+	}
+
+	err = validate.IsOneOf(l.Caller, "hidden", "short")
+	if err != nil {
+		return fmt.Errorf("log caller: %w", err)
+	}
+
+	return nil
+}
+
+func (l Logger) ToOptions() (options []log.Option) {
+	level, _ := log.ParseLevel(l.Level)
+	options = append(options, log.SetLevel(level))
+	if l.Caller == "short" {
+		options = append(options, log.SetCallerFile(true), log.SetCallerLine(true))
+	}
+	return options
+}
+
+func (l Logger) String() string {
+	return l.toLinesNode().String()
+}
+
+func (l Logger) toLinesNode() *gotree.Node {
+	node := gotree.New("Logger")
+	node.Appendf("Level: %s", l.Level)
+	node.Appendf("Caller: %s", l.Caller)
+	return node
+}
+
+func (l *Logger) read(reader *reader.Reader) {
+	l.Level = reader.String("LOG_LEVEL")
+	// Retro compatibility
+	if strings.ToLower(l.Level) == "warning" {
+		l.Level = "warn"
+	}
+	l.Caller = reader.String("LOG_CALLER")
+}

internal/config/paths.go

@@ -0,0 +1,73 @@
+package config
+
+import (
+	"fmt"
+	"io/fs"
+	"path/filepath"
+	"strconv"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gotree"
+)
+
+type Paths struct {
+	DataDir *string
+	Config  *string
+	// Umask is the custom umask to use for the system, if different than zero.
+	// If it is set to zero, the system umask is unchanged.
+	// It cannot be nil in the internal state.
+	Umask *fs.FileMode
+}
+
+func (p *Paths) setDefaults() {
+	p.DataDir = gosettings.DefaultPointer(p.DataDir, "./data")
+	defaultConfig := filepath.Join(*p.DataDir, "config.json")
+	p.Config = gosettings.DefaultPointer(p.Config, defaultConfig)
+	p.Umask = gosettings.DefaultPointer(p.Umask, fs.FileMode(0))
+}
+
+func (p Paths) Validate() (err error) {
+	return nil
+}
+
+func (p Paths) String() string {
+	return p.toLinesNode().String()
+}
+
+func (p Paths) toLinesNode() *gotree.Node {
+	node := gotree.New("Paths")
+	node.Appendf("Data directory: %s", *p.DataDir)
+	node.Appendf("Config file: %s", *p.Config)
+	umaskString := "system default"
+	if *p.Umask != 0 {
+		umaskString = p.Umask.String()
+	}
+	node.Appendf("Umask: %s", umaskString)
+	return node
+}
+
+func (p *Paths) read(reader *reader.Reader) (err error) {
+	p.DataDir = reader.Get("DATADIR")
+	p.Config = reader.Get("CONFIG_FILEPATH")
+
+	umaskString := reader.String("UMASK")
+	if umaskString != "" {
+		umask, err := parseUmask(umaskString)
+		if err != nil {
+			return fmt.Errorf("parse umask: %w", err)
+		}
+		p.Umask = &umask
+	}
+
+	return nil
+}
+
+func parseUmask(s string) (umask fs.FileMode, err error) {
+	const base, bitSize = 8, 32
+	umaskUint64, err := strconv.ParseUint(s, base, bitSize)
+	if err != nil {
+		return 0, err
+	}
+	return fs.FileMode(umaskUint64), nil
+}

internal/config/paths_test.go

@@ -0,0 +1,47 @@
+package config
+
+import (
+	"io/fs"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_parseUmask(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		s          string
+		umask      fs.FileMode
+		errMessage string
+	}{
+		"invalid": {
+			s:          "a",
+			errMessage: `strconv.ParseUint: parsing "a": invalid syntax`,
+		},
+		"704": {
+			s:     "704",
+			umask: 0o704,
+		},
+		"0704": {
+			s:     "0704",
+			umask: 0o0704,
+		},
+	}
+
+	for name, testCase := range testCases {
+		testCase := testCase
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			umask, err := parseUmask(testCase.s)
+
+			if testCase.errMessage != "" {
+				assert.EqualError(t, err, testCase.errMessage)
+			} else {
+				assert.NoError(t, err)
+			}
+			assert.Equal(t, testCase.umask, umask)
+		})
+	}
+}

internal/config/pubip.go

@@ -0,0 +1,339 @@
+package config
+
+import (
+	"errors"
+	"fmt"
+	"net/url"
+	"strings"
+	"time"
+
+	"github.com/qdm12/ddns-updater/pkg/publicip/dns"
+	"github.com/qdm12/ddns-updater/pkg/publicip/http"
+	"github.com/qdm12/ddns-updater/pkg/publicip/ipversion"
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
+	"github.com/qdm12/gotree"
+)
+
+type PubIP struct {
+	HTTPEnabled       *bool
+	HTTPIPProviders   []string
+	HTTPIPv4Providers []string
+	HTTPIPv6Providers []string
+	DNSEnabled        *bool
+	DNSProviders      []string
+	DNSTimeout        time.Duration
+}
+
+func (p *PubIP) setDefaults() {
+	p.HTTPEnabled = gosettings.DefaultPointer(p.HTTPEnabled, true)
+	p.HTTPIPProviders = gosettings.DefaultSlice(p.HTTPIPProviders, []string{all})
+	p.HTTPIPv4Providers = gosettings.DefaultSlice(p.HTTPIPv4Providers, []string{all})
+	p.HTTPIPv6Providers = gosettings.DefaultSlice(p.HTTPIPv6Providers, []string{all})
+	p.DNSEnabled = gosettings.DefaultPointer(p.DNSEnabled, true)
+	p.DNSProviders = gosettings.DefaultSlice(p.DNSProviders, []string{all})
+	const defaultDNSTimeout = 3 * time.Second
+	p.DNSTimeout = gosettings.DefaultComparable(p.DNSTimeout, defaultDNSTimeout)
+}
+
+func (p PubIP) Validate() (err error) {
+	err = p.validateHTTPIPProviders()
+	if err != nil {
+		return fmt.Errorf("HTTP IP providers: %w", err)
+	}
+
+	err = p.validateHTTPIPv4Providers()
+	if err != nil {
+		return fmt.Errorf("HTTP IPv4 providers: %w", err)
+	}
+
+	err = p.validateHTTPIPv6Providers()
+	if err != nil {
+		return fmt.Errorf("HTTP IPv6 providers: %w", err)
+	}
+
+	err = p.validateDNSProviders()
+	if err != nil {
+		return fmt.Errorf("DNS providers: %w", err)
+	}
+
+	return nil
+}
+
+func (p *PubIP) String() string {
+	return p.toLinesNode().String()
+}
+
+func (p *PubIP) toLinesNode() (node *gotree.Node) {
+	node = gotree.New("Public IP fetching")
+
+	node.Appendf("HTTP enabled: %s", gosettings.BoolToYesNo(p.HTTPEnabled))
+	if *p.HTTPEnabled {
+		childNode := node.Appendf("HTTP IP providers")
+		for _, provider := range p.HTTPIPProviders {
+			childNode.Appendf(provider)
+		}
+
+		childNode = node.Appendf("HTTP IPv4 providers")
+		for _, provider := range p.HTTPIPv4Providers {
+			childNode.Appendf(provider)
+		}
+
+		childNode = node.Appendf("HTTP IPv6 providers")
+		for _, provider := range p.HTTPIPv6Providers {
+			childNode.Appendf(provider)
+		}
+	}
+
+	node.Appendf("DNS enabled: %s", gosettings.BoolToYesNo(p.DNSEnabled))
+	if *p.DNSEnabled {
+		node.Appendf("DNS timeout: %s", p.DNSTimeout)
+		childNode := node.Appendf("DNS over TLS providers")
+		for _, provider := range p.DNSProviders {
+			childNode.Appendf(provider)
+		}
+	}
+
+	return node
+}
+
+// ToHTTPOptions assumes the settings have been validated.
+func (p *PubIP) ToHTTPOptions() (options []http.Option) {
+	httpIPProviders := stringsToHTTPProviders(p.HTTPIPProviders, ipversion.IP4or6)
+	httpIPv4Providers := stringsToHTTPProviders(p.HTTPIPv4Providers, ipversion.IP4)
+	httpIPv6Providers := stringsToHTTPProviders(p.HTTPIPv6Providers, ipversion.IP6)
+	return []http.Option{
+		http.SetProvidersIP(httpIPProviders[0], httpIPProviders[1:]...),
+		http.SetProvidersIP4(httpIPv4Providers[0], httpIPv4Providers[1:]...),
+		http.SetProvidersIP6(httpIPv6Providers[0], httpIPv6Providers[1:]...),
+	}
+}
+
+func stringsToHTTPProviders(providers []string, ipVersion ipversion.IPVersion) (
+	updatedProviders []http.Provider) {
+	updatedProvidersSet := make(map[string]struct{}, len(providers))
+	for _, provider := range providers {
+		if provider != all {
+			updatedProvidersSet[provider] = struct{}{}
+			continue
+		}
+
+		allProviders := http.ListProvidersForVersion(ipVersion)
+		for _, provider := range allProviders {
+			updatedProvidersSet[string(provider)] = struct{}{}
+		}
+	}
+
+	updatedProviders = make([]http.Provider, 0, len(updatedProvidersSet))
+	for provider := range updatedProvidersSet {
+		updatedProviders = append(updatedProviders, http.Provider(provider))
+	}
+
+	return updatedProviders
+}
+
+// ToDNSPOptions assumes the settings have been validated.
+func (p *PubIP) ToDNSPOptions() (options []dns.Option) {
+	uniqueProviders := make(map[string]struct{}, len(p.DNSProviders))
+	for _, provider := range p.DNSProviders {
+		if provider != all {
+			uniqueProviders[provider] = struct{}{}
+		}
+
+		allProviders := dns.ListProviders()
+		for _, provider := range allProviders {
+			uniqueProviders[string(provider)] = struct{}{}
+		}
+	}
+
+	providers := make([]dns.Provider, 0, len(uniqueProviders))
+	for providerString := range uniqueProviders {
+		providers = append(providers, dns.Provider(providerString))
+	}
+
+	return []dns.Option{
+		dns.SetTimeout(p.DNSTimeout),
+		dns.SetProviders(providers[0], providers[1:]...),
+	}
+}
+
+var (
+	ErrNoPublicIPDNSProvider = errors.New("no public IP DNS provider specified")
+)
+
+func (p PubIP) validateDNSProviders() (err error) {
+	if len(p.DNSProviders) == 0 {
+		return fmt.Errorf("%w", ErrNoPublicIPDNSProvider)
+	}
+
+	availableProviders := dns.ListProviders()
+	validChoices := make([]string, len(availableProviders)+1)
+	for i, provider := range availableProviders {
+		validChoices[i] = string(provider)
+	}
+	validChoices[len(validChoices)-1] = all
+	return validate.AreAllOneOf(p.DNSProviders, validChoices)
+}
+
+func (p PubIP) validateHTTPIPProviders() (err error) {
+	return validateHTTPIPProviders(p.HTTPIPProviders, ipversion.IP4or6)
+}
+
+func (p PubIP) validateHTTPIPv4Providers() (err error) {
+	return validateHTTPIPProviders(p.HTTPIPv4Providers, ipversion.IP4)
+}
+
+func (p PubIP) validateHTTPIPv6Providers() (err error) {
+	return validateHTTPIPProviders(p.HTTPIPv6Providers, ipversion.IP6)
+}
+
+var (
+	ErrNoPublicIPHTTPProvider = errors.New("no public IP HTTP provider specified")
+	ErrURLIsNotValidHTTPS     = errors.New("URL is not valid or not HTTPS")
+)
+
+func validateHTTPIPProviders(providerStrings []string,
+	version ipversion.IPVersion) (err error) {
+	if len(providerStrings) == 0 {
+		return fmt.Errorf("%w", ErrNoPublicIPHTTPProvider)
+	}
+
+	availableProviders := http.ListProvidersForVersion(version)
+	choices := make(map[string]struct{}, len(availableProviders)+1)
+	choices[all] = struct{}{}
+	for i := range availableProviders {
+		choices[string(availableProviders[i])] = struct{}{}
+	}
+
+	for _, providerString := range providerStrings {
+		if providerString == "noip" {
+			// NoIP is no longer supported because the echo service
+			// only works over plaintext HTTP and could be tempered with.
+			// Silently discard it and it will default to another HTTP IP
+			// echo service.
+			continue
+		}
+
+		// Custom URL check
+		if strings.HasPrefix(providerString, "url:") {
+			url, err := url.Parse(providerString[4:])
+			if err != nil || url.Scheme != "https" {
+				return fmt.Errorf("%w: %s", ErrURLIsNotValidHTTPS, providerString)
+			}
+			continue
+		}
+
+		_, ok := choices[providerString]
+		if !ok {
+			return fmt.Errorf("%w: %s", validate.ErrValueNotOneOf, providerString)
+		}
+	}
+
+	return nil
+}
+
+func (p *PubIP) read(r *reader.Reader, warner Warner) (err error) {
+	p.HTTPEnabled, p.DNSEnabled, err = getFetchers(r)
+	if err != nil {
+		return err
+	}
+
+	p.HTTPIPProviders = r.CSV("PUBLICIP_HTTP_PROVIDERS",
+		reader.RetroKeys("IP_METHOD"))
+	p.HTTPIPv4Providers = r.CSV("PUBLICIPV4_HTTP_PROVIDERS",
+		reader.RetroKeys("IPV4_METHOD"))
+	p.HTTPIPv6Providers = r.CSV("PUBLICIPV6_HTTP_PROVIDERS",
+		reader.RetroKeys("IPV6_METHOD"))
+
+	// Retro-compatibility
+	for i := range p.HTTPIPProviders {
+		p.HTTPIPProviders[i] = handleRetroProvider(p.HTTPIPProviders[i])
+	}
+	for i := range p.HTTPIPv4Providers {
+		p.HTTPIPv4Providers[i] = handleRetroProvider(p.HTTPIPv4Providers[i])
+	}
+	for i := range p.HTTPIPv6Providers {
+		p.HTTPIPv6Providers[i] = handleRetroProvider(p.HTTPIPv6Providers[i])
+	}
+
+	// Retro-compatibility for now defunct opendns http provider for ipv4 or ipv6
+	if len(p.HTTPIPProviders) > 0 { // check to avoid transforming `nil` to `[]`
+		httpIPProvidersTemp := make([]string, len(p.HTTPIPProviders))
+		copy(httpIPProvidersTemp, p.HTTPIPProviders)
+		p.HTTPIPProviders = make([]string, 0, len(p.HTTPIPProviders))
+		for _, provider := range httpIPProvidersTemp {
+			switch provider {
+			case "opendns": // no longer available, for a long time
+			case "google": // found no longer working on 2024.09.17
+				warner.Warnf("http provider google will be ignored " +
+					"since it is no longer supported by Google")
+			default:
+				p.HTTPIPProviders = append(p.HTTPIPProviders, provider)
+			}
+		}
+	}
+
+	p.DNSProviders = r.CSV("PUBLICIP_DNS_PROVIDERS")
+
+	// Retro-compatibility
+	for i, provider := range p.DNSProviders {
+		if provider == "google" {
+			warner.Warnf("dns provider google will be ignored " +
+				"since it is no longer supported, " +
+				"see https://github.com/qdm12/ddns-updater/issues/492")
+			p.DNSProviders[i] = p.DNSProviders[len(p.DNSProviders)-1]
+			p.DNSProviders = p.DNSProviders[:len(p.DNSProviders)-1]
+		}
+	}
+
+	p.DNSTimeout, err = r.Duration("PUBLICIP_DNS_TIMEOUT")
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+var ErrFetcherNotValid = errors.New("fetcher is not valid")
+
+func getFetchers(reader *reader.Reader) (http, dns *bool, err error) {
+	// TODO change to use reader.BoolPtr with retro-compatibility
+	s := reader.String("PUBLICIP_FETCHERS")
+	if s == "" {
+		return nil, nil, nil
+	}
+
+	http, dns = new(bool), new(bool)
+	fields := strings.Split(s, ",")
+	for i, field := range fields {
+		switch strings.ToLower(field) {
+		case "all":
+			*http = true
+			*dns = true
+		case "http":
+			*http = true
+		case "dns":
+			*dns = true
+		default:
+			return nil, nil, fmt.Errorf(
+				"%w: %q at position %d of %d",
+				ErrFetcherNotValid, field, i+1, len(fields))
+		}
+	}
+
+	return http, dns, nil
+}
+
+func handleRetroProvider(provider string) (updatedProvider string) {
+	switch provider {
+	case "ipify6":
+		return "ipify"
+	case "noip4", "noip6", "noip8245_4", "noip8245_6":
+		return "noip"
+	case "cycle":
+		return "all"
+	default:
+		return provider
+	}
+}

internal/config/resolver.go

@@ -0,0 +1,80 @@
+package config
+
+import (
+	"errors"
+	"fmt"
+	"net"
+	"time"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gotree"
+)
+
+type Resolver struct {
+	Address *string
+	Timeout time.Duration
+}
+
+func (r *Resolver) setDefaults() {
+	r.Address = gosettings.DefaultPointer(r.Address, "")
+	const defaultTimeout = 5 * time.Second
+	r.Timeout = gosettings.DefaultComparable(r.Timeout, defaultTimeout)
+}
+
+var (
+	ErrAddressHostEmpty = errors.New("address host is empty")
+	ErrAddressPortEmpty = errors.New("address port is empty")
+	ErrTimeoutTooLow    = errors.New("timeout is too low")
+)
+
+func (r Resolver) Validate() (err error) {
+	if *r.Address != "" {
+		host, port, err := net.SplitHostPort(*r.Address)
+		if err != nil {
+			return fmt.Errorf("splitting host and port from address: %w", err)
+		}
+
+		switch {
+		case host == "":
+			return fmt.Errorf("%w: in %s", ErrAddressHostEmpty, *r.Address)
+		case port == "":
+			return fmt.Errorf("%w: in %s", ErrAddressPortEmpty, *r.Address)
+		}
+	}
+
+	const minTimeout = 10 * time.Millisecond
+	if r.Timeout < minTimeout {
+		return fmt.Errorf("%w: %s is below the minimum %s",
+			ErrTimeoutTooLow, r.Timeout, minTimeout)
+	}
+
+	return nil
+}
+
+func (r Resolver) String() string {
+	return r.ToLinesNode().String()
+}
+
+func (r Resolver) ToLinesNode() *gotree.Node {
+	if *r.Address == "" {
+		return gotree.New("Resolver: use Go default resolver")
+	}
+
+	node := gotree.New("Resolver")
+	node.Appendf("Address: %s", *r.Address)
+	node.Appendf("Timeout: %s", r.Timeout)
+	return node
+}
+
+func (r *Resolver) read(reader *reader.Reader) (err error) {
+	r.Address = reader.Get("RESOLVER_ADDRESS")
+	if r.Address != nil { // conveniently add port 53 if not specified
+		_, port, err := net.SplitHostPort(*r.Address)
+		if err == nil && port == "" {
+			*r.Address += ":53"
+		}
+	}
+	r.Timeout, err = reader.Duration("RESOLVER_TIMEOUT")
+	return err
+}

internal/config/retrocompat.go

@@ -0,0 +1,10 @@
+package config
+
+type Warner interface {
+	Warnf(format string, a ...interface{})
+}
+
+func handleDeprecated(warner Warner, oldKey, newKey string) {
+	warner.Warnf("You are using an old environment variable %s, please change it to %s",
+		oldKey, newKey)
+}

internal/config/server.go

@@ -0,0 +1,70 @@
+package config
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/qdm12/gosettings"
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gosettings/validate"
+	"github.com/qdm12/gotree"
+)
+
+type Server struct {
+	Enabled          *bool
+	ListeningAddress string
+	RootURL          string
+}
+
+func (s *Server) setDefaults() {
+	s.Enabled = gosettings.DefaultPointer(s.Enabled, true)
+	s.ListeningAddress = gosettings.DefaultComparable(s.ListeningAddress, ":8000")
+	s.RootURL = gosettings.DefaultComparable(s.RootURL, "/")
+}
+
+func (s Server) Validate() (err error) {
+	err = validate.ListeningAddress(s.ListeningAddress, os.Getuid())
+	if err != nil {
+		return fmt.Errorf("listening address: %w", err)
+	}
+
+	// TODO validate RootURL
+
+	return nil
+}
+
+func (s Server) String() string {
+	return s.toLinesNode().String()
+}
+
+func (s Server) toLinesNode() *gotree.Node {
+	if !*s.Enabled {
+		return gotree.New("Server: disabled")
+	}
+	node := gotree.New("Server")
+	node.Appendf("Listening address: %s", s.ListeningAddress)
+	node.Appendf("Root URL: %s", s.RootURL)
+	return node
+}
+
+func (s *Server) read(reader *reader.Reader, warner Warner) (err error) {
+	s.Enabled, err = reader.BoolPtr("SERVER_ENABLED")
+	if err != nil {
+		return err
+	}
+
+	s.RootURL = reader.String("ROOT_URL")
+
+	// Retro-compatibility
+	port, err := reader.Uint16Ptr("LISTENING_PORT") // TODO change to address
+	if err != nil {
+		handleDeprecated(warner, "LISTENING_PORT", "LISTENING_ADDRESS")
+		return err
+	} else if port != nil {
+		s.ListeningAddress = fmt.Sprintf(":%d", *port)
+	}
+
+	s.ListeningAddress = reader.String("LISTENING_ADDRESS")
+
+	return err
+}

internal/config/settings.go

@@ -0,0 +1,128 @@
+package config
+
+import (
+	"fmt"
+
+	"github.com/qdm12/gosettings/reader"
+	"github.com/qdm12/gotree"
+)
+
+type Config struct {
+	Client   Client
+	Update   Update
+	PubIP    PubIP
+	Resolver Resolver
+	Server   Server
+	Health   Health
+	Paths    Paths
+	Backup   Backup
+	Logger   Logger
+	Shoutrrr Shoutrrr
+}
+
+func (c *Config) SetDefaults() {
+	c.Client.setDefaults()
+	c.Update.setDefaults()
+	c.PubIP.setDefaults()
+	c.Resolver.setDefaults()
+	c.Server.setDefaults()
+	c.Health.SetDefaults()
+	c.Paths.setDefaults()
+	c.Backup.setDefaults()
+	c.Logger.setDefaults()
+	c.Shoutrrr.setDefaults()
+}
+
+func (c Config) Validate() (err error) {
+	type validator interface {
+		Validate() (err error)
+	}
+	toValidate := map[string]validator{
+		"client":    &c.Client,
+		"update":    &c.Update,
+		"public ip": &c.PubIP,
+		"resolver":  &c.Resolver,
+		"server":    &c.Server,
+		"health":    &c.Health,
+		"paths":     &c.Paths,
+		"backup":    &c.Backup,
+		"logger":    &c.Logger,
+		"shoutrrr":  &c.Shoutrrr,
+	}
+
+	for name, v := range toValidate {
+		err = v.Validate()
+		if err != nil {
+			return fmt.Errorf("%s settings: %w", name, err)
+		}
+	}
+
+	return nil
+}
+
+func (c Config) String() string {
+	return c.toLinesNode().String()
+}
+
+func (c Config) toLinesNode() *gotree.Node {
+	node := gotree.New("Settings summary:")
+	node.AppendNode(c.Client.toLinesNode())
+	node.AppendNode(c.Update.toLinesNode())
+	node.AppendNode(c.PubIP.toLinesNode())
+	node.AppendNode(c.Resolver.ToLinesNode())
+	node.AppendNode(c.Server.toLinesNode())
+	node.AppendNode(c.Health.toLinesNode())
+	node.AppendNode(c.Paths.toLinesNode())
+	node.AppendNode(c.Backup.toLinesNode())
+	node.AppendNode(c.Logger.toLinesNode())
+	node.AppendNode(c.Shoutrrr.ToLinesNode())
+	return node
+}
+
+func (c *Config) Read(reader *reader.Reader,
+	warner Warner) (err error) {
+	err = c.Client.read(reader)
+	if err != nil {
+		return fmt.Errorf("reading client settings: %w", err)
+	}
+
+	err = c.Update.read(reader, warner)
+	if err != nil {
+		return fmt.Errorf("reading update settings: %w", err)
+	}
+
+	err = c.PubIP.read(reader, warner)
+	if err != nil {
+		return fmt.Errorf("reading public IP settings: %w", err)
+	}
+
+	err = c.Resolver.read(reader)
+	if err != nil {
+		return fmt.Errorf("reading resolver settings: %w", err)
+	}
+
+	err = c.Server.read(reader, warner)
+	if err != nil {
+		return fmt.Errorf("reading server settings: %w", err)
+	}
+
+	c.Health.Read(reader)
+	err = c.Paths.read(reader)
+	if err != nil {
+		return fmt.Errorf("reading paths settings: %w", err)
+	}
+
+	err = c.Backup.read(reader)
+	if err != nil {
+		return fmt.Errorf("reading backup settings: %w", err)
+	}
+
+	c.Logger.read(reader)
+
+	err = c.Shoutrrr.read(reader, warner)
+	if err != nil {
+		return fmt.Errorf("reading shoutrrr settings: %w", err)
+	}
+
+	return nil
+}

internal/config/settings_test.go

@@ -0,0 +1,50 @@
+package config
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_Settings_String(t *testing.T) {
+	t.Parallel()
+
+	var defaultSettings Config
+	defaultSettings.SetDefaults()
+
+	s := defaultSettings.String()
+
+	const expected = `Settings summary:
+├── HTTP client
+|   └── Timeout: 20s
+├── Update
+|   ├── Period: 10m0s
+|   └── Cooldown: 5m0s
+├── Public IP fetching
+|   ├── HTTP enabled: yes
+|   ├── HTTP IP providers
+|   |   └── all
+|   ├── HTTP IPv4 providers
+|   |   └── all
+|   ├── HTTP IPv6 providers
+|   |   └── all
+|   ├── DNS enabled: yes
+|   ├── DNS timeout: 3s
+|   └── DNS over TLS providers
+|       └── all
+├── Resolver: use Go default resolver
+├── Server
+|   ├── Listening address: :8000
+|   └── Root URL: /
+├── Health
+|   └── Server listening address: 127.0.0.1:9999
+├── Paths
+|   ├── Data directory: ./data
+|   ├── Config file: data/config.json
+|   └── Umask: system default
+├── Backup: disabled
+└── Logger
+    ├── Level: INFO
+    └── Caller: hidden`
+	assert.Equal(t, expected, s)
+}