Repository files navigation

This package allows you to set up a dynamic DNS server that allows you to connect todevices at home from anywhere in the world. All you need is a cheap VPS, a domain and access to it's nameserver.

You can either take the image from DockerHub or build it on your own.

Just customize this to your needs and run:

docker run -it -d \    -p 8080:8080 \    -p 53:53 \    -p 53:53/udp \    -e SHARED_SECRET=changeme \    -e ZONE=example.org \    -e RECORD_TTL=3600 \    --name=dyndns \    davd/docker-ddns:latest

If you want to persist DNS configuration across container recreation, add-v /somefolder:/var/cache/bind. If you are experiencing anyissues updating DNS configuration using the API (NOTAUTH andSERVFAIL), make sure to add writing permissions for root (UID=0) to yourpersistent storage (e.g.chmod -R a+w /somefolder).

You can also use Compose / Swarm to set up this project. For more information and an exampledocker-compose.yml with persistent datastorage, please refer to this file:https://github.com/dprandzioch/docker-ddns/blob/master/docker-compose.yml

git clone https://github.com/dprandzioch/docker-ddnsgit checkout master # Make sure to build the latest stable releasecd docker-ddns$EDITOR envfilemake deploy

Make sure to change all environment variables inenvfile to match your needs. Some more information can be found here:https://www.davd.io/build-your-own-dynamic-dns-in-5-minutes/

Afterwards you have a running docker container that exposes three ports:

• 53/TCP -> DNS
• 53/UDP -> DNS
• 8080/TCP -> Management REST API

That package features a simple REST API written in Go, that provides a simpleinterface, that almost any router that supports Custom DDNS providers canattach to (e.g. Fritz!Box). It is highly recommended to put a reverse proxybefore the API.

It provides one single GET request, that is used as follows:

http://myhost.mydomain.tld:8080/update?secret=changeme&domain=foo&addr=1.2.3.4

• secret: The shared secret set inenvfile
• domain: The subdomain to your configured domain, in this example it wouldresult infoo.example.org. Could also be multiple domains that should beredirected to the same domain separated by comma, so "foo,bar"
• addr: IPv4 or IPv6 address of the name record

For the DynDNS compatible fields please see Dyn's documentation here:

https://help.dyn.com/remote-access-api/perform-update/

This package contains a DynDNS compatible handler for convenience and for use caseswhere clients cannot be modified to use the JSON responses and/or URL scheme outlinedabove.

This has been tested with a number of routers. Just point the router to your DDNS domainfor updates.

The handlers will listen on:

• /nic/update
• /v2/update
• /v3/update

The username is not validated at all so you can use anything as a usernamePassword is the shared secret provided as an ENV variable

An example on the ddclient (Linux DDNS client) based Ubiquiti router line:

set service dns dynamic interface eth0 service dyndns host-name set service dns dynamic interface eth0 service dyndns login set service dns dynamic interface eth0 service dyndns password set service dns dynamic interface eth0 service dyndns protocol dyndns2set service dns dynamic interface eth0 service dyndns server

Optional if you used this behind an HTTPS reverse proxy like I do:

set service dns dynamic interface eth0 service dyndns options ssl=true

This also means that DDCLIENT works out of the box and Linux based devices should work.

D-Link DIR-842:

Another router that has been tested is from the D-Link router line where you need to fill thedetails in on the Web Interface. The values are self-explanatory. Under the server (once you chosen Manual)you need to enter you DDNS server's hostname or IP. The protocol used by the router will be thedyndns2 by default and cannot be changed.

Just run

docker logs -f dyndns

To provide a little help... To your "real" domain, likedomain.tld, youshould add a subdomain that is delegated to this DDNS server like this:

dyndns                   IN NS      nsns                       IN A       <put ipv4 of dns server here>ns                       IN AAAA    <optional, put ipv6 of dns server here>

Your management API should then also be accessible through

http://ns.domain.tld:8080/update?...

If you providefoo as a domain when using the REST API, the resulting domainwill then befoo.dyndns.domain.tld.

• If you're on a systemd-based distribution, the processsystemd-resolved might occupy the DNS port 53. Therefore starting the container might fail. To fix this disable the DNSStubListener by addingDNSStubListener=no to/etc/systemd/resolved.conf and restart the service usingsudo systemctl restart systemd-resolved.service but be aware of the implications... Read more here:https://www.freedesktop.org/software/systemd/man/systemd-resolved.service.html and#5