dyndns-server/README.md
Thomas Preisner 7e4452347f
All checks were successful
continuous-integration/drone Build is passing
README.md: add reverse proxy as optional requirement
2021-11-20 00:46:24 +01:00

1.4 KiB

dyndns-server

dyndns-server is a simple self-hosted dynamic DNS API service which can be used together with e.g. AVM FritzBox's DynDNS functionality or ddclient. It implements a subset of the API described by Google Domains and forwards DNS Updates to an authoritive DNS server as per RFC2136.

Requirements

  • go for building the dyndns-server binary
  • an authoritive DNS server responsible for the records to be dynamically updated which is capable of RFC2136 (e.g. knot, bind)
  • knsupdate needs to be installed for sending DNS update requests
  • a reverse-proxy for https (e.g. nginx), this is optional and dyndns-server can also directly operate at port 80 which is discouraged as otherwise secrets will be transmitted unencrypted

Configuration

dyndns-server will look for a file named config.toml inside the current working directory unless a different config path has been supplied via -config <path to config file>. For details regarding the configuration file format, please consult config.example.toml.