From: Stefan Schantl Date: Tue, 9 Sep 2014 17:40:05 +0000 (+0200) Subject: Add ddns.conf.5 manpage. X-Git-Tag: 006~1^2~4 X-Git-Url: http://git.ipfire.org/?p=ddns.git;a=commitdiff_plain;h=3c5ba60d2e37a88a0bfd08f448be9eb24467dc4c Add ddns.conf.5 manpage. --- diff --git a/man/ddns.conf.xml b/man/ddns.conf.xml new file mode 100644 index 0000000..a00ccc6 --- /dev/null +++ b/man/ddns.conf.xml @@ -0,0 +1,230 @@ + + + + + + ddns.conf + ddns + + + + Developer + Stefan + Schantl + stefan.schantl@ipfire.org + + + + + + ddns.conf + 5 + + + + ddns.conf + Configuration file for the DDNS update client. + + + + Description + + + The ddns.conf file is the main configuration file for the + ddns update client. This file specifies some basic options + for the programm and contain multiple sections which imply hostname and auth information + for each used provider. + + + + Lines starting with a hash mark (''#'') and empty lines are ignored. + + + + + Options + + + The following options can be configured: + + + + + + + + + + + Using this option allows the usage of a proxy server while + performing updates. + + + + The proxy only can be contacted by using the HTTP protocol. The + server has to be specified by using its IP address and the used port. + + + + Example: proxy = http://192.168.180.1:800 + + + + + + + + + + + + Determine the public IP addresses by using external servers. + + + + The default value if this setting is not configured is + true. + + + + + + + + Provider Configuration + + + The DDNS client supports the configuration of an unlimited amount of entries on different providers. + Each entry has to be configured as an own section which has to be initiated with the choosen FQDN + (Fully Qualified Domain Name) inside of squared brackets. + + + + + + [hostname.someprovider.com] + + + + + Specifies the choosen FQDN composed of the hostname and the selected domain from the + desired dynamic DNS provider. + + + + + + + handle = someprovider.com + + + + + The provider which is responsible for the configured FQDN. + + + + A list of all supported providers can be found in the ddns.conf.sample + or the README file shipped by the source code. + + + + + + + username = user + + + + + The used username to authenticate against your providers update service. + + + + In most cases this will be the same username which can be used to login on + your providers webpage. + + + + + + + password = pass + + + + + The choosen password for the specified username. + + + + + + + token = token + + + + + Just the authentication token. + + + + If your dynamic DNS provider supports token-based auth, this method should + be prefered. + + + + + + + + Examples + + + A provider which uses username and password for client authentication. + + + [somehost.provider.com] + handle = provider.com + username = username + password = password + + + + + Provider which supports token based auth. + + + [anotherhost.provider.com] + handle = provider.com + token = token + + + + + + Bugs + + + Please report all bugs to the official bugtracker at + http://bugs.ipfire.org/. + + + + + See Also + + + + ddns + 1 + + + ddns-devel + 7 + + + +