Merge pull request #241462 from SuperSandro2000/remove-ddclient (0d2f526d) · Commits · nix / nixpkgs

nixos/doc/manual/release-notes/rl-2311.section.md

+2 −0

Original line number	Diff line number	Diff line
		@@ -52,6 +52,8 @@

		- `util-linux` is now supported on Darwin and is no longer an alias to `unixtools`. Use the `unixtools.util-linux` package for access to the Apple variants of the utilities.

		- `services.ddclient` has been removed on the request of the upstream maintainer because it is unmaintained and has bugs. Please switch to a different software like `inadyn` or `knsupdate`.

		- The `vlock` program from the `kbd` package has been moved into its own package output and should now be referenced explicitly as `kbd.vlock` or replaced with an alternative such as the standalone `vlock` package or `physlock`.

		- `fileSystems.<name>.autoFormat` now uses `systemd-makefs`, which does not accept formatting options. Therefore, `fileSystems.<name>.formatOptions` has been removed.

nixos/modules/misc/ids.nix

+2 −2

Original line number	Diff line number	Diff line
		@@ -69,7 +69,7 @@ in
		#dialout = 27; # unused
		polkituser = 28;
		#utmp = 29; # unused
		# ddclient = 30; # converted to DynamicUser = true
		# ddclient = 30; # software removed
		davfs2 = 31;
		disnix = 33;
		osgi = 34;
		@@ -394,7 +394,7 @@ in
		dialout = 27;
		#polkituser = 28; # currently unused, polkitd doesn't need a group
		utmp = 29;
		# ddclient = 30; # converted to DynamicUser = true
		# ddclient = 30; # software removed
		davfs2 = 31;
		disnix = 33;
		osgi = 34;

nixos/modules/module-list.nix

+0 −1

Original line number	Diff line number	Diff line
		@@ -852,7 +852,6 @@
		./services/networking/create_ap.nix
		./services/networking/croc.nix
		./services/networking/dante.nix
		./services/networking/ddclient.nix
		./services/networking/dhcpcd.nix
		./services/networking/dhcpd.nix
		./services/networking/dnscache.nix

nixos/modules/rename.nix

+1 −0

Original line number	Diff line number	Diff line
		@@ -54,6 +54,7 @@ in
		(mkRemovedOptionModule [ "services" "chronos" ] "The corresponding package was removed from nixpkgs.")
		(mkRemovedOptionModule [ "services" "couchpotato" ] "The corresponding package was removed from nixpkgs.")
		(mkRemovedOptionModule [ "services" "dd-agent" ] "dd-agent was removed from nixpkgs in favor of the newer datadog-agent.")
		(mkRemovedOptionModule [ "services" "ddclient" ] "ddclient has been removed on the request of the upstream maintainer because it is unmaintained and has bugs. Please switch to a different software like `inadyn` or `knsupdate`.") # Added 2023-07-04
		(mkRemovedOptionModule [ "services" "dnscrypt-proxy" ] "Use services.dnscrypt-proxy2 instead")
		(mkRemovedOptionModule [ "services" "exhibitor" ] "The corresponding package was removed from nixpkgs.")
		(mkRemovedOptionModule [ "services" "firefox" "syncserver" ] "The corresponding package was removed from nixpkgs.")

nixos/modules/services/networking/ddclient.nix

deleted100644 → 0

+0 −234

Original line number	Diff line number	Diff line
		{ config, pkgs, lib, ... }:

		let
		cfg = config.services.ddclient;
		boolToStr = bool: if bool then "yes" else "no";
		dataDir = "/var/lib/ddclient";
		StateDirectory = builtins.baseNameOf dataDir;
		RuntimeDirectory = StateDirectory;

		configFile' = pkgs.writeText "ddclient.conf" ''
		# This file can be used as a template for configFile or is automatically generated by Nix options.
		cache=${dataDir}/ddclient.cache
		foreground=YES
		use=${cfg.use}
		login=${cfg.username}
		password=${if cfg.protocol == "nsupdate" then "/run/${RuntimeDirectory}/ddclient.key" else "@password_placeholder@"}
		protocol=${cfg.protocol}
		${lib.optionalString (cfg.script != "") "script=${cfg.script}"}
		${lib.optionalString (cfg.server != "") "server=${cfg.server}"}
		${lib.optionalString (cfg.zone != "") "zone=${cfg.zone}"}
		ssl=${boolToStr cfg.ssl}
		wildcard=YES
		quiet=${boolToStr cfg.quiet}
		verbose=${boolToStr cfg.verbose}
		${cfg.extraConfig}
		${lib.concatStringsSep "," cfg.domains}
		'';
		configFile = if (cfg.configFile != null) then cfg.configFile else configFile';

		preStart = ''
		install --mode=600 --owner=$USER ${configFile} /run/${RuntimeDirectory}/ddclient.conf
		${lib.optionalString (cfg.configFile == null) (if (cfg.protocol == "nsupdate") then ''
		install --mode=600 --owner=$USER ${cfg.passwordFile} /run/${RuntimeDirectory}/ddclient.key
		'' else if (cfg.passwordFile != null) then ''
		"${pkgs.replace-secret}/bin/replace-secret" "@password_placeholder@" "${cfg.passwordFile}" "/run/${RuntimeDirectory}/ddclient.conf"
		'' else ''
		sed -i '/^password=@password_placeholder@$/d' /run/${RuntimeDirectory}/ddclient.conf
		'')}
		'';

		in

		with lib;

		{

		imports = [
		(mkChangedOptionModule [ "services" "ddclient" "domain" ] [ "services" "ddclient" "domains" ]
		(config:
		let value = getAttrFromPath [ "services" "ddclient" "domain" ] config;
		in optional (value != "") value))
		(mkRemovedOptionModule [ "services" "ddclient" "homeDir" ] "")
		(mkRemovedOptionModule [ "services" "ddclient" "password" ] "Use services.ddclient.passwordFile instead.")
		(mkRemovedOptionModule [ "services" "ddclient" "ipv6" ] "")
		];

		###### interface

		options = {

		services.ddclient = with lib.types; {

		enable = mkOption {
		default = false;
		type = bool;
		description = lib.mdDoc ''
		Whether to synchronise your machine's IP address with a dynamic DNS provider (e.g. dyndns.org).
		'';
		};

		package = mkOption {
		type = package;
		default = pkgs.ddclient;
		defaultText = lib.literalExpression "pkgs.ddclient";
		description = lib.mdDoc ''
		The ddclient executable package run by the service.
		'';
		};

		domains = mkOption {
		default = [ "" ];
		type = listOf str;
		description = lib.mdDoc ''
		Domain name(s) to synchronize.
		'';
		};

		username = mkOption {
		# For `nsupdate` username contains the path to the nsupdate executable
		default = lib.optionalString (config.services.ddclient.protocol == "nsupdate") "${pkgs.bind.dnsutils}/bin/nsupdate";
		defaultText = "";
		type = str;
		description = lib.mdDoc ''
		User name.
		'';
		};

		passwordFile = mkOption {
		default = null;
		type = nullOr str;
		description = lib.mdDoc ''
		A file containing the password or a TSIG key in named format when using the nsupdate protocol.
		'';
		};

		interval = mkOption {
		default = "10min";
		type = str;
		description = lib.mdDoc ''
		The interval at which to run the check and update.
		See {command}`man 7 systemd.time` for the format.
		'';
		};

		configFile = mkOption {
		default = null;
		type = nullOr path;
		description = lib.mdDoc ''
		Path to configuration file.
		When set this overrides the generated configuration from module options.
		'';
		example = "/root/nixos/secrets/ddclient.conf";
		};

		protocol = mkOption {
		default = "dyndns2";
		type = str;
		description = lib.mdDoc ''
		Protocol to use with dynamic DNS provider (see https://sourceforge.net/p/ddclient/wiki/protocols).
		'';
		};

		server = mkOption {
		default = "";
		type = str;
		description = lib.mdDoc ''
		Server address.
		'';
		};

		ssl = mkOption {
		default = true;
		type = bool;
		description = lib.mdDoc ''
		Whether to use SSL/TLS to connect to dynamic DNS provider.
		'';
		};

		quiet = mkOption {
		default = false;
		type = bool;
		description = lib.mdDoc ''
		Print no messages for unnecessary updates.
		'';
		};

		script = mkOption {
		default = "";
		type = str;
		description = lib.mdDoc ''
		script as required by some providers.
		'';
		};

		use = mkOption {
		default = "web, web=checkip.dyndns.com/, web-skip='Current IP Address: '";
		type = str;
		description = lib.mdDoc ''
		Method to determine the IP address to send to the dynamic DNS provider.
		'';
		};

		verbose = mkOption {
		default = false;
		type = bool;
		description = lib.mdDoc ''
		Print verbose information.
		'';
		};

		zone = mkOption {
		default = "";
		type = str;
		description = lib.mdDoc ''
		zone as required by some providers.
		'';
		};

		extraConfig = mkOption {
		default = "";
		type = lines;
		description = lib.mdDoc ''
		Extra configuration. Contents will be added verbatim to the configuration file.

		::: {.note}
		`daemon` should not be added here because it does not work great with the systemd-timer approach the service uses.
		:::
		'';
		};
		};
		};


		###### implementation

		config = mkIf config.services.ddclient.enable {
		systemd.services.ddclient = {
		description = "Dynamic DNS Client";
		wantedBy = [ "multi-user.target" ];
		after = [ "network.target" ];
		restartTriggers = optional (cfg.configFile != null) cfg.configFile;
		path = lib.optional (lib.hasPrefix "if," cfg.use) pkgs.iproute2;

		serviceConfig = {
		DynamicUser = true;
		RuntimeDirectoryMode = "0700";
		inherit RuntimeDirectory;
		inherit StateDirectory;
		Type = "oneshot";
		ExecStartPre = "!${pkgs.writeShellScript "ddclient-prestart" preStart}";
		ExecStart = "${lib.getBin cfg.package}/bin/ddclient -file /run/${RuntimeDirectory}/ddclient.conf";
		};
		};

		systemd.timers.ddclient = {
		description = "Run ddclient";
		wantedBy = [ "timers.target" ];
		timerConfig = {
		OnBootSec = cfg.interval;
		OnUnitInactiveSec = cfg.interval;
		};
		};
		};
		}

Admin message