feat(provider): add vercel (#1065)

Fixes #1094

.devcontainer/.dockerignore

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

.devcontainer/Dockerfile

@@ -0,0 +1 @@
+FROM ghcr.io/qdm12/godevcontainer:v0.22.0-alpine

.devcontainer/README.md

@@ -0,0 +1,60 @@
+# Development container
+
+Development container that can be used with VSCode.
+
+It works on Linux, Windows (WSL2) 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 and directory on your host if you don't have them:
+
+    ```sh
+    touch ~/.gitconfig ~/.zsh_history
+    mkdir -p ~/.ssh
+    ```
+
+1. **For OSX hosts**: ensure the project directory and your home directory `~` are 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
+
+For any customization to take effect, you should "rebuild and reopen":
+
+1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P)
+2. Select `Dev-Containers: Rebuild Container`
+
+Changes you can make are notably:
+
+- Changes to the Docker image in [Dockerfile](Dockerfile)
+- Changes to VSCode **settings** and **extensions** in [devcontainer.json](devcontainer.json).
+- Change the entrypoint script by adding a bind mount in [devcontainer.json](devcontainer.json) of a shell script to `/root/.welcome.sh` to replace the [current welcome script](https://github.com/qdm12/godevcontainer/blob/master/shell/.welcome.sh). For example:
+
+    ```json
+    // Welcome script
+    {
+        "source": "/yourpath/.welcome.sh",
+        "target": "/root/.welcome.sh",
+        "type": "bind"
+    },
+    ```
+
+- Change the `vscode` service container configuration either in [docker-compose.yml](docker-compose.yml) or in [devcontainer.json](devcontainer.json).
+- Add other services in [docker-compose.yml](docker-compose.yml) to run together with the development VSCode service container. For example to add a test database:
+
+    ```yml
+      database:
+        image: postgres
+        restart: always
+        environment:
+          POSTGRES_PASSWORD: password
+    ```
+
+- More options are documented in the [devcontainer.json reference](https://containers.dev/implementors/json_reference/).

.devcontainer/devcontainer.json

@@ -1,116 +1,114 @@
-{
-    "name": "ddns-dev",
-    "dockerComposeFile": [
-        "docker-compose.yml"
-    ],
-    "service": "vscode",
-    "runServices": [
-        "vscode"
-    ],
-    "shutdownAction": "stopCompose",
-    "postCreateCommand": "go mod download",
-    "workspaceFolder": "/workspace",
-    "appPort": 8000,
-    "extensions": [
-        "golang.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",
-        "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
-        },
-        "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=integration"
-        },
-        "gopls.env": {
-            "GOFLAGS": "-tags=integration"
-        },
-        "go.testEnvVars": {},
-        "go.testFlags": [
-            "-v"
-        ],
-        "go.testTimeout": "600s"
-    }
+{
+    // See https://containers.dev/implementors/json_reference/
+    // User defined settings
+    "containerEnv": {
+        "TZ": ""
+    },
+    // Fixed settings
+    "name": "ddns-dev",
+    "postCreateCommand": "~/.windows.sh && go mod download && go mod tidy",
+    "dockerComposeFile": "docker-compose.yml",
+    "overrideCommand": true,
+    "service": "vscode",
+    "workspaceFolder": "/workspace",
+    "mounts": [
+        // Source code
+        {
+            "source": "../",
+            "target": "/workspace",
+            "type": "bind"
+        },
+        // Zsh commands history persistence
+        {
+            "source": "${localEnv:HOME}/.zsh_history",
+            "target": "/root/.zsh_history",
+            "type": "bind"
+        },
+        // Git configuration file
+        {
+            "source": "${localEnv:HOME}/.gitconfig",
+            "target": "/root/.gitconfig",
+            "type": "bind"
+        },
+        // 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.
+        {
+            "source": "${localEnv:HOME}/.ssh",
+            "target": "/mnt/ssh",
+            "type": "bind"
+        },
+        // Docker socket to access the host Docker server
+        {
+            "source": "/var/run/docker.sock",
+            "target": "/var/run/docker.sock",
+            "type": "bind"
+        }
+    ],
+    "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": "always"
+                    }
+                },
+                "gopls": {
+                    "formatting.gofumpt": true,
+                    "usePlaceholders": false,
+                    "staticcheck": true,
+                    "ui.diagnostic.analyses": {
+                        "ST1000": false
+                    },
+                    "vulncheck": "Imports"
+                },
+                "remote.extensionKind": {
+                    "ms-azuretools.vscode-docker": "workspace"
+                }
+            }
+        }
+    }
 }

.devcontainer/docker-compose.yml

@@ -1,15 +1,3 @@
-version: "3.7"
-
 services:
   vscode:
-    image: qmcgaw/godevcontainer
-    volumes:
-      - ../:/workspace
-      - ~/.ssh:/home/vscode/.ssh:ro
-      - ~/.ssh:/root/.ssh:ro
-      - /var/run/docker.sock:/var/run/docker.sock
-    cap_add:
-      - SYS_PTRACE
-    security_opt:
-      - seccomp:unconfined
-    entrypoint: zsh -c "while sleep 1000; do :; done"
+    build: .

.dockerignore

@@ -2,9 +2,11 @@
 .git
 .github
 .vscode
+docs
 readme
+!readme/*.go
 .gitignore
 config.json
 docker-compose.yml
 LICENSE
-README.md
+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 ghcr.io/qdm12/ddns-updater .`
+- Run the Docker container: `docker run -it --rm -v /yourpath/data:/updater/data ghcr.io/qdm12/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

@@ -1,52 +1,31 @@
 ---
 name: Bug
 about: Report a bug
-title: 'Bug: ...'
-labels: ":bug: bug"
-assignees: qdm12
+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?
+1. Is this urgent: Yes/No
+2. DNS provider(s) you use: Answer here
+3. Program version:
 
-    - [ ] Yes
-    - [x] No
-
-2. What DNS service provider(s) are you using?
-
-    - [x] Cloudflare
-    - [ ] DDNSS.de
-    - [ ] DonDominio
-    - [ ] DNSPod
-    - [ ] Dreamhost
-    - [ ] DuckDNS
-    - [ ] DynDNS
-    - [ ] GoDaddy
-    - [ ] Google
-    - [ ] He.net
-    - [ ] Infomaniak
-    - [ ] Namecheap
-    - [ ] NoIP
-
-3. What's the version of the program?
-
-    **See the line at the top of your logs**
+    <!-- See the line at the top of your logs -->
 
     `Running version latest built on 2020-03-13T01:30:06Z (commit d0f678c)`
 
-4. What are you using to run the container?
-
-    - [ ] Docker run
-    - [x] Docker Compose
-    - [ ] Kubernetes
-    - [ ] Docker stack
-    - [ ] Docker swarm
-    - [ ] Podman
-    - [ ] Other:
-
-5. Extra information
+4. What are you using to run the container: docker-compose
+5. Extra information (optional)
 
 Logs:
 

.github/ISSUE_TEMPLATE/feature_request.md

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

.github/ISSUE_TEMPLATE/help.md

@@ -1,52 +1,31 @@
 ---
 name: Help
 about: Ask for help
-title: 'Help: ...'
-labels: ":pray: help wanted"
-assignees:
+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?
+1. Is this urgent: Yes/No
+2. DNS provider(s) you use: Answer here
+3. Program version:
 
-    - [ ] Yes
-    - [x] No
-
-2. What DNS service provider(s) are you using?
-
-    - [x] Cloudflare
-    - [ ] DDNSS.de
-    - [ ] DonDominio
-    - [ ] DNSPod
-    - [ ] Dreamhost
-    - [ ] DuckDNS
-    - [ ] DynDNS
-    - [ ] GoDaddy
-    - [ ] Google
-    - [ ] He.net
-    - [ ] Infomaniak
-    - [ ] Namecheap
-    - [ ] NoIP
-
-3. What's the version of the program?
-
-    **See the line at the top of your logs**
+    <!-- See the line at the top of your logs -->
 
     `Running version latest built on 2020-03-13T01:30:06Z (commit d0f678c)`
 
-4. What are you using to run the container?
-
-    - [ ] Docker run
-    - [x] Docker Compose
-    - [ ] Kubernetes
-    - [ ] Docker stack
-    - [ ] Docker swarm
-    - [ ] Podman
-    - [ ] Other:
-
-5. Extra information
+4. What are you using to run the container: docker-compose
+5. Extra information (optional)
 
 Logs:
 
@@ -54,9 +33,9 @@ Logs:
 
 ```
 
-Configuration file:
+Configuration file (**remove your credentials!**):
 
-```yml
+```json
 
 ```
 

.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,31 +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-ignore:
-      - .devcontainer
-      - .github/ISSUE_TEMPLATE
-      - .github/workflows/build-branch.yml
-      - .github/workflows/buildx-release.yml
-      - .github/workflows/buildx-latest.yml
-      - .github/workflows/dockerhub-description.yml
-      - .github/workflows/labels.yml
-      - .github/CODEOWNERS
-      - .github/CONTRIBUTING.md
-      - .github/FUNDING.yml
-      - .github/labels.yml
-      - .vscode
-      - readme
-      - .gitignore
-      - config.json
-      - docker-compose.yml
-      - LICENSE
-      - README.md
+    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@v6
+
+      - 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@v6
+      - uses: actions/setup-go@v6
+        with:
+          go-version-file: go.mod
+      - uses: github/codeql-action/init@v4
+        with:
+          languages: go
+      - uses: github/codeql-action/autobuild@v4
+      - uses: github/codeql-action/analyze@v4
+
+  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@v6
+        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@v6
+        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@v4
+      - uses: docker/setup-buildx-action@v4
+
+      - uses: docker/login-action@v4
+        with:
+          username: qmcgaw
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - uses: docker/login-action@v4
+        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@v7
+        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@v6
+        with:
+          go-version-file: go.mod
+
+      - if: github.event_name == 'release'
+        uses: goreleaser/goreleaser-action@v7
+        with:
+          version: latest
+          args: release --clean --config .github/workflows/configs/.goreleaser.yaml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/buildx-branch.yml

@@ -1,47 +0,0 @@
-name: Buildx branch
-on:
-  push:
-    branches:
-      - '*'
-      - '*/*'
-      - '!master'
-    paths-ignore:
-      - .devcontainer
-      - .github/ISSUE_TEMPLATE
-      - .github/workflows/build.yml
-      - .github/workflows/buildx-release.yml
-      - .github/workflows/buildx-latest.yml
-      - .github/workflows/dockerhub-description.yml
-      - .github/workflows/labels.yml
-      - .github/CODEOWNERS
-      - .github/CONTRIBUTING.md
-      - .github/FUNDING.yml
-      - .github/labels.yml
-      - .vscode
-      - readme
-      - .gitignore
-      - config.json
-      - docker-compose.yml
-      - LICENSE
-      - README.md
-jobs:
-  buildx:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Buildx setup
-        uses: crazy-max/ghaction-docker-buildx@v1
-      - name: Dockerhub login
-        run: echo ${{ secrets.DOCKERHUB_PASSWORD }} | docker login -u qmcgaw --password-stdin 2>&1
-      - name: Run Buildx
-        run: |
-          docker buildx build \
-            --progress plain \
-            --platform=linux/amd64,linux/386,linux/arm64,linux/arm/v7 \
-            --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/buildx-latest.yml

