christian
/
homeserverdns
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

try markdown syntax highlighting

This commit is contained in:
lurchi 2018-11-05 12:54:43 +01:00
parent 3cf932d42f
commit 7fd2de934d
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -12,18 +12,21 @@ So far it has modules for these domain provider APIs:
- miniupnpc (optional, see the Configuration section) - miniupnpc (optional, see the Configuration section)
# Installation # Installation
TBD TBD
# Configuration # 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 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. 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 auth_key=g5Hdsfkj5J49li8HH3jfhsJp
user= # not required for gandi user= # not required for gandi
api_address= # 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. 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 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. 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 $ upnpc -s
[...] [...]
ExternalIPAddress = 85.98.82.44 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. 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 public_ip4_hook=curl -s -4 https://ipecho.net/plain
``` ```