Commit cf3b62bf authored by Erick Hitter's avatar Erick Hitter

README updates

parent 5d669158
Client for the [`dyndnsd`]( daemon. Set up `dyndnsd` first, otherwise this is useless.
## Configuration
Copy `config-sample.json` to `config.json` and update the values.
## Use
Set up a cron entry to run the program periodically, or manually call it when your IP address changes. The program accepts a single argument, `-config`, pointing to a `config.json` file that handles everything. A sample `config.json` is provided in the form of `config-sample.json`.
## Configuration Options
* `username`: daemon username
* `password`: daemon password
* `protocol`: `http` or `https`, preferably the latter
* `host`: IP or hostname of `dnydnsd` instance
* `port`: port `dyndnsd` is listening on
* `path`: path to `dnydnsd` daemon, typically `nic/update`
* `dns_hostname`: the `nsd` zone to update
* `ipv4_endpoint`: GET-accessible endpoint that returns an IPv4 IP address as a string; when in doubt, use ``
* `ipv6_endpoint`: GET-accessible endpoint that returns an IPv6 IP address as a string; when in doubt, use ``
* `ipv6_use_prefix`: if running multiple instances on the same network, use only the IPv6 prefix, omitting the instance portion of the address; this greatly reduces unnecessary `nsd` updates
## Proxying via `nginx`
`dnydnsd` doesn't support HTTPS, so using `nginx` as an HTTPS proxy is recommended. Sending a username and password over an unsecured connection should be avoided if possible.
More coming soon...
......@@ -8,5 +8,5 @@
"dns_hostname": "",
"ipv4_endpoint": "",
"ipv6_endpoint": "",
"ipv6_use_prefix": true
"ipv6_use_prefix": false
\ No newline at end of file
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment