homeserverdns/README.md

1.8 KiB

homeserverdns: Dynamic DNS updater for home servers

homeserverdns monitors the IPv6 addresses (using the ip tool from iproute2). When it detects a change, it updates the A and AAAA records for a set of domains (and subdomains).

So far it has modules for these domain provider APIs:

Dependencies

  • curl
  • miniupnpc (optional, see the Configuration section)

Installation

TBD

Configuration

All configuration options are described in more detail in homeserverdns.cfg. This is only an overview on the most important options.

First a protocol has to be defined, e.g.

protocol=gandi

For authentication at the domain provider, an authentication token has to be geven. Some protocols require a user name and an API address, too.

auth_key=g5Hdsfkj5J49li8HH3jfhsJp
user= 		# not required for gandi
api_address=	# not required for gandi

Now the domains (and subdomains) we want to update A and AAAA records for have to be defined.

domains=mydomain.com sub.mydomain.com

By default UPNP is used for detecting the server's public IPv4 address. So we should check if upnp works and returns the correct IPv4 address.

$ upnpc -s
[...]
ExternalIPAddress = 85.98.82.44
[...]

If we don't get a value for ExternalIPAddress, we should check our router and firewall settings. If UPNP does not work for us (e.g. in case the server is behind a Carrier Grade NAT), we can define our own method for looking up our public IPv4 address using the public_ip4_hook config option, e.g.

public_ip4_hook=curl -s -4 https://ipecho.net/plain