Fixed handling of situation where address for some network is not found

[oss/dyngo.git] / dyngo.md

diff --git a/dyngo.md b/dyngo.md
index d7ed659c9e95361b84b4d6185d2537b0c0f0597f..94e58ffabe5e19a820ec21c5015237ceee2ccf7a 100644 (file)
--- a/dyngo.md
+++ b/dyngo.md
@@ -40,6 +40,25 @@ Configuration file **dyngo.conf** is ini-style file. It contains section
 Names of server-description sections are arbitrary, but should be
 unique, because they are used as keys into persistent database.
 
-
+Parameters of **dyngo** section
+-------------------------------
+
+* interval - number of seconds between rescans of network interfaces
+* database - path to persistent state database
+* ca - path to trusted certificate store in openssl compatible format.
+* loglevel - minimum log message level which shoud to console
+
+Parameters of network section
+-----------------------------
+
+* **hostname** - fully qualified domain name of your host to register in DNS
+* **network** - network in *address*/*bits* notation which this host
+should belong to. If we see address from this network on one of our
+interfaces, we would send request to  corresponding server. If net is
+not privatte, but include private ranges, i.e. 0.0.0.0/0 or ::/0 private
+addresses are not considered part of it.
+* **server** - full url (without query string) of the dyndns web  handler.
+* **user** - user name for HTTP basic authentication
+* **password** - password for HTTP basic authentcircation