Lightweight universal DDNS Updater program

Program to keep DNS A and/or AAAA records updated for multiple DNS providers

Versioned documentation

This readme and the docs/ directory are versioned to match the program version:

Features

• Available as a Docker image ghcr.io/qdm12/ddns-updater and qmcgaw/ddns-updater
• Available as zero-dependency binaries for Linux, Windows and MacOS
• 🆕 Available in the AUR as ddns-updater - see #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 (legacy API)
• Hetzner Cloud
• 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
• Spaceship
• Spdyn
• Strato.de
• Variomedia.de
• Vultr
• Zoneedit
• Want more? Create an issue for it!

• Web user interface (Desktop)

  

• Web user interface (Mobile)

  

• Send notifications with Shoutrrr 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. You can alternatively download, build and install the latest version of the program by installing Go and then run go install github.com/qdm12/ddns-updater/cmd/ddns-updater@latest.
2. For Linux and MacOS, make the program executable with chmod +x ddns-updater.
3. In the directory where the program is saved, create a directory data.

4. 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 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 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

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 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.

2. 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

3. 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 to customize it.

4. Run the container with

   sh docker run -d -p 8000:8000/tcp -v "$(pwd)"/data:/updater/data ghcr.io/qdm12/ddns-updater

5. The following is optional.

   • You can customize the program behavior using environment variables
   • You can use docker-compose.yml with docker-compose up -d
   • Kubernetes: check out the k8s directory for an installation guide and examples.
   • Other Docker image tags are available
   • 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:

{
    "settings": [
        {
            "provider": "",
        },
        {
            "provider": "",
        }
    ]
}

For each setting, you need to fill in parameters. Check the documentation for your DNS provider:

• 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
• HetznerCloud
• 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
• Spaceship
• Spdyn
• Strato.de
• Variomedia.de
• Vultr
• Zoneedit
• Custom

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.