]> www.wagner.pp.ru Git - oss/dyngo.git/blob - dyngo.md
Fixed handling of situation where address for some network is not found
[oss/dyngo.git] / dyngo.md
1 % dingo(8)
2 % Victor Wagner <vitus@wagner.pp.ru>
3 % September 2019
4
5 NAME
6 ====
7
8 dingo - multi-network dynamic DNS client
9
10 SYNOPSIS
11 ========
12
13 **dyngo** [ **-f** *configuration-file* ]
14
15 DESCRIPTION
16 ===========
17
18 **dyngo** is dynamic DNS client which periodically tries to check if
19 some of IP addresses of the current machine change and report to
20 appropriate dynamic DNS server if so.
21
22 It is primarily intended to let machine be visible in the local DNS 
23 of office or home local networks, VPNs and so on. So it expects that
24 there could be private dynamic dns servers. Couple of dynamic DNS
25 scripts is included into distribution to make it easier to set up
26 dynamic dns.
27
28 But nothing prevent user from defining some of networks as global
29 ones and put URL of public dyndns server into it.
30
31 If network is defined as global, i.e have netmask /0, private ip ranges
32 wouldn't be reported to corresponding DNS server.
33
34 CONFIGURATION FILE
35 ==================
36
37 Configuration file **dyngo.conf** is ini-style file. It contains section
38 **dyngo** with global service parameters and section per dyndns server.
39
40 Names of server-description sections are arbitrary, but should be
41 unique, because they are used as keys into persistent database.
42
43 Parameters of **dyngo** section
44 -------------------------------
45
46 * interval - number of seconds between rescans of network interfaces
47 * database - path to persistent state database
48 * ca - path to trusted certificate store in openssl compatible format.
49 * loglevel - minimum log message level which shoud to console
50
51 Parameters of network section
52 -----------------------------
53
54 * **hostname** - fully qualified domain name of your host to register in DNS
55 * **network** - network in *address*/*bits* notation which this host
56 should belong to. If we see address from this network on one of our
57 interfaces, we would send request to  corresponding server. If net is
58 not privatte, but include private ranges, i.e. 0.0.0.0/0 or ::/0 private
59 addresses are not considered part of it.
60 * **server** - full url (without query string) of the dyndns web  handler.
61 * **user** - user name for HTTP basic authentication
62 * **password** - password for HTTP basic authentcircation
63
64