mbdns is a dynamic DNS update client for the Mythic Beasts Primary DNS v2 system, supporting their IPv4 and IPv6 endpoints. Written in golang, it supports common home network infrastructure operating systems (FreeBSD, EdgeOS, UniFi OS, Linux) and common platform architectures (amd64, arm64 and MIPS).
Take doc/mbdns.conf.sample and configure it to your needs, saving as mbdns.conf. mbdns.conf must be valid JSON or mbdns will fail to start.
- Copy the
mbdnsbinary (usually namedmbdns-VERSION-OS-ARCH) andmbdns.confto your target platform - chmod 0400 mbdns.conf so the Mythic Beasts API secrets can only be read by the user you deploy as (ideally use a specific user).
mbdnswill check for you and fail to start if the config is insecurely readable, unless you use--insecure. - Run the
mbdnsbinary, which will process its main update until you kill it - By default the
mbdnsbinary will look for./mbdns.conf. You can relocate it (and rename it) and tellmbdnswith--config.mbdns --config /etc/mbdns/mbdns.conf
mbdns is written in golang and builds as a statically linked library with no dependencies.
mbdns logs to stdout. If your target OS supports we suggest you redirect stdout to a file, logrotate that file, and run the binary in the background via the daemonising system of your choice. mbdns makes no attempt to daemonise itself.
systemd will run it nicely if you use the simple service type, running the process for you and capturing stdout.
mbdns --version prints the version information and exits immediately.
mbdns logs the following:
- version, build date and git commit SHA on startup
- the path to the config file
- success or failure including record type
- a small handful of at-startup failure messages if it can't run (no config, invalid JSON in the config, insecure config)
- a message saying it is processing records if it can cleanly start
mbdns is MIT licensed.