@@ -1,44 +0,0 @@
-name: Buildx latest
-on:
-  push:
-    branches: [master]
-    paths-ignore:
-      - .devcontainer
-      - .github/ISSUE_TEMPLATE
-      - .github/workflows/build.yml
-      - .github/workflows/buildx-release.yml
-      - .github/workflows/buildx-branch.yml
-      - .github/workflows/dockerhub-description.yml
-      - .github/workflows/labels.yml
-      - .github/CODEOWNERS
-      - .github/CONTRIBUTING.md
-      - .github/FUNDING.yml
-      - .github/labels.yml
-      - .vscode
-      - readme
-      - .gitignore
-      - config.json
-      - docker-compose.yml
-      - LICENSE
-      - README.md
-jobs:
-  buildx:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Buildx setup
-        uses: crazy-max/ghaction-docker-buildx@v1
-      - name: Dockerhub login
-        run: echo ${{ secrets.DOCKERHUB_PASSWORD }} | docker login -u qmcgaw --password-stdin 2>&1
-      - name: Run Buildx
-        run: |
-          docker buildx build \
-            --progress plain \
-            --platform=linux/amd64,linux/386,linux/arm64,linux/arm/v7 \
-            --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,44 +0,0 @@
-name: Buildx release
-on:
-  release:
-    types: [published]
-    paths-ignore:
-      - .devcontainer
-      - .github/ISSUE_TEMPLATE
-      - .github/workflows/build.yml
-      - .github/workflows/buildx-branch.yml
-      - .github/workflows/buildx-latest.yml
-      - .github/workflows/dockerhub-description.yml
-      - .github/workflows/labels.yml
-      - .github/CODEOWNERS
-      - .github/CONTRIBUTING.md
-      - .github/FUNDING.yml
-      - .github/labels.yml
-      - .vscode
-      - readme
-      - .gitignore
-      - config.json
-      - docker-compose.yml
-      - LICENSE
-      - README.md
-jobs:
-  buildx:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Buildx setup
-        uses: crazy-max/ghaction-docker-buildx@v1
-      - name: Dockerhub login
-        run: echo ${{ secrets.DOCKERHUB_PASSWORD }} | docker login -u qmcgaw --password-stdin 2>&1
-      - name: Run Buildx
-        run: |
-          docker buildx build \
-            --progress plain \
-            --platform=linux/amd64,linux/386,linux/arm64,linux/arm/v7 \
-            --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,49 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^http://localhost"
+    },
+    {
+      "pattern": "^https://api(6|64).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/$"
+    },
+    {
+      "pattern": "^https://my.vultr.com/settings/#settingsapi$"
+    },
+    {
+      "pattern": "^https://www.namesilo.com"
+    }
+  ],
+  "timeout": "20s",
+  "retryOn429": false,
+  "fallbackRetryDelay": "30s",
+  "aliveStatusCodes": [
+    200,
+    206,
+    403,
+    429
+  ]
+}

.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/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@v6
       - name: Labeler
         if: success()
-        uses: crazy-max/ghaction-github-labeler@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: crazy-max/ghaction-github-labeler@v6
+        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@v6
+
+      - uses: DavidAnson/markdownlint-cli2-action@v23
+        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@v5
+        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

.gitignore

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

.golangci.yml

@@ -1,46 +1,124 @@
-linters-settings:
-  maligned:
-    suggest-new: true
-  misspell:
-    locale: US
+version: "2"
+
+formatters:
+  enable:
+    - gci
+    - gofumpt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
 
 linters:
-  disable-all: true
+  settings:
+    misspell:
+      locale: US
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    rules:
+      - linters:
+          - containedctx
+          - dupl
+          - err113
+        path: _test\.go
+      - linters:
+          - contextcheck
+        text: Function `exitHealthchecksio` should pass the context parameter
+      - linters:
+          - lll
+        source: See https://
+      - linters:
+          - revive
+        text: "var-naming: avoid meaningless package names"
+        path: internal\/provider\/utils\/
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
   enable:
+    # - cyclop
+    - asasalint
+    - asciicheck
+    - bidichk
     - bodyclose
-    - deadcode
+    - canonicalheader
+    - containedctx
+    - contextcheck
+    - copyloopvar
+    - decorder
     - dogsled
     - dupl
-    - errcheck
+    - dupword
+    - durationcheck
+    - err113
+    - errchkjson
+    - errname
+    - errorlint
+    - exhaustive
+    - fatcontext
+    - forcetypeassert
+    - gocheckcompilerdirectives
     - gochecknoglobals
     - gochecknoinits
+    - gochecksumtype
     - gocognit
     - goconst
     - gocritic
     - gocyclo
-    - goimports
-    - golint
+    - godoclint
+    - godot
+    - goheader
+    - gomoddirectives
+    - goprintffuncname
     - gosec
-    - gosimple
-    - govet
-    - ineffassign
-    - interfacer
-    - maligned
+    - gosmopolitan
+    - grouper
+    - importas
+    - inamedparam
+    - interfacebloat
+    - intrange
+    - iotamixing
+    - ireturn
+    - lll
+    - maintidx
+    - makezero
+    - mirror
     - misspell
+    - mnd
+    - modernize
+    - musttag
     - nakedret
+    - nestif
+    - nilerr
+    - nilnil
+    - noctx
+    - nolintlint
+    - nosprintfhostport
+    - paralleltest
+    - perfsprint
     - prealloc
+    - predeclared
+    - promlinter
+    - protogetter
+    - reassign
+    - revive
     - rowserrcheck
-    - scopelint
-    - staticcheck
-    - structcheck
-    - typecheck
+    - sloglint
+    - sqlclosecheck
+    - tagalign
+    - thelper
+    - tparallel
     - unconvert
     - unparam
-    - unused
-    - varcheck
+    - usestdlibvars
+    - wastedassign
     - whitespace
-
-run:
-  skip-dirs:
-    - .devcontainer
-    - .github
+    - 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,70 +1,122 @@
-ARG ALPINE_VERSION=3.12
-ARG GO_VERSION=1.15
+ARG BUILDPLATFORM=linux/amd64
+ARG ALPINE_VERSION=3.23
+ARG GO_VERSION=1.26
+ARG XCPUTRANSLATE_VERSION=v0.9.0
+ARG GOLANGCI_LINT_VERSION=v2.11.4
+ARG MOCKGEN_VERSION=v0.6.0
 
-FROM alpine:${ALPINE_VERSION} AS alpine
-RUN apk --update add ca-certificates tzdata
+FROM --platform=${BUILDPLATFORM} ghcr.io/qdm12/xcputranslate:${XCPUTRANSLATE_VERSION} AS xcputranslate
+FROM --platform=${BUILDPLATFORM} ghcr.io/qdm12/binpot:golangci-lint-${GOLANGCI_LINT_VERSION} AS golangci-lint
+FROM --platform=${BUILDPLATFORM} ghcr.io/qdm12/binpot:mockgen-${MOCKGEN_VERSION} AS mockgen
 
-FROM golang:${GO_VERSION}-alpine${ALPINE_VERSION} AS builder
-ARG GOLANGCI_LINT_VERSION=v1.31.0
-RUN apk --update add git
-ENV CGO_ENABLED=0
-RUN wget -O- -nv https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s ${GOLANGCI_LINT_VERSION}
+FROM --platform=$BUILDPLATFORM golang:${GO_VERSION}-alpine${ALPINE_VERSION} AS base
 WORKDIR /tmp/gobuild
-COPY .golangci.yml .
+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
+COPY pkg/ ./pkg/
+COPY cmd/ ./cmd/
 COPY internal/ ./internal/
-COPY cmd/updater/main.go .
-RUN go test ./...
-RUN go build -trimpath -ldflags="-s -w" -o app
+
+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
+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
-ARG BUILD_DATE
-ARG VCS_REF
-ARG VERSION
-ENV VERSION=$VERSION \
-    BUILD_DATE=$BUILD_DATE \
-    VCS_REF=$VCS_REF
-LABEL \
-    org.opencontainers.image.authors="quentin.mcgaw@gmail.com" \
-    org.opencontainers.image.created=$BUILD_DATE \
-    org.opencontainers.image.version=$VERSION \
-    org.opencontainers.image.revision=$VCS_REF \
-    org.opencontainers.image.url="https://github.com/qdm12/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 Cloudflare, DDNSS.de, DNSPod, Dreamhost, DuckDNS, DynDNS, GoDaddy, Google, He.net, Infomaniak, Namecheap and NoIP"
-COPY --from=alpine --chown=1000 /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
-COPY --from=alpine --chown=1000 /usr/share/zoneinfo /usr/share/zoneinfo
 EXPOSE 8000
-HEALTHCHECK --interval=60s --timeout=5s --start-period=10s --retries=2 CMD ["/updater/app", "healthcheck"]
-USER 1000
-ENTRYPOINT ["/updater/app"]
+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
 ENV \
     # Core
     CONFIG= \
     PERIOD=5m \
-    IP_METHOD=cycle \
-    IPV4_METHOD=cycle \
-    IPV6_METHOD=cycle \
+    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
-    LISTENING_PORT=8000 \
+    SERVER_ENABLED=yes \
+    LISTENING_ADDRESS=:8000 \
     ROOT_URL=/ \
-
     # Backup
     BACKUP_PERIOD=0 \
     BACKUP_DIRECTORY=/updater/data \
-
     # Other
-    LOG_ENCODING=console \
     LOG_LEVEL=info \
-    NODE_ID=-1 \
-    GOTIFY_URL= \
-    GOTIFY_TOKEN= \
-    TZ=
-COPY --from=builder --chown=1000 /tmp/gobuild/app /updater/app
-COPY --chown=1000 ui/* /updater/ui/
+    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.version=$VERSION \
+    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"
+COPY --from=build --chown=${UID}:${GID} /tmp/gobuild/app /updater/ddns-updater

README.md

@@ -1,353 +1,442 @@
-# Lightweight universal DDNS Updater with Docker and web UI
-
-*Light container updating DNS A records periodically for Cloudflare, DDNSS.de, DonDominio, DNSPod, Dreamhost, DuckDNS, DynDNS, GoDaddy, Google, He.net, Infomaniak, Namecheap and NoIP*
-
-[![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://github.com/qdm12/ddns-updater/workflows/Buildx%20latest/badge.svg)](https://github.com/qdm12/ddns-updater/actions?query=workflow%3A%22Buildx+latest%22)
-[![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: Cloudflare, DDNSS.de, DonDominio, DNSPod, Dreamhost, DuckDNS, DynDNS, GoDaddy, Google, He.net, Infomaniak, Namecheap and NoIP ([create an issue](https://github.com/qdm12/ddns-updater/issues/new/choose) for more)
-- Web User interface
-
-![Web UI](https://raw.githubusercontent.com/qdm12/ddns-updater/master/readme/webui.png)
-
-- 14MB Docker image based on a Go static binary in a Scratch Docker image with ca-certificates and timezone data
-- 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`, `arm32v7` (Raspberry Pis) CPU architectures.
-
-## Setup
-
-The program reads the configuration from a JSON configuration file.
-
-1. First, create a JSON configuration starting from, for example:
-
-    ```json
-    {
-        "settings": [
-            {
-                "provider": "namecheap",
-                "domain": "example.com",
-                "host": "@",
-                "password": "e5322165c1d74692bfa6d807100c0310"
-            },
-            {
-                "provider": "duckdns",
-                "domain": "example.duckdns.org",
-                "token": "00000000-0000-0000-0000-000000000000"
-            },
-            {
-                "provider": "godaddy",
-                "domain": "example.org",
-                "host": "subdomain",
-                "key": "aaaaaaaaaaaaaaaa",
-                "secret": "aaaaaaaaaaaaaaaa"
-            }
-        ]
-    }
-    ```
-
-1. You can find more information in the [configuration section](#configuration) to customize it.
-1. You can either use a bind mounted file or put all your JSON in a single line with the `CONFIG` environment variable, see the two subsections below for each
-
-### Using the CONFIG variable
-
-1. Remove all 'new lines' in order to put your entire JSON in a single line (i.e. `{"settings": [{"provider": "namecheap", ...}]}`)
-1. Set the `CONFIG` environment variable to your single line configuration
-1. Use the following command:
-
-    ```sh
-    docker run -d -p 8000:8000/tcp -e CONFIG='{"settings": [{"provider": "namecheap", ...}]}' qmcgaw/ddns-updater
-    ```
-
-Note that this CONFIG environment variable takes precedence over the config.json file if it is set.
-
-### Using a file
-
-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. Place your JSON configuration in `data/config.json`
-1. Use the following command:
-
-    ```sh
-    docker run -d -p 8000:8000/tcp -v "$(pwd)"/data:/updater/data qmcgaw/ddns-updater
-    ```
-
-### Next steps
-
-You can also use [docker-compose.yml](https://github.com/qdm12/ddns-updater/blob/master/docker-compose.yml) with:
-
-```sh
-docker-compose up -d
-```
-
-You can update the image with `docker pull qmcgaw/ddns-updater`. Other [Docker image tags are available](https://hub.docker.com/repository/docker/qmcgaw/ddns-updater/tags).
-
-## Configuration
-
-Start by having the following content in *config.json*, or in your `CONFIG` environment variable:
-
-```json
-{
-    "settings": [
-        {
-            "provider": "",
-        },
-        {
-            "provider": "",
-        }
-    ]
-}
-```
-
-The following parameters are to be added:
-
-For all record update configuration, you have to specify the DNS provider with `"provider"` which can be `"cloudflare"`, `"ddnss"`, `"dondominio"`, `"dnspod"`, `"dreamhost"`, `"duckdns"`, `"dyn"`, `"godaddy"`, `"google"`, `"he"`, `"infomaniak"`, `"namecheap"` or `"noip"`.
-You can optionnally add the parameters:
-
-- `"no_dns_lookup"` can be `true` or `false` and allows, if `true`, to prevent the program from doing assumptions from DNS lookups returning an IP address not matching your public IP address (in example for proxied records on Cloudflare).
-- `"provider_ip"` can be `true` or `false`. It is only available for the providers `ddnss`, `duckdns`, `he`, `infomaniak`, `namecheap`, `noip` and `dyndns`. It allows to let your DNS provider to determine your IPv4 address (and/or IPv6 address) automatically when you send an update request, without sending the new IP address detected by the program in the request.
-
-For each DNS provider exist some specific parameters you need to add, as described below:
-
-Namecheap:
-
-- `"domain"`
-- `"host"` is your host and can be a subdomain, `"@"` or `"*"` generally
-- `"password"`
-
-Cloudflare:
-
-- `"zone_identifier"` is the Zone ID of your site
-- `"domain"`
-- `"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 Global API 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
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records), defaults to `ipv4 or ipv6`
-
-GoDaddy:
-
-- `"domain"`
-- `"host"` is your host and can be a subdomain, `"@"` or `"*"` generally
-- `"key"`
-- `"secret"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records), defaults to `ipv4 or ipv6`
-
-DuckDNS:
-
-- `"domain"` is your fqdn, for example `subdomain.duckdns.org`
-- `"token"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records), defaults to `ipv4 or ipv6`
-
-Dreamhost:
-
-- `"domain"`
-- `"key"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records), defaults to `ipv4 or ipv6`
-
-NoIP:
-
-- `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"`
-- `"username"`
-- `"password"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records), defaults to `ipv4 or ipv6`
-
-DNSPOD:
-
-- `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"`
-- `"token"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records), defaults to `ipv4 or ipv6`
-
-HE.net:
-
-- `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"` or `"*"` (untested)
-- `"password"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records), defaults to `ipv4 or ipv6`
-
-Infomaniak:
-
-- `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"`
-- `"user"`
-- `"password"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records), defaults to `ipv4 or ipv6`
-
-DDNSS.de:
-
-- `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"`
-- `"user"`
-- `"password"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records), defaults to `ipv4 or ipv6`
-
-DYNDNS:
-
-- `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"`
-- `"username"`
-- `"password"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records), defaults to `ipv4 or ipv6`
-
-Google:
-
-- `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"` or `"*"`
-- `"username"`
-- `"password"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records), defaults to `ipv4 or ipv6`
-
-DonDominio:
-
-- `"domain"`
-- `"username"`
-- `"password"`
-- `"ip_version"` can be `ipv4` (A records) or `ipv6` (AAAA records), defaults to `ipv4 or ipv6`
-- `"name"` is the name server associated with the domain
-
-### Additional notes
-
-- You can specify multiple hosts for the same domain using a comma separated list. For example with `"host": "@,subdomain1,subdomain2",`.
-
-### Environment variables
-
-| Environment variable | Default | Description |
-| --- | --- | --- |
-| `CONFIG` | | One line JSON object containing the entire config (takes precendence over config.json file) if specified |
-| `PERIOD` | `5m` | Default period of IP address check, following [this format](https://golang.org/pkg/time/#ParseDuration) |
-| `IP_METHOD` | `cycle` | Method to obtain the public IP address (ipv4 or ipv6). See the [IP Methods section](#IP-methods) |
-| `IPV4_METHOD` | `cycle` | Method to obtain the public IPv4 address only. See the [IP Methods section](#IP-methods) |
-| `IPV6_METHOD` | `cycle` | Method to obtain the public IPv6 address only. See the [IP Methods section](#IP-methods) |
-| `HTTP_TIMEOUT` | `10s` | Timeout for all HTTP requests |
-| `LISTENING_PORT` | `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) |
-| `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`.
-| `LOG_ENCODING` | `console` | Format of logging, `json` or `console` |
-| `LOG_LEVEL` | `info` | Level of logging, `info`, `warning` or `error` |
-| `NODE_ID` | `-1` | Node ID (for distributed systems), can be any integer |
-| `GOTIFY_URL` |  | (optional) HTTP(s) URL to your Gotify server |
-| `GOTIFY_TOKEN` |  | (optional) Token to access your Gotify server |
-| `TZ` | | Timezone to have accurate times, i.e. `America/Montreal` |
-
-#### IP methods
-
-By default, all ip methods are cycled through between all ip methods available for the specified ip version, if any. This allows you not to be blocked for making too many requests. You can otherwise pick one of the following.
-
-- IPv4 or IPv6 (for most cases)
-  - `opendns` using [https://diagnostic.opendns.com/myip](https://diagnostic.opendns.com/myip)
-  - `ifconfig` using [https://ifconfig.io/ip](https://ifconfig.io/ip)
-  - `ipinfo` using [https://ipinfo.io/ip](https://ipinfo.io/ip)
-  - `ipify` using [https://api.ipify.org](https://api.ipify.org)
-  - `"ddnss"` using [https://ddnss.de/meineip.php](https://ddnss.de/meineip.php)
-  - `"google"` using [https://domains.google.com/checkip](https://domains.google.com/checkip)
-- IPv4 only (useful for updating both ipv4 and ipv6)
-  - `ipify` using [https://api.ipify.org](https://api.ipify.org)
-  - `"ddnss4"` using [https://ip4.ddnss.de/meineip.php](https://ip4.ddnss.de/meineip.php)
-  - `"noip4"` using [http://ip1.dynupdate.no-ip.com](http://ip1.dynupdate.no-ip.com)
-  - `"noip8245_4"` using [http://ip1.dynupdate.no-ip.com:8245](http://ip1.dynupdate.no-ip.com:8245)
-- IPv6 only
-  - `ipify6` using [https://api6.ipify.org](https://api6.ipify.org)
-  - `"ddnss6"` using [https://ip6.ddnss.de/meineip.php](https://ip6.ddnss.de/meineip.php)
-  - `"noip6"` using [http://ip1.dynupdate.no-ip.com](http://ip1.dynupdate.no-ip.com)
-  - `"noip8245_6"` using [http://ip1.dynupdate.no-ip.com:8245](http://ip1.dynupdate.no-ip.com:8245)
-
-You can also specify an HTTPS URL to obtain your public IP address (i.e. `-e IPV6_METHOD=https://ipinfo.io/ip`)
-
-### 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
-
-Instructions to setup your domain for this program are available for DuckDNS, Cloudflare, GoDaddy and Namecheap on the [Github Wiki](https://github.com/qdm12/ddns-updater/wiki).
-
-## 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 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
-
-    Better testing instructions are written in the [Wiki for GoDaddy](https://github.com/qdm12/ddns-updater/wiki/GoDaddy#testing)
-
-## Development and contributing
-
-- Contribute with code: see [the Wiki](https://github.com/qdm12/ddns-updater/wiki/Contributing)
-- [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)
-- [Kanban board](https://github.com/qdm12/ddns-updater/projects/1)
-
-## License
-
-This repository is under an [MIT license](https://github.com/qdm12/ddns-updater/master/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)
-
-[![https://github.com/sponsors/qdm12](https://raw.githubusercontent.com/qdm12/private-internet-access-docker/master/doc/sponsors.jpg)](https://github.com/sponsors/qdm12)
-[![https://www.paypal.me/qmcgaw](https://raw.githubusercontent.com/qdm12/private-internet-access-docker/master/doc/paypal.jpg)](https://www.paypal.me/qmcgaw)
-
-Many thanks to J. Famiglietti for supporting me financially 🥇👍
+# 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)
+
+![Last release](https://img.shields.io/github/release/qdm12/ddns-updater?label=Last%20release)
+![Last Docker tag](https://img.shields.io/github/v/release/qdm12/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)
+
+![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 [`ghcr.io/qdm12/ddns-updater`]((https://github.com/qdm12/ddns-updater/pkgs/container/ddns-updater)) and [`qmcgaw/ddns-updater`](https://hub.docker.com/r/qmcgaw/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
+  - Domeneshop
+  - DonDominio
+  - DNSOMatic
+  - DNSPod
+  - Dreamhost
+  - DuckDNS
+  - DynDNS
+  - Dynu
+  - DynV6
+  - EasyDNS
+  - FreeDNS
+  - Gandi
+  - GCP
+  - GoDaddy
+  - GoIP.de
+  - He.net
+  - Hetzner
+  - Infomaniak
+  - INWX
+    - Ionos
+    - ipv64
+  - Linode
+  - Loopia
+  - LuaDNS
+  - Myaddr
+  - Name.com
+  - Namecheap
+  - NameSilo
+  - Netcup
+  - NoIP
+  - Now-DNS
+  - Njalla
+  - OpenDNS
+  - OVH
+  - Porkbun
+  - Route53
+  - Scaleway
+  - Selfhost.de
+  - Servercow.de
+  - Spdyn
+  - Strato.de
+  - Variomedia.de
+  - Vultr
+  - 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 ghcr.io/qdm12/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://github.com/qdm12/ddns-updater/pkgs/container/ddns-updater)
+    - You can update the image with `docker pull ghcr.io/qdm12/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)
+- [DD24](docs/dd24.md)
+- [DDNSS.de](docs/ddnss.de.md)
+- [deSEC](docs/desec.md)
+- [DigitalOcean](docs/digitalocean.md)
+- [Domeneshop](docs/domeneshop.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)
+- [Hetzner](docs/hetzner.md)
+- [Infomaniak](docs/infomaniak.md)
+- [INWX](docs/inwx.md)
+- [Ionos](docs/ionos.md)
+- [IPv64](docs/ipv64.md)
+- [Linode](docs/linode.md)
+- [Loopia](docs/loopia.md)
+- [LuaDNS](docs/luadns.md)
+- [Myaddr](docs/myaddr.md)
+- [Name.com](docs/name.com.md)
+- [Namecheap](docs/namecheap.md)
+- [NameSilo](docs/namesilo.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)
+- [Route53](docs/route53.md)
+- [Scaleway](docs/scaleway.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)
+- [Vultr](docs/vultr.md)
+- [Zoneedit](docs/zoneedit.md)
+- [Custom](docs/custom.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",`.
+⚠️ this is a bit different for DuckDNS and GoIP, see their respective documentation.
+
+### 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](https://github.com/qdm12/ddns-updater/issues/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 ghcr.io/qdm12/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,380 @@
+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 serverAddress == "" {
+		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,285 +0,0 @@
-package main
-
-import (
-	"context"
-	"net"
-	"os/signal"
-	"syscall"
-
-	"fmt"
-	"net/http"
-	"os"
-	"time"
-
-	"github.com/qdm12/ddns-updater/internal/backup"
-	"github.com/qdm12/ddns-updater/internal/data"
-	"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"
-	recordslib "github.com/qdm12/ddns-updater/internal/records"
-	"github.com/qdm12/ddns-updater/internal/splash"
-	"github.com/qdm12/ddns-updater/internal/update"
-	"github.com/qdm12/golibs/admin"
-	libhealthcheck "github.com/qdm12/golibs/healthcheck"
-	"github.com/qdm12/golibs/logging"
-	"github.com/qdm12/golibs/network"
-	"github.com/qdm12/golibs/network/connectivity"
-	"github.com/qdm12/golibs/server"
-)
-
-func main() {
-	os.Exit(_main(context.Background(), time.Now))
-	// returns 1 on error
-	// returns 2 on os signal
-}
-
-type allParams struct {
-	period          time.Duration
-	ipMethod        models.IPMethod
-	ipv4Method      models.IPMethod
-	ipv6Method      models.IPMethod
-	dir             string
-	dataDir         string
-	listeningPort   string
-	rootURL         string
-	backupPeriod    time.Duration
-	backupDirectory string
-}
-
-func _main(ctx context.Context, timeNow func() time.Time) int {
-	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 {
-			fmt.Println(err)
-			return 1
-		}
-		return 0
-	}
-	logger, err := setupLogger()
-	if err != nil {
-		fmt.Println(err)
-		return 1
-	}
-	paramsReader := params.NewReader(logger)
-
-	fmt.Println(splash.Splash(
-		paramsReader.GetVersion(),
-		paramsReader.GetVcsRef(),
-		paramsReader.GetBuildDate()))
-
-	notify, err := setupGotify(paramsReader, logger)
-	if err != nil {
-		logger.Error(err)
-		return 1
-	}
-
-	p, err := getParams(paramsReader, logger)
-	if err != nil {
-		logger.Error(err)
-		notify(4, err)
-		return 1
-	}
-
-	persistentDB, err := persistence.NewJSON(p.dataDir)
-	if err != nil {
-		logger.Error(err)
-		notify(4, err)
-		return 1
-	}
-	settings, warnings, err := paramsReader.GetSettings(p.dataDir + "/config.json")
-	for _, w := range warnings {
-		logger.Warn(w)
-		notify(2, w)
-	}
-	if err != nil {
-		logger.Error(err)
-		notify(4, err)
-		return 1
-	}
-	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 record")
-	}
-	for _, err := range connectivity.NewConnectivity(5 * time.Second).Checks("google.com") {
-		logger.Warn(err)
-	}
-	records := make([]recordslib.Record, len(settings))
-	for i, s := range settings {
-		logger.Info("Reading history from database: domain %s host %s", s.Domain(), s.Host())
-		events, err := persistentDB.GetEvents(s.Domain(), s.Host())
-		if err != nil {
-			logger.Error(err)
-			notify(4, err)
-			return 1
-		}
-		records[i] = recordslib.New(s, events)
-	}
-	HTTPTimeout, err := paramsReader.GetHTTPTimeout()
-	if err != nil {
-		logger.Error(err)
-		notify(4, err)
-		return 1
-	}
-	client := network.NewClient(HTTPTimeout)
-	defer client.Close()
-	db := data.NewDatabase(records, persistentDB)
-	defer func() {
-		if err := db.Close(); err != nil {
-			logger.Error(err)
-		}
-	}()
-	updater := update.NewUpdater(db, client, notify)
-	ipGetter := update.NewIPGetter(client, p.ipMethod, p.ipv4Method, p.ipv6Method)
-	runner := update.NewRunner(db, updater, ipGetter, logger, timeNow)
-	ctx, cancel := context.WithCancel(ctx)
-	defer cancel()
-	forceUpdate := runner.Run(ctx, p.period)
-	forceUpdate()
-	productionHandlerFunc := handlers.MakeHandler(p.rootURL, p.dir+"/ui", db, logger, forceUpdate, timeNow)
-	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 %q", p.listeningPort, p.rootURL)
-	notify(1, fmt.Sprintf("Launched with %d records to watch", len(records)))
-	serverErrors := make(chan []error)
-	go func() {
-		serverErrors <- server.RunServers(ctx,
-			server.Settings{Name: "production", Addr: "0.0.0.0:" + p.listeningPort, Handler: productionHandlerFunc},
-			server.Settings{Name: "healthcheck", Addr: "127.0.0.1:9999", Handler: healthcheckHandlerFunc},
-		)
-	}()
-
-	go backupRunLoop(ctx, p.backupPeriod, p.dir, p.backupDirectory, logger, timeNow)
-
-	osSignals := make(chan os.Signal, 1)
-	signal.Notify(osSignals,
-		syscall.SIGINT,
-		syscall.SIGTERM,
-		os.Interrupt,
-	)
-	select {
-	case errors := <-serverErrors:
-		for _, err := range errors {
-			logger.Error(err)
-		}
-		return 1
-	case signal := <-osSignals:
-		message := fmt.Sprintf("Stopping program: caught OS signal %q", signal)
-		logger.Warn(message)
-		notify(2, message)
-		return 2
-	case <-ctx.Done():
-		message := fmt.Sprintf("Stopping program: %s", ctx.Err())
-		logger.Warn(message)
-		return 1
-	}
-}
-
-func setupLogger() (logging.Logger, error) {
-	paramsReader := params.NewReader(nil)
-	encoding, level, nodeID, err := paramsReader.GetLoggerConfig()
-	if err != nil {
-		return nil, err
-	}
-	return logging.NewLogger(encoding, level, nodeID)
-}
-
-func setupGotify(paramsReader params.Reader, logger logging.Logger) (notify func(priority int, messageArgs ...interface{}), err error) {
-	gotifyURL, err := paramsReader.GetGotifyURL()
-	if err != nil {
-		return nil, err
-	} else if gotifyURL == nil {
-		return func(priority int, messageArgs ...interface{}) {}, nil
-	}
-	gotifyToken, err := paramsReader.GetGotifyToken()
-	if err != nil {
-		return nil, err
-	}
-	gotify := admin.NewGotify(*gotifyURL, gotifyToken, &http.Client{Timeout: time.Second})
-	return func(priority int, messageArgs ...interface{}) {
-		if err := gotify.Notify("DDNS Updater", priority, messageArgs...); err != nil {
-			logger.Error(err)
-		}
-	}, nil
-}
-
-func getParams(paramsReader params.Reader, logger logging.Logger) (p allParams, err error) {
-	var warnings []string
-	p.period, warnings, err = paramsReader.GetPeriod()
-	for _, warning := range warnings {
-		logger.Warn(warning)
-	}
-	if err != nil {
-		return p, err
-	}
-	p.ipMethod, err = paramsReader.GetIPMethod()
-	if err != nil {
-		return p, err
-	}
-	p.ipv4Method, err = paramsReader.GetIPv4Method()
-	if err != nil {
-		return p, err
-	}
-	p.ipv6Method, err = paramsReader.GetIPv6Method()
-	if err != nil {
-		return p, err
-	}
-	p.dir, err = paramsReader.GetExeDir()
-	if err != nil {
-		return p, err
-	}
-	p.dataDir, err = paramsReader.GetDataDir(p.dir)
-	if err != nil {
-		return p, err
-	}
-	p.listeningPort, _, err = paramsReader.GetListeningPort()
-	if err != nil {
-		return p, err
-	}
-	p.rootURL, err = paramsReader.GetRootURL()
-	if err != nil {
-		return p, err
-	}
-	p.backupPeriod, err = paramsReader.GetBackupPeriod()
-	if err != nil {
-		return p, err
-	}
-	p.backupDirectory, err = paramsReader.GetBackupDirectory()
-	if err != nil {
-		return p, err
-	}
-	return p, nil
-}
-
-func backupRunLoop(ctx context.Context, backupPeriod time.Duration, exeDir, outputDir string,
-	logger logging.Logger, timeNow func() time.Time) {
-	logger = logger.WithPrefix("backup: ")
-	if backupPeriod == 0 {
-		logger.Info("disabled")
-		return
-	}
-	logger.Info("each %s; writing zip files to directory %s", backupPeriod, outputDir)
-	ziper := backup.NewZiper()
-	timer := time.NewTimer(backupPeriod)
-	for {
-		filepath := fmt.Sprintf("%s/ddns-updater-backup-%d.zip", outputDir, timeNow().UnixNano())
-		if err := ziper.ZipFiles(
-			filepath,
-			fmt.Sprintf("%s/data/updates.json", exeDir),
-			fmt.Sprintf("%s/data/config.json", exeDir)); err != nil {
-			logger.Error(err)
-		}
-		select {
-		case <-timer.C:
-			timer.Reset(backupPeriod)
-		case <-ctx.Done():
-			timer.Stop()
-			return
-		}
-	}
-}

config.json

@@ -3,7 +3,6 @@
         {
             "provider": "namecheap",
             "domain": "example.com",
-            "host": "@",
             "password": "e5322165c1d74692bfa6d807100c0310"
         },
         {
@@ -13,8 +12,7 @@
         },
         {
             "provider": "godaddy",
-            "domain": "example.org",
-            "host": "subdomain",
+            "domain": "subdomain.example.org",
             "key": "aaaaaaaaaaaaaaaa",
             "secret": "aaaaaaaaaaaaaaaa"
         },

docker-compose.yml

@@ -1,7 +1,7 @@
 version: "3.7"
 services:
   ddns-updater:
-    image: qmcgaw/ddns-updater
+    image: ghcr.io/qdm12/ddns-updater
     container_name: ddns-updater
     network_mode: bridge
     ports:
@@ -11,13 +11,17 @@ services:
     environment:
       - CONFIG=
       - PERIOD=5m
-      - IP_METHOD=cycle
-      - IPV4_METHOD=cycle
-      - IPV6_METHOD=cycle
+      - 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
 
       # Web UI
-      - LISTENING_PORT=8000
+      - LISTENING_ADDRESS=:8000
       - ROOT_URL=/
 
       # Backup
@@ -25,9 +29,7 @@ services:
       - BACKUP_DIRECTORY=/updater/data
 
       # Other
-      - LOG_ENCODING=console
       - LOG_LEVEL=info
-      - NODE_ID=-1 # -1 to disable
-      - GOTIFY_URL=
-      - GOTIFY_TOKEN=
+      - 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+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`. In the rare case you do not wish to send an IPv4 query parameter to the registrar API when updating your A (IPv4) record, leave it to `"ipv4key": ""`.
+- `"ipv6key"` is the URL query parameter name for the IPv6 address, for example `ipv6` will be added to the URL with `&ipv6=::aaff`. In the rare case you do not wish to send an IPv6 query parameter to the registrar API when updating your AAAA (IPv6) record, leave it to `"ipv6key": ""`.
+- `"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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 at [desec.io/tokens](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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 at [cloud.digitalocean.com/settings/applications](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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## Domain setup

docs/domeneshop.md

@@ -0,0 +1,31 @@
+# Domeneshop.no
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "domeneshop",
+      "domain": "domain.com,seconddomain.com",
+      "token": "token",
+      "secret": "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`)
+- `"token"` See [api.domeneshop.no/docs/](https://api.domeneshop.no/docs/) for instructions on how to generate credentials.
+- `"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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## Domain setup

docs/duckdns.md

@@ -0,0 +1,38 @@
+# 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. The [eTLD](https://developer.mozilla.org/en-US/docs/Glossary/eTLD) must be `duckdns.org`. For example:
+  - for the root owner/host `@`, it would be `mydomain.duckdns.org`
+  - for the owner/host `sub`, it would be `sub.mydomain.duckdns.org`
+  - for multiple domains, it can be `sub1.mydomain.duckdns.org,sub2.mydomain.duckdns.org` BUT it cannot be `a.duckdns.org,b.duckdns.org`, since the effective domains would be `a.duckdns.org` and `b.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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+- `"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 from [dynv6.com/keys#token](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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+<!-- 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+- `"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 at [cloud.google.com/docs/authentication/getting-started](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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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,36 @@
+# GoIP.de
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "goip",
+      "domain": "sub.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`.
+- `"domain"` is the domain to update. The [eTLD](https://developer.mozilla.org/en-US/docs/Glossary/eTLD) must be `goip.de` or `goip.it`. For example:
+  - for the root owner/host `@`, it would be `mydomain.goip.de`
+  - for the owner/host `sub`, it would be `sub.mydomain.goip.de`
+  - for multiple domains, it can be `sub1.mydomain.goip.de,sub2.mydomain.goip.de` BUT it cannot be `a.goip.de,b.goip.de`, since the effective domains would be `a.goip.de` and `b.goip.de`
+- `"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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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,35 @@
+# INWX
+
+## Configuration
+
+You must configure a [DynDNS Account in INWX](https://www.inwx.com/en/offer/dyndns) and use the configured account and hostname.
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "inwx",
+      "domain": "domain.com",
+      "username": "username",
+      "password": "password",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain configured for the DynDNS Account. 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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, consisting of two parts — a prefix and the key itself — and can be obtained by [creating an API key](https://www.ionos.com/help/domains/configuring-your-ip-address/set-up-dynamic-dns-with-company-name/#c181598). It must follow the format `<prefix>.<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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

docs/ipv64.md

@@ -0,0 +1,31 @@
+# IPv64
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "ipv64",
+      "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) or `sub.example.com` (subdomain of `example.com`).
+- `"key"` that you can obtain at [ipv64.net/account](https://ipv64.net/account)
+
+### 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## Domain setup

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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/loopia.md

@@ -0,0 +1,31 @@
+# Loopia
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "loopia",
+      "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`). It cannot be a wildcard domain.
+- `"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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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/myaddr.md

@@ -0,0 +1,33 @@
+# [Myaddr](https://myaddr.tools/)
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "myaddr",
+      "domain": "your-name.myaddr.tools",
+      "key": "key",
+      "ip_version": "ipv4",
+      "ipv6_suffix": ""
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` - the **single** domain to update; note the `key` below updates all records and subdomains for this domain. It should be `your-name.myaddr.tools`.
+- `"key"` - the private key corresponding to the domain to update
+
+### 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## Domain setup
+
+Claim a subdomain at [myaddr.tools](https://myaddr.tools/)

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

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/namesilo.md

@@ -0,0 +1,51 @@
+# NameSilo
+
+[![NameSilo Website](../readme/namesilo.jpg)](https://www.namesilo.com)
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "namesilo",
+      "domain": "sub.example.com",
+      "key": "71dZaE8c2Aa926Ca2E8c1",
+      "ttl": 7207,
+      "ip_version": "ipv4"
+    }
+  ]
+}
+```
+
+### 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 NameSilo API Key obtained using the domain setup instructions below. For example: `71dZaE8c2Aa926Ca2E8c1`.
+
+### 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+- `"ttl"` is the record's Time to Live (TTL), which defaults to `7207` seconds. It must be numeric, less than `2592001`, and greater than or equal to `3600`. TTL values of `3603` or `7207` may be subject to NameSilo's [Automatic TTL Adjustments](https://www.namesilo.com/support/v2/articles/domain-manager/dns-manager#auto_ttl).
+
+## Domain setup
+
+1. Login to the [Namesilo API Manager](https://www.namesilo.com/account/api-manager) with your account credentials.
+1. Generate an API key. The generated API key will look similar to `71dZaE8c2Aa926Ca2E8c1`.
+    - (do _not_ check the "Generate key for read-only access" box)
+
+    [![Before NameSilo API Key](../readme/namesilo1.jpg)](https://www.namesilo.com/account/api-manager)
+    [![After NameSilo API Key](../readme/namesilo2.jpg)](https://www.namesilo.com/account/api-manager)
+
+## Testing
+
+1. Go to the [NameSilo Domain Manager](https://www.namesilo.com/account_domains.php).
+1. Choose "Manage DNS for this domain" (the globe icon) for the domain you wish to test.
+    [![Manage DNS for this domain](../readme/namesilo3.jpg)](https://www.namesilo.com/account_domains.php)
+
+1. Change the IP address of the host to `127.0.0.1`.
+1. Run the ddns-updater.
+1. Refresh the Namesilo webpage to check the update occurred.

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+- `"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": "pk1_5299b57125c8f3cdf347d2fe0e713311ee3a1e11f11a14942b26472593e35368",
+      "secret_api_key": "sk1_7d119e3f656b00ae042980302e1425a04163c476efec1833q3cb0w54fc6f5022",
+      "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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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/scaleway.md

@@ -0,0 +1,36 @@
+# Example.com
+
+## Configuration
+
+If something is unclear in the documentation below, please refer to the [scaleway API documentation](https://www.scaleway.com/en/developers/api/domains-and-dns/#path-records-update-records-within-a-dns-zone).
+
+### Example
+
+```json
+{
+    "settings": [
+        {
+            "provider": "scaleway",
+            "domain": "domain.com",
+            "secret_key": "<SECRET_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.
+- `"secret_key"` is your secret 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+- `"ttl"` is the TTL of the DNS record to update, if you want to specify it.
+
+## Domain setup
+
+If you need more information about how to configure your domain, you can check the [scaleway official documentation](https://www.scaleway.com/en/docs/network/domains-and-dns/).

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## Domain setup
+
+See [their article](https://wiki.servercow.de/en/domains/dns_api/api-syntax/)

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## Domain setup
+
+See [dyndns.variomedia.de](https://dyndns.variomedia.de/)

docs/vercel.md

@@ -0,0 +1,39 @@
+# Vercel
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "vercel",
+      "domain": "domain.com",
+      "token": "yourtoken",
+      "ip_version": "ipv4",
+      "ipv6_suffix": "",
+      "team_id": ""
+    }
+  ]
+}
+```
+
+### 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 Vercel API token. You can create one at [Vercel Account Settings > Tokens](https://vercel.com/account/tokens).
+
+### Optional parameters
+
+- `"team_id"` is your Vercel team ID. Required if the domain belongs to a team rather than your personal account. You can find this in your team settings.
+- `"ttl"` is the TTL in seconds for the DNS record. It defaults to being not set, using the existing TTL configured for the record in Vercel or the default TTL determined by Vercel.
+- `"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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## Domain setup
+
+1. Ensure your domain is added to Vercel. You can do this via the [Vercel Dashboard](https://vercel.com/dashboard) under your project's Domain settings, or via the API.
+1. Your domain must be using Vercel's nameservers or have DNS management delegated to Vercel for this provider to work.
+1. Create an API token with appropriate permissions at [Vercel Account Settings > Tokens](https://vercel.com/account/tokens).
+1. If the domain belongs to a team, make sure to include the `team_id` parameter in your configuration.

docs/vultr.md

@@ -0,0 +1,30 @@
+# Vultr
+
+## Configuration
+
+### Example
+
+```json
+{
+  "settings": [
+    {
+      "provider": "vultr",
+      "domain": "potato.example.com",
+      "apikey": "AAAAAAAAAAAAAAA",
+      "ttl": 300,
+      "ip_version": "ipv4"
+    }
+  ]
+}
+```
+
+### Compulsory parameters
+
+- `"domain"` is the domain to update. It can be a root domain (i.e. `example.com`) or a subdomain (i.e. `potato.example.com`) or a wildcard (i.e. `*.example.com`). In case of a wildcard, it only works if there is no existing wildcard records of any record type.
+- `"apikey"` is your API key which can be obtained from [my.vultr.com/settings/](https://my.vultr.com/settings/#settingsapi).
+
+### 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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+- `"ttl"` is the record TTL which defaults to 900 seconds.

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 temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
+
+## Domain setup
+
+[support.zoneedit.com/en/knowledgebase/article/dynamic-dns](https://support.zoneedit.com/en/knowledgebase/article/dynamic-dns)

go.mod

@@ -1,11 +1,39 @@
 module github.com/qdm12/ddns-updater
 
-go 1.15
+go 1.26.0
 
 require (
-	github.com/golang/mock v1.4.4
-	github.com/google/uuid v1.1.1
-	github.com/kyokomi/emoji v2.2.4+incompatible
-	github.com/qdm12/golibs v0.0.0-20200712151944-a0325873bf5a
-	github.com/stretchr/testify v1.6.1
+	github.com/breml/rootcerts v0.3.4
+	github.com/containrrr/shoutrrr v0.8.0
+	github.com/go-chi/chi/v5 v5.2.5
+	github.com/miekg/dns v1.1.72
+	github.com/qdm12/goservices v0.1.0
+	github.com/qdm12/gosettings v0.4.4
+	github.com/qdm12/gosplash v0.2.0
+	github.com/qdm12/gotree v0.3.0
+	github.com/qdm12/log v0.1.0
+	github.com/stretchr/testify v1.11.1
+	go.uber.org/mock v0.6.0
+	golang.org/x/mod v0.35.0
+	golang.org/x/net v0.53.0
+	golang.org/x/oauth2 v0.36.0
+)
+
+require (
+	cloud.google.com/go/compute/metadata v0.9.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/fatih/color v1.18.0 // indirect
+	github.com/go-logr/logr v1.4.3 // indirect
+	github.com/golang/protobuf v1.5.4 // indirect
+	github.com/mattn/go-colorable v0.1.14 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/exp v0.0.0-20251219203646-944ab1f22d93 // indirect
+	golang.org/x/sync v0.20.0 // indirect
+	golang.org/x/sys v0.43.0 // indirect
+	golang.org/x/tools v0.43.0 // indirect
+	google.golang.org/protobuf v1.36.11 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	kernel.org/pub/linux/libs/security/libcap/cap v1.2.77 // indirect
+	kernel.org/pub/linux/libs/security/libcap/psx v1.2.77 // indirect
 )

go.sum

@@ -1,141 +1,79 @@
-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.9.0 h1:pDUj4QMoPejqq20dK0Pg2N4yG9zIkYGdBtwLoEkH9Zs=
+cloud.google.com/go/compute/metadata v0.9.0/go.mod h1:E0bWwX5wTnLPedCKqk3pJmVgCBSM6qQI1yTBdEb3C10=
+github.com/breml/rootcerts v0.3.4 h1:9i7WNl/ctd9OEAOaTfLy//Wrlfxq/tRQ7v4okYFN9Ys=
+github.com/breml/rootcerts v0.3.4/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/fatih/color v1.9.0 h1:8xPHl4/q1VyqGIPif1F+1V3Y3lSmrq01EabUW3CoW5s=
-github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU=
-github.com/globalsign/mgo v0.0.0-20180905125535-1ca0a4f7cbcb h1:D4uzjWwKYQ5XnAvUbuvHW93esHg7F8N/OYeBBcJoTr0=
-github.com/globalsign/mgo v0.0.0-20180905125535-1ca0a4f7cbcb/go.mod h1:xkRDCp4j0OGD1HRkm4kmhM+pmpv3AKq5SU7GMg4oO/Q=
-github.com/go-openapi/analysis v0.0.0-20180825180245-b006789cd277/go.mod h1:k70tL6pCuVxPJOHXQ+wIac1FUrvNkHolPie/cLEU6hI=
-github.com/go-openapi/analysis v0.17.0 h1:8JV+dzJJiK46XqGLqqLav8ZfEiJECp8jlOFhpiCdZ+0=
-github.com/go-openapi/analysis v0.17.0/go.mod h1:IowGgpVeD0vNm45So8nr+IcQ3pxVtpRoBWb8PVZO0ik=
-github.com/go-openapi/errors v0.17.0/go.mod h1:LcZQpmvG4wyF5j4IhA73wkLFQg+QJXOQHVjmcZxhka0=
-github.com/go-openapi/errors v0.17.2 h1:azEQ8Fnx0jmtFF2fxsnmd6I0x6rsweUF63qqSO1NmKk=
-github.com/go-openapi/errors v0.17.2/go.mod h1:LcZQpmvG4wyF5j4IhA73wkLFQg+QJXOQHVjmcZxhka0=
-github.com/go-openapi/jsonpointer v0.17.0 h1:nH6xp8XdXHx8dqveo0ZuJBluCO2qGrPbDNZ0dwoRHP0=
-github.com/go-openapi/jsonpointer v0.17.0/go.mod h1:cOnomiV+CVVwFLk0A/MExoFMjwdsUdVpsRhURCKh+3M=
-github.com/go-openapi/jsonreference v0.17.0 h1:yJW3HCkTHg7NOA+gZ83IPHzUSnUzGXhGmsdiCcMexbA=
-github.com/go-openapi/jsonreference v0.17.0/go.mod h1:g4xxGn04lDIRh0GJb5QlpE3HfopLOL6uZrK/VgnsK9I=
-github.com/go-openapi/loads v0.17.0 h1:H22nMs3GDQk4SwAaFQ+jLNw+0xoFeCueawhZlv8MBYs=
-github.com/go-openapi/loads v0.17.0/go.mod h1:72tmFy5wsWx89uEVddd0RjRWPZm92WRLhf7AC+0+OOU=
-github.com/go-openapi/runtime v0.0.0-20180920151709-4f900dc2ade9/go.mod h1:6v9a6LTXWQCdL8k1AO3cvqx5OtZY/Y9wKTgaoP6YRfA=
-github.com/go-openapi/runtime v0.17.2 h1:/ZK67ikFhQAMFFH/aPu2MaGH7QjP4wHBvHYOVIzDAw0=
-github.com/go-openapi/runtime v0.17.2/go.mod h1:QO936ZXeisByFmZEO1IS1Dqhtf4QV1sYYFtIq6Ld86Q=
-github.com/go-openapi/spec v0.17.0 h1:XNvrt8FlSVP8T1WuhbAFF6QDhJc0zsoWzX4wXARhhpE=
-github.com/go-openapi/spec v0.17.0/go.mod h1:XkF/MOi14NmjsfZ8VtAKf8pIlbZzyoTvZsdfssdxcBI=
-github.com/go-openapi/strfmt v0.17.0 h1:1isAxYf//QDTnVzbLAMrUK++0k1EjeLJU/gTOR0o3Mc=
-github.com/go-openapi/strfmt v0.17.0/go.mod h1:P82hnJI0CXkErkXi8IKjPbNBM6lV6+5pLP5l494TcyU=
-github.com/go-openapi/swag v0.17.0 h1:iqrgMg7Q7SvtbWLlltPrkMs0UBJI6oTSs79JFRUi880=
-github.com/go-openapi/swag v0.17.0/go.mod h1:AByQ+nYG6gQg71GINrmuDXCPWdL640yX49/kXLo40Tg=
-github.com/go-openapi/validate v0.17.0 h1:pqoViQz3YLOGIhAmD0N4Lt6pa/3Gnj3ymKqQwq8iS6U=
-github.com/go-openapi/validate v0.17.0/go.mod h1:Uh4HdOzKt19xGIGm1qHf/ofbX1YQ4Y+MYsct2VUrAJ4=
-github.com/golang/mock v1.4.3 h1:GV+pQPG/EUUbkh47niozDcADz6go/dUwhVzdUQHIVRw=
-github.com/golang/mock v1.4.3/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw=
-github.com/golang/mock v1.4.4 h1:l75CXGRSwbaYNpl/Z2X1XIIAMSCquvXgpVZDhwEIJsc=
-github.com/golang/mock v1.4.4/go.mod h1:l3mdAwkq5BuhzHwde/uurv3sEJeZMXNpwsxVWU71h+4=
-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.2.4+incompatible h1:np0woGKwx9LiHAQmwZx79Oc0rHpNw3o+3evou4BEPv4=
-github.com/kyokomi/emoji v2.2.4+incompatible/go.mod h1:mZ6aGCD7yk8j6QY6KICwnZ2pxoszVseX1DNoGtU2tBA=
-github.com/mailru/easyjson v0.0.0-20180823135443-60711f1a8329 h1:2gxZ0XQIU/5z3Z3bUBu+FXuk2pFbkN6tcwi/pjyaDic=
-github.com/mailru/easyjson v0.0.0-20180823135443-60711f1a8329/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
-github.com/mattn/go-colorable v0.1.4 h1:snbPLB8fVfU9iwbbo30TPtbLRzwWu6aJS6Xh4eaaviA=
-github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
-github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
-github.com/mattn/go-isatty v0.0.11 h1:FxPOTFNqGkuDUGi3H/qkUbQO4ZiBa2brKq5r0l8TGeM=
-github.com/mattn/go-isatty v0.0.11/go.mod h1:PhnuNfih5lzO57/f3n+odYbM4JtupLOxQOAqxQCu2WE=
-github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE=
-github.com/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.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM=
+github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU=
+github.com/go-chi/chi/v5 v5.2.5 h1:Eg4myHZBjyvJmAFjFvWgrqDTXFyOzjj7YIm3L3mu6Ug=
+github.com/go-chi/chi/v5 v5.2.5/go.mod h1:X7Gx4mteadT3eDOMTsXzmI4/rwUpOwBHLpAfupzFJP0=
+github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=
+github.com/go-logr/logr v1.4.3/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.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
+github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
+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.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE=
+github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/miekg/dns v1.1.72 h1:vhmr+TF2A3tuoGNkLDFK9zi36F2LS+hKTRW0Uf8kbzI=
+github.com/miekg/dns v1.1.72/go.mod h1:+EuEPhdHOsfk6Wk5TT2CzssZdqkmFhf8r+aVyDEToIs=
+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-20200712151944-a0325873bf5a h1:IyS72qFm+iXipadmUKXmpJScKXXK2GrD8yYfxXsnIYs=
-github.com/qdm12/golibs v0.0.0-20200712151944-a0325873bf5a/go.mod h1:pikkTN7g7zRuuAnERwqW1yAFq6pYmxrxpjiwGvb0Ysc=
-github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
-github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
-github.com/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=
-github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
-github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-go.uber.org/atomic v1.5.0 h1:OI5t8sDa1Or+q8AeE+yKeB/SDYioSHAgcVljj9JIETY=
-go.uber.org/atomic v1.5.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ=
-go.uber.org/multierr v1.3.0 h1:sFPn2GLc3poCkfrpIXGhBD2X0CMIo4Q/zSULXrj/+uc=
-go.uber.org/multierr v1.3.0/go.mod h1:VgVr7evmIr6uPjLBxg28wmKNXyqE9akIJ5XnfpiKl+4=
-go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee h1:0mgffUl7nfd+FpvXMVz4IDEaUSmT1ysygQC7qYo7sG4=
-go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee/go.mod h1:vJERXedbb3MVM5f9Ejo0C68/HhF8uaILCdgjnY+goOA=
-go.uber.org/zap v1.13.0 h1:nR6NoDBgAf67s68NhaXbsojM+2gxp3S1hWkHDl27pVU=
-go.uber.org/zap v1.13.0/go.mod h1:zwrFLgMcdUuIBviXEYEH1YKNaOBnKXsx2IPda5bBwHM=
-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/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/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20191026070338-33540a1f6037 h1:YyJpGZS1sBuBCzLAR1VEpK193GlqGZbnPFnPV/5Rsb4=
-golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
-golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
-golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=
-golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=
-golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
-golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5 h1:hKsoRgsbwY1NafxrwTs+k64bikrLBkAgPir1TNCj3Zs=
-golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
-golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+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 h1:SM6tOZDf6k8qbjWU8KWyBF4mWIixfsKCfh9DGRLHlj4=
+github.com/qdm12/gosettings v0.4.4/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.3.0 h1:Q9f4C571EFK7ZEsPkEL2oGZX7I+ZhVxhh1ZSydW+5yI=
+github.com/qdm12/gotree v0.3.0/go.mod h1:iz06uXmRR4Aq9v6tX7mosXStO/yGHxRA1hbyD0UVeYw=
+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.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
+github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
+go.uber.org/mock v0.6.0 h1:hyF9dfmbgIX5EfOdasqLsWD6xqpNZlXblLB/Dbnwv3Y=
+go.uber.org/mock v0.6.0/go.mod h1:KiVJ4BqZJaMj4svdfmHM0AUx4NJYO8ZNpPnZn1Z+BBU=
+golang.org/x/exp v0.0.0-20251219203646-944ab1f22d93 h1:fQsdNF2N+/YewlRZiricy4P1iimyPKZ/xwniHj8Q2a0=
+golang.org/x/exp v0.0.0-20251219203646-944ab1f22d93/go.mod h1:EPRbTFwzwjXj9NpYyyrvenVh9Y+GFeEvMNh7Xuz7xgU=
+golang.org/x/mod v0.35.0 h1:Ww1D637e6Pg+Zb2KrWfHQUnH2dQRLBQyAtpr/haaJeM=
+golang.org/x/mod v0.35.0/go.mod h1:+GwiRhIInF8wPm+4AoT6L0FA1QWAad3OMdTRx4tFYlU=
+golang.org/x/net v0.53.0 h1:d+qAbo5L0orcWAr0a9JweQpjXF19LMXJE8Ey7hwOdUA=
+golang.org/x/net v0.53.0/go.mod h1:JvMuJH7rrdiCfbeHoo3fCQU24Lf5JJwT9W3sJFulfgs=
+golang.org/x/oauth2 v0.36.0 h1:peZ/1z27fi9hUOFCAZaHyrpWG5lwe0RJEEEeH0ThlIs=
+golang.org/x/oauth2 v0.36.0/go.mod h1:YDBUJMTkDnJS+A4BP4eZBjCqtokkg1hODuPjwiGPO7Q=
+golang.org/x/sync v0.20.0 h1:e0PTpb7pjO8GAtTs2dQ6jYa5BWYlMuX047Dco/pItO4=
+golang.org/x/sync v0.20.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.43.0 h1:Rlag2XtaFTxp19wS8MXlJwTvoh8ArU6ezoyFsMyCTNI=
+golang.org/x/sys v0.43.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
+golang.org/x/text v0.36.0 h1:JfKh3XmcRPqZPKevfXVpI1wXPTqbkE5f7JA92a55Yxg=
+golang.org/x/text v0.36.0/go.mod h1:NIdBknypM8iqVmPiuco0Dh6P5Jcdk8lJL0CUebqK164=
+golang.org/x/tools v0.43.0 h1:12BdW9CeB3Z+J/I/wj34VMl8X+fEXBxVR90JeMX5E7s=
+golang.org/x/tools v0.43.0/go.mod h1:uHkMso649BX2cZK6+RpuIPXS3ho2hZo4FVwfoy1vIk0=
+google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE=
+google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
 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=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-honnef.co/go/tools v0.0.1-2019.2.3 h1:3JgtbtFHMiCmsznwGVTUWbgGov+pVqnlf1dEJTNAXeM=
-honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg=
-rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
-rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=
+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.77 h1:iQtQTjFUOcTT19fI8sTCzYXsjeVs56et3D8AbKS2Uks=
+kernel.org/pub/linux/libs/security/libcap/cap v1.2.77/go.mod h1:oV+IO8kGh0B7TxErbydDe2+BRmi9g/W0CkpVV+QBTJU=
+kernel.org/pub/linux/libs/security/libcap/psx v1.2.77 h1:Z06sMOzc0GNCwp6efaVrIrz4ywGJ1v+DP0pjVkOfDuA=
+kernel.org/pub/linux/libs/security/libcap/psx v1.2.77/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,99 @@
+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

@@ -6,26 +6,8 @@ import (
 	"os"
 )
 
-type Ziper interface {
-	ZipFiles(outputFilepath string, inputFilepaths ...string) error
-}
-
-type ziper struct {
-	createFile func(name string) (*os.File, error)
-	openFile   func(name string) (*os.File, error)
-	ioCopy     func(dst io.Writer, src io.Reader) (written int64, err error)
-}
-
-func NewZiper() Ziper {
-	return &ziper{
-		createFile: os.Create,
-		openFile:   os.Open,
-		ioCopy:     io.Copy,
-	}
-}
-
-func (z *ziper) ZipFiles(outputFilepath string, inputFilepaths ...string) error {
-	f, err := z.createFile(outputFilepath)
+func zipFiles(outputFilepath string, inputFilepaths ...string) error {
+	f, err := os.Create(outputFilepath)
 	if err != nil {
 		return err
 	}
@@ -33,15 +15,16 @@ func (z *ziper) ZipFiles(outputFilepath string, inputFilepaths ...string) error
 	w := zip.NewWriter(f)
 	defer w.Close()
 	for _, filepath := range inputFilepaths {
-		if err := z.addFile(w, filepath); err != nil {
+		err = addFile(w, filepath)
+		if err != nil {
 			return err
 		}
 	}
 	return nil
 }
 
-func (z *ziper) addFile(w *zip.Writer, filepath string) error {
-	f, err := z.openFile(filepath)
+func addFile(w *zip.Writer, filepath string) error {
+	f, err := os.Open(filepath)
 	if err != nil {
 		return err
 	}
@@ -62,6 +45,6 @@ func (z *ziper) addFile(w *zip.Writer, filepath string) error {
 	if err != nil {
 		return err
 	}
-	_, err = z.ioCopy(ioWriter, f)
+	_, 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,67 @@
+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 is the listening address:port of the
+	// health server, which defaults to the empty string,
+	// meaning the server will not run.
+	ServerAddress         *string
+	HealthchecksioBaseURL string
+	HealthchecksioUUID    *string
+}
+
+func (h *Health) SetDefaults() {
+	h.ServerAddress = gosettings.DefaultPointer(h.ServerAddress, "")
+	h.HealthchecksioBaseURL = gosettings.DefaultComparable(h.HealthchecksioBaseURL, "https://hc-ping.com")
+	h.HealthchecksioUUID = gosettings.DefaultPointer(h.HealthchecksioUUID, "")
+}
+
+func (h Health) Validate() (err error) {
+	if *h.ServerAddress != "" {
+		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")
+	if *h.ServerAddress == "" {
+		node.Appendf("Server is disabled")
+	} else {
+		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,46 @@
+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 {
+		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)
+		})
+	}
+}