qmcgaw/ddns-updater repository overview

⁠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:

   {
       "settings": [
           {
               "provider": "namecheap",
               "domain": "sub.example.com",
               "password": "e5322165c1d74692bfa6d807100c0310"
           }
       ]
   }
   

   Copy

   You can find more information in the configuration section⁠ to customize it.

5. Run the program with ./ddns-updater (./ddns-updater.exe on Windows) or by double-clicking on it.

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

   mkdir data
   chown 1000 data
   chmod u+r+w+x data
   

   Copy

   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

   touch data/config.json
   chmod u+r data/config.json
   

   Copy

3. Edit data/config.json, for example:

   {
       "settings": [
           {
               "provider": "namecheap",
               "domain": "sub.example.com",
               "password": "e5322165c1d74692bfa6d807100c0310"
           }
       ]
   }
   

   Copy

   You can find more information in the configuration section⁠ to customize it.

4. Run the container with

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

   Copy

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.

⁠Home Assistant

To install ddns-updater on Home Assistant⁠, follow the installation instructions on ha-ddns-updater⁠.

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

⁠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⁠
  • ifconfig using https://ifconfig.io/ip⁠
  • ipinfo using https://ipinfo.io/ip⁠
  • spdyn using https://checkip.spdyn.de⁠
  • ipleak using https://ipleak.net/json⁠
  • icanhazip using https://icanhazip.com⁠
  • ident using https://ident.me⁠
  • nnev using https://ip.nnev.de⁠
  • wtfismyip using https://wtfismyip.com/text⁠
  • seeip using https://api.seeip.org⁠
  • changeip using 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⁠
  • ipify using https://api.ipify.org⁠
  • icanhazip using https://ipv4.icanhazip.com⁠
  • ident using https://v4.ident.me⁠
  • nnev using https://ip4.nnev.de⁠
  • wtfismyip using https://ipv4.wtfismyip.com/text⁠
  • seeip using 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⁠
  • ipify using https://api6.ipify.org⁠
  • icanhazip using https://ipv6.icanhazip.com⁠
  • ident using https://v6.ident.me⁠
  • nnev using https://ip6.nnev.de⁠
  • wtfismyip using https://ipv6.wtfismyip.com/text⁠
  • seeip using https://ipv6.seeip.org⁠
  • You can also specify an HTTPS URL with prefix url: for example url:https://ipinfo.io/ip
• PUBLICIP_DNS_PROVIDERS gets your public IPv4 address only or IPv6 address only or one of them (see #136⁠). It can be one or more of the following:
  • cloudflare
  • opendns

⁠Host firewall

If you have a host firewall in place, this container needs the following ports:

• TCP 443 outbound for outbound HTTPS
• UDP 53 outbound for outbound DNS resolution
• TCP 8000 inbound (or other) for the WebUI

⁠Architecture

At program start and every period (5 minutes by default):

1. Fetch your public IP address
2. 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
   2. 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
2. 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
   2. 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⁠
• You can also manually check, by:
  1. Going to your DNS management webpage
  2. Setting your record to 127.0.0.1
  3. Run the container
  4. Refresh the DNS management webpage and verify the update happened

⁠Build the image

You can build the image yourself with:

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:

⁠Development and contributing

• Contribute with code⁠
• Github workflows to know what's building⁠
• List of issues and feature requests⁠

⁠License

This repository is under an MIT license⁠

⁠Used in external projects

• Starttoaster/docker-traefik⁠

⁠Support

Sponsor me on Github⁠ or donate to paypal.me/qmcgaw⁠

Many thanks to J. Famiglietti for supporting me financially 🥇👍