kevin/name-dyndns
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Edits to readme

Browse source
This commit is contained in:
Mike Cheng 2015-05-04 20:31:51 -04:00
parent ac7b2286da
commit ae5f8bf788
1 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -23,17 +23,23 @@ By default, running name-dyndns will run a one-time update, using `./config.json
as a configuration file, and stdout as a log output. However, these can be configured. For example:
```
./name-dyndns -daemon=true -log="/var/log/name-dyndns/out.log" -config="~/name_config.json"
./name-dyndns -daemon=true -dev=true -log="/var/log/name-dyndns/out.log" -config="~/name_config.json"
```
This will run name-dyndns in daemon mode, outputting to `/var/log/name-dyndns/out.log`, using the configuration file `~/name_config.json`
This will run name-dyndns in daemon mode for dev configurations, outputting to `/var/log/name-dyndns/out.log`, using the configuration file `~/name_config.json`
A detailed usage can be found by running:
```
./name-dyndns --help
```
## Error Handling
Currently, there is limited testing, primarily on none-api dependant utilities.
While error handling **should** be done gracefully, not every edge case has been tested.
While error handling _should_ be done gracefully, not every edge case has been tested.
Ideally, when running in daemon mode, name-dyndns tries to treat any errors
arising from network (API, fetching external IP) as transient failures, and tries again next iteration. The idea behind this is that a single network failure shouldn't
arising from network as transient failures, and tries again next iteration. The idea behind this is that a single network failure shouldn't
kill the daemon, which could then potentially result in having the DNS records out
of sync, which would defeat the whole point of name-dyndns.