Ruddr DocumentationΒΆ
Welcome to the full documentation for Ruddr, the Robotic Updater for Dynamic DNS Records.
Ruddr is a modular dynamic DNS client. It separates the job into two tasks:
Detecting IP address changes, handled by notifiers.
Publishing the changed addresses, handled by updaters
Ruddr provides built-in updaters and notifiers for common use cases and
services. For example, the web notifier will periodically query a
what-is-my-ip style website, and the standard updater uses the de facto
standard API, http(s)://.../nic/update, to publish updates compatible with
several well-known services. The Updaters and Notifiers pages
describe the rest of the built-in updaters and notifiers.
However, if the built-in updaters or notifiers do not meet your needs, Ruddr is extensible. You can easily write your own and seamlessly tie it into your configuration. (If you think your custom notifier will be useful to others, feel free to submit a contribution, or you can upload it to PyPI yourself as an extension!) See the For Developers page for more information on that.
Finally (and the main reason Ruddr was born), Ruddr does its best to make dynamic DNS work with IPv6, despite the fact that hosts are not likely behind network address translation (NAT).