diff --git a/README.md b/README.md index c6409bd..6fc8867 100644 --- a/README.md +++ b/README.md @@ -12,18 +12,21 @@ So far it has modules for these domain provider APIs: - miniupnpc (optional, see the Configuration section) # Installation + TBD # Configuration -The configuration options are described in `homeserverdns.cfg`. First a protocol has to be defined, e.g. +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. + +```shell 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. -``` +```shell auth_key=g5Hdsfkj5J49li8HH3jfhsJp user= # not required for gandi api_address= # not required for gandi @@ -31,13 +34,13 @@ api_address= # not required for gandi Now the domains (and subdomains) we want to update A and AAAA records for have to be defined. -``` +```shell 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. -``` +```shell $ upnpc -s [...] ExternalIPAddress = 85.98.82.44 @@ -46,6 +49,6 @@ 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. -``` +```shell public_ip4_hook=curl -s -4 https://ipecho.net/plain ```