Skip to content

Latest commit

 

History

History
116 lines (89 loc) · 4.3 KB

CONFIGURATION.md

File metadata and controls

116 lines (89 loc) · 4.3 KB

Complete, manual ddupdate configuration

Before configuration, the software must be installed. See README.md. Please also note that the the manual steps descrobed here could be replaced by running ddupdat-config for most users.

Configuration is basically about selecting a plugin for a specific ddns service and another plugin which provides the ip address to be registered. Some plugins needs specific plugin options.

The address plugin to use is normally either default-web-ip or default-if.

The default-web-ip plugin should be used when the address to register is the external address visible on the internet - that is, if the registered host should be accessed from the internet. For most services ip-disabled could be used instead. Services will then use the external address as seen from the service. See the ddupdate --help info.

The default-if plugin uses the first address found on the default interface. This typically means registering the address used on an internal network, and should be used if the registered host should be accessed from this internal network.

Should these options not fit, several other address plugins are available using ddupdate --list-addressers. After selecting address plugin, test it using something like::

$ ./ddupdate --ip-plugin default-web-ip --service-plugin dry-run
dry-run: Using
    v4 address: 83.255.182.111
    v6 address: None
    hostname: host1.nowhere.net

After selecting the address plugin, start the process of selecting a service by listing all available services (your list might differ)::

$ ddupdate --list-services
changeip             Updates DNS data on changeip.com
dnsexit              Updates DNS data on www.dnsexit.com
dry-run              Debug dummy update plugin
dtdns                Updates DNS data on dtdns.com
duckdns              Updates DNS data on duckdns.org
duiadns              Updates DNS data on duiadns.com
dynu                 Updates DNS data on dynu.com
freedns.afraid       Updates DNS data on freedns.afraid.org
freedns.io           Updates DNS data on freedns.io
no-ip                Updates DNS data on no-ip.com
now-dns              Updates DNS data on now-dns.com
system-ns            Updates DNS data on system-ns.com

Next, pick a service plugin and check the help info, here dynu::

$ ddupdate --help dynu
Name: dynu
Source: /home/al/src/ddupdate/src/ddupdate/plugins/ddplugin.py

Update a dns entry on dynu.com

Supports ip address discovery and can thus work with the ip-disabled
plugin.

.netrc: Use a line like:
    machine api.dynu.com login <username> password <password>

Options:
    none

If all looks good, register on dynu.com. This will end up in a hostname, username and password. Using the .netrc info in the ddupdate help , create an entry in the ~/.netrc file like::

machine api.dynu.com login <username> password <secret>

Note that this file must be protected for other users (otherwise no tools will accept it). Do::

$ chmod 600 ~/.netrc

Now, let's select the plugin which provides the ip address to register. For the default case, the default-web-ip plugin generates the address as seen from the network. Test the service using the selected address plugin, something like::

$ ./ddupdate --address-plugin default-web-ip --service-plugin dynu \
--hostname myhost.dynu.net -l info
INFO - Loglevel: INFO
INFO - Using hostname: myhost.dynu.net
INFO - Using ip address plugin: default-web-ip
INFO - Using service plugin: dynu
INFO - Plugin options:
INFO - Using ip address: 90.3.08.212
INFO - Update OK

When all is fine, update ~/.config/ddupdate.conf or /etc/ddupdate.conf to something like::

[update]
address-plugin = web-default-ip
service-plugin = dynu
hostname = myhost.dynu.net
loglevel = info

After which it should be possible to just invoke ddupdate without any options.

The final step is to create configuration files for the ddupdate user which are used when run by systemctl. Basically, this user needs access to the .netrc file. Do::

sudo cp ~/.netrc ~ddupdate
sudo chmod 600 ~ddupdate/.netrc
sudo chown ddupdate ~ddupdate/.netrc

When done, proceed to Configuring systemd in README.md