Skip to content
The last dynamic DNS client you'll ever need
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
examples
tests
.gitignore
.travis.yml
LICENSE.txt
README.rst
dnsupdate.py
dnsupdate.service
dnsupdate.timer
readthedocs.yml
requirements.txt
requirements_optional.txt
setup.py

README.rst

dnsupdate

A modern and flexible dynamic DNS client

https://travis-ci.org/lopsided98/dnsupdate.svg?branch=master Documentation Status

dnsupdate is a dynamic DNS client that has first-class support for IPv6 and aims to be easily configurable to meet the needs of any situation. Unlike most other dynamic DNS clients, dnsupdate has been designed from the start to support IPv6 and many different update services. It is written in Python and configured using YAML, making it easy to use and extend.

Features

  • Built-in support for FreeDNS, nsupdate.info, as well as any service that uses the standard DynDNS protocol
  • IPv6 support
  • Simple YAML configuration file
  • Obtain addresses from a web service, router or local interface
  • Only submits an update if the address has changed
  • Respects API return values to avoid abuse bans

Installation

pip install dnsupdate

Alternatively, you can simply download and run dnsupdate.py.

It is also available on the Arch Linux AUR.

Dependencies

Configuration

dnsupdate is configured using a single YAML file. The path to the file can be specified on the command line. If not, dnsupdate will try to use ~/.config/dnsupdate.conf and /etc/dnsupdate.conf, in that order.

Most users will likely be satisfied with a simple configuration like this:

dns_services:
    - type: NSUpdate
      args:
          hostname: example.nsupdate.info
          secret_key: 26Yg7wUhxo

More examples are available in the examples/ directory.

Full documentation is available here: https://dnsupdate.readthedocs.io/

Usage

usage: dnsupdate [-h] [-f] [-V] [config]

Dynamic DNS update client

positional arguments:
  config              the config file to use

optional arguments:
  -h, --help          show this help message and exit
  -f, --force-update  force an update to occur even if the address has not
                      changed or a service has been disabled
  -V, --version       show program's version number and exit

Documentation

Documentation is available online, but it can also be built locally by running:

python3 setup.py build_docs

You can’t perform that action at this time.