Ddclient - Revision history

Klinger: Category:Networking added

2026-02-11T15:38:29Z

← Older revision		Revision as of 15:38, 11 February 2026
Line 41:		Line 41:
	# [https://github.com/ddclient/ddclient ddclient source code]		# [https://github.com/ddclient/ddclient ddclient source code]
	# [https://ddclient.net/ ddclient documentation]		# [https://ddclient.net/ ddclient documentation]
	[[Category:Server]]		[[Category:Server]] [[Category:Networking]]

Cartwatson: grammar + wordsmithing

2026-01-27T21:20:22Z

grammar + wordsmithing

← Older revision		Revision as of 21:20, 27 January 2026
Line 19:		Line 19:
	}\|name=configuration.nix\|lang=nix}}		}\|name=configuration.nix\|lang=nix}}

	{{Nixos:option\|services.ddclient.interval\|Interval}} may be set to a time of your choosing, check your DNS provider's documentation to ensure that you aren't sending requests too ~~often~~. For formatting run <code>man 7 systemd.time</code> or ~~checkout~~ the [https://man7.org/linux/man-pages/man7/systemd.time.7.html online man pages].		{{Nixos:option\|services.ddclient.interval\|Interval}} may be set to a time of your choosing, check your DNS provider's documentation to ensure that you aren't sending requests too frequently. For formatting, run <code>man 7 systemd.time</code> or reference the [https://man7.org/linux/man-pages/man7/systemd.time.7.html online man pages].

	=== Using Your DNS Provider ===		=== Using Your DNS Provider ===
	For more in depth info on using ddclient for a specific DNS provider visit the [https://ddclient.net/protocols.html ddclient documentation]. If your provider isn't listed there try searching the [https://github.com/ddclient/ddclient/blob/main/ddclient.in ddclient source code] ~~for your DNS name, modifying~~ the above configuration with the relevant {{Nixos:option\|services.ddclient.protocol\|protocol}}, {{Nixos:option\|services.ddclient.username\|username}}, {{Nixos:option\|services.ddclient.passwordFile\|passwordFile}}, {{Nixos:option\|services.ddclient.domain\|domain}}, and {{Nixos:option\|services.ddclient.zone\|zone}}.		For more in depth info on using ddclient for a specific DNS provider visit the [https://ddclient.net/protocols.html ddclient documentation]. If your provider isn't listed there try searching for the name of your DNS provider in the [https://github.com/ddclient/ddclient/blob/main/ddclient.in ddclient source code]. Modify the above configuration with the relevant {{Nixos:option\|services.ddclient.protocol\|protocol}}, {{Nixos:option\|services.ddclient.username\|username}}, {{Nixos:option\|services.ddclient.passwordFile\|passwordFile}}, {{Nixos:option\|services.ddclient.domain\|domain}}, and {{Nixos:option\|services.ddclient.zone\|zone}} from the documentation or source code.

	==== Cloudflare ====		==== Cloudflare ====
Line 32:		Line 32:
	fully.qualified.host ## the host registered with the service.\|name=ddclient.in\|lang=}}		fully.qualified.host ## the host registered with the service.\|name=ddclient.in\|lang=}}

	This excerpt of [https://github.com/ddclient/ddclient/blob/main/ddclient.in ddclient.in] describes the specific options needed for Cloudflare. Reference the above nix configuration to understand the mapping of ddclient config to Nix config.		This excerpt of [https://github.com/ddclient/ddclient/blob/main/ddclient.in ddclient.in] describes the specific options needed for Cloudflare. Reference the above nix configuration to understand the mapping between the ddclient config and the Nix config.

	== Troubleshooting ==		== Troubleshooting ==

Cartwatson: break down DNS Provider section for better extensibility

2026-01-23T23:13:22Z

break down DNS Provider section for better extensibility

← Older revision		Revision as of 23:13, 23 January 2026
Line 22:		Line 22:

	=== Using Your DNS Provider ===		=== Using Your DNS Provider ===
	For more in depth info on using ddclient for a specific DNS provider visit the [https://ddclient.net/protocols.html ddclient documentation]. If your provider isn't listed there try searching the [https://github.com/ddclient/ddclient/blob/main/ddclient.in ddclient source code] for your DNS name, modifying the above configuration with the relevant {{Nixos:option\|services.ddclient.protocol\|protocol}}, {{Nixos:option\|services.ddclient.username\|username}}, {{Nixos:option\|services.ddclient.passwordFile\|passwordFile}}, {{Nixos:option\|services.ddclient.domain\|domain}}, and {{Nixos:option\|services.ddclient.zone\|zone}}		For more in depth info on using ddclient for a specific DNS provider visit the [https://ddclient.net/protocols.html ddclient documentation]. If your provider isn't listed there try searching the [https://github.com/ddclient/ddclient/blob/main/ddclient.in ddclient source code] for your DNS name, modifying the above configuration with the relevant {{Nixos:option\|services.ddclient.protocol\|protocol}}, {{Nixos:option\|services.ddclient.username\|username}}, {{Nixos:option\|services.ddclient.passwordFile\|passwordFile}}, {{Nixos:option\|services.ddclient.domain\|domain}}, and {{Nixos:option\|services.ddclient.zone\|zone}}.

	~~As an example, look for a section like the below for your provider to define the necessary attributes~~.

			==== Cloudflare ====
	{{File\|3=Configuration variables applicable to the 'cloudflare' protocol are:		{{File\|3=Configuration variables applicable to the 'cloudflare' protocol are:
	protocol=cloudflare ##		protocol=cloudflare ##
Line 33:		Line 32:
	fully.qualified.host ## the host registered with the service.\|name=ddclient.in\|lang=}}		fully.qualified.host ## the host registered with the service.\|name=ddclient.in\|lang=}}

	This ~~will describe~~ the specific options needed for ~~your DNS provider~~.		This excerpt of [https://github.com/ddclient/ddclient/blob/main/ddclient.in ddclient.in] describes the specific options needed for Cloudflare. Reference the above nix configuration to understand the mapping of ddclient config to Nix config.

	== Troubleshooting ==		== Troubleshooting ==

Cartwatson: add server category

2026-01-23T21:43:19Z

add server category

← Older revision		Revision as of 21:43, 23 January 2026
Line 42:		Line 42:
	# [https://github.com/ddclient/ddclient ddclient source code]		# [https://github.com/ddclient/ddclient ddclient source code]
	# [https://ddclient.net/ ddclient documentation]		# [https://ddclient.net/ ddclient documentation]
			[[Category:Server]]

Cartwatson: Incorrect template used

2026-01-23T21:41:47Z

Incorrect template used

← Older revision		Revision as of 21:41, 23 January 2026
Line 19:		Line 19:
	}\|name=configuration.nix\|lang=nix}}		}\|name=configuration.nix\|lang=nix}}

	{{~~Nix~~:option\|Interval}} may be set to a time of your choosing, check your DNS provider's documentation to ensure that you aren't sending requests too often. For formatting run <code>man 7 systemd.time</code> or checkout the [https://man7.org/linux/man-pages/man7/systemd.time.7.html online man pages].		{{Nixos:option\|services.ddclient.interval\|Interval}} may be set to a time of your choosing, check your DNS provider's documentation to ensure that you aren't sending requests too often. For formatting run <code>man 7 systemd.time</code> or checkout the [https://man7.org/linux/man-pages/man7/systemd.time.7.html online man pages].

	=== Using Your DNS Provider ===		=== Using Your DNS Provider ===

Cartwatson: switch to using templates instead of code blocks

2026-01-23T21:40:25Z

switch to using templates instead of code blocks

← Older revision		Revision as of 21:40, 23 January 2026
Line 3:		Line 3:
	== Installation & Configuration ==		== Installation & Configuration ==
	Below is an example configuration to dynamically update your records in [https://www.cloudflare.com/application-services/products/dns/ Cloudflare DNS]		Below is an example configuration to dynamically update your records in [https://www.cloudflare.com/application-services/products/dns/ Cloudflare DNS]
	services.ddclient = {
	enable = true;		{{File\|3={
	interval = "5min";		...
	protocol = "cloudflare";		services.ddclient = {
	username = "token";		enable = true;
	passwordFile = "/path/to/api.key";		interval = "5min";
	domains = [ "example.com" ];		protocol = "cloudflare";
	zone = "example.com";		username = "token";
	ssl = true;		passwordFile = "/path/to/api.key";
	};		domains = [ "example.com" ];
	~~<code>~~Interval~~</code>~~ may be set to a time of your choosing, check your DNS provider's documentation to ensure that you aren't sending requests too often. For formatting run <code>man 7 systemd.time</code> or checkout the [https://man7.org/linux/man-pages/man7/systemd.time.7.html online man pages].		zone = "example.com";
			ssl = true;
			};
			...
			}\|name=configuration.nix\|lang=nix}}

			{{Nix:option\|Interval}} may be set to a time of your choosing, check your DNS provider's documentation to ensure that you aren't sending requests too often. For formatting run <code>man 7 systemd.time</code> or checkout the [https://man7.org/linux/man-pages/man7/systemd.time.7.html online man pages].

	=== Using Your DNS Provider ===		=== Using Your DNS Provider ===
	For more in depth info on using ddclient for a specific DNS provider visit the [https://ddclient.net/protocols.html ddclient documentation]. If your provider isn't listed there try searching the [https://github.com/ddclient/ddclient/blob/main/ddclient.in ddclient source code] for your DNS name, modifying the above configuration with the relevant ~~<code>~~protocol~~</code>~~, ~~<code>~~username~~</code>~~, ~~<code>~~passwordFile~~</code>~~, ~~<code>~~domain~~</code>~~, and ~~<code>~~zone~~</code>~~.		For more in depth info on using ddclient for a specific DNS provider visit the [https://ddclient.net/protocols.html ddclient documentation]. If your provider isn't listed there try searching the [https://github.com/ddclient/ddclient/blob/main/ddclient.in ddclient source code] for your DNS name, modifying the above configuration with the relevant {{Nixos:option\|services.ddclient.protocol\|protocol}}, {{Nixos:option\|services.ddclient.username\|username}}, {{Nixos:option\|services.ddclient.passwordFile\|passwordFile}}, {{Nixos:option\|services.ddclient.domain\|domain}}, and {{Nixos:option\|services.ddclient.zone\|zone}}

			As an example, look for a section like the below for your provider to define the necessary attributes.

	~~As an example, look for a section like this for your provider.~~		{{File\|3=Configuration variables applicable to the 'cloudflare' protocol are:
	Configuration variables applicable to the 'cloudflare' protocol are:
	protocol=cloudflare ##		protocol=cloudflare ##
	server=fqdn.of.service ## defaults to api.cloudflare.com/client/v4		server=fqdn.of.service ## defaults to api.cloudflare.com/client/v4
	login=service-login ## login email when using a global API key		login=service-login ## login email when using a global API key
	password=service-password ## An API token, it must have the permissions "Zone - DNS - Edit" and "Zone - Zone - Read". The Zone resources must be "Include - All zones".		password=service-password ## An API token, it must have the permissions "Zone - DNS - Edit" and "Zone - Zone - Read". The Zone resources must be "Include - All zones".
	fully.qualified.host ## the host registered with the service.		fully.qualified.host ## the host registered with the service.\|name=ddclient.in\|lang=}}
	This will describe ~~any~~ specific ~~changes~~ needed for your DNS provider.
			This will describe the specific options needed for your DNS provider.

	== Troubleshooting ==		== Troubleshooting ==
	Adding ~~<code>~~verbose = true~~;</code>~~ to your ddclient config will enable debug logs on the [[systemd]] unit~~, the~~ debug logs can help verify that the client is ~~running and~~ able to reach your DNS provider even if it doesn't need to change the DNS records ~~at the moment~~.		Adding {{Nixos:option\|services.ddclient.verbose\|2=verbose = true}} to your ddclient config will enable debug logs on the [[systemd]] unit. The debug logs can help verify that the client is able to reach your DNS provider even if it doesn't need to change the DNS records.

	== References ==		== References ==

Cartwatson: Created basic page for ddclient

2026-01-23T20:16:06Z

Created basic page for ddclient

New page

[https://github.com/ddclient/ddclient Ddclient] is a program that can dynamically update your [[wikipedia:Domain_Name_System|DNS]] records for a variety of providers. This is helpful if you're hosting a server without a static IP address.

== Installation & Configuration ==
Below is an example configuration to dynamically update your records in [https://www.cloudflare.com/application-services/products/dns/ Cloudflare DNS]
services.ddclient = {
enable = true;
interval = "5min";
protocol = "cloudflare";
username = "token";
passwordFile = "/path/to/api.key";
domains = [ "example.com" ];
zone = "example.com";
ssl = true;
};
<code>Interval</code> may be set to a time of your choosing, check your DNS provider's documentation to ensure that you aren't sending requests too often. For formatting run <code>man 7 systemd.time</code> or checkout the [https://man7.org/linux/man-pages/man7/systemd.time.7.html online man pages].

=== Using Your DNS Provider ===
For more in depth info on using ddclient for a specific DNS provider visit the [https://ddclient.net/protocols.html ddclient documentation]. If your provider isn't listed there try searching the [https://github.com/ddclient/ddclient/blob/main/ddclient.in ddclient source code] for your DNS name, modifying the above configuration with the relevant <code>protocol</code>, <code>username</code>, <code>passwordFile</code>, <code>domain</code>, and <code>zone</code>.

As an example, look for a section like this for your provider.
Configuration variables applicable to the 'cloudflare' protocol are:
protocol=cloudflare ##
server=fqdn.of.service ## defaults to api.cloudflare.com/client/v4
login=service-login ## login email when using a global API key
password=service-password ## An API token, it must have the permissions "Zone - DNS - Edit" and "Zone - Zone - Read". The Zone resources must be "Include - All zones".
fully.qualified.host ## the host registered with the service.
This will describe any specific changes needed for your DNS provider.

== Troubleshooting ==
Adding <code>verbose = true;</code> to your ddclient config will enable debug logs on the [[systemd]] unit, the debug logs can help verify that the client is running and able to reach your DNS provider even if it doesn't need to change the DNS records at the moment.

== References ==

# [https://github.com/ddclient/ddclient ddclient source code]
# [https://ddclient.net/ ddclient documentation]