public
/
nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ddclient module: fix module 

* rewrite to systemd.services
* disable forking to give systemd better control
* verifiably run as ddclient user
* expose ssl option
* unset default value for dyndns server
* rename option "web" to "use" to be consistent with ddclient docs
* add descriptions
* add types to options
* clean up formatting
This commit is contained in:
Eduard Bachmakov 2015-02-18 23:44:29 -05:00
parent c1f50b6222
commit 4bf66ba89c
1 changed files with 58 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
nixos/modules/services/networking/ddclient.nix
View File

@ -3,24 +3,22 @@
let let
inherit (lib) mkOption mkIf singleton; inherit (lib) mkOption mkIf singleton;
inherit (pkgs) ddclient; inherit (pkgs) ddclient;
stateDir = "/var/spool/ddclient"; stateDir = "/var/spool/ddclient";
ddclientUser = "ddclient"; ddclientUser = "ddclient";
ddclientFlags = "-foreground -verbose -noquiet -file ${ddclientCfg}";
ddclientFlags = "-foreground -file ${ddclientCfg}"; ddclientPIDFile = "${stateDir}/ddclient.pid";
ddclientCfg = pkgs.writeText "ddclient.conf" '' ddclientCfg = pkgs.writeText "ddclient.conf" ''
daemon=600 daemon=600
cache=${stateDir}/ddclient.cache cache=${stateDir}/ddclient.cache
pid=${stateDir}/ddclient.pid pid=${ddclientPIDFile}
use=${config.services.ddclient.web} use=${config.services.ddclient.use}
login=${config.services.ddclient.username} login=${config.services.ddclient.username}
password=${config.services.ddclient.password} password=${config.services.ddclient.password}
protocol=${config.services.ddclient.protocol} protocol=${config.services.ddclient.protocol}
server=${config.services.ddclient.server} server=${config.services.ddclient.server}
ssl=${if config.services.ddclient.ssl then "yes" else "yes"}
wildcard=YES wildcard=YES
${config.services.ddclient.domain} ${config.services.ddclient.domain}
${config.services.ddclient.extraConfig} ${config.services.ddclient.extraConfig}
@ -34,10 +32,11 @@ in
options = { options = {
services.ddclient = { services.ddclient = with lib.types; {
enable = mkOption { enable = mkOption {
default = false; default = false;
type = bool;
description = '' description = ''
Whether to synchronise your machine's IP address with a dynamic DNS provider (e.g. dyndns.org). Whether to synchronise your machine's IP address with a dynamic DNS provider (e.g. dyndns.org).
''; '';
@ -45,6 +44,7 @@ in
domain = mkOption { domain = mkOption {
default = ""; default = "";
type = str;
description = '' description = ''
Domain name to synchronize. Domain name to synchronize.
''; '';
@ -52,76 +52,93 @@ in
username = mkOption { username = mkOption {
default = ""; default = "";
type = str;
description = '' description = ''
Username. Username.
''; '';
}; };
password = mkOption { password = mkOption {
default = "" ; default = "";
type = str;
description = '' description = ''
Password. Password.
''; '';
}; };
protocol = mkOption { protocol = mkOption {
default = "dyndns2" ; default = "dyndns2";
type = str;
description = '' description = ''
Protocol to use with dynamic DNS provider. (see also, http://sourceforge.net/apps/trac/ddclient/wiki/Protocols) Protocol to use with dynamic DNS provider (see http://sourceforge.net/apps/trac/ddclient/wiki/Protocols).
''; '';
}; };
server = mkOption { server = mkOption {
default = "members.dyndns.org" ; default = "";
type = str;
description = '' description = ''
Server Server address.
'';
};
ssl = mkOption {
default = true;
type = bool;
description = ''
Whether to use to use SSL/TLS to connect to dynamic DNS provider.
''; '';
}; };
extraConfig = mkOption { extraConfig = mkOption {
default = "" ; default = "";
type = str;
description = '' description = ''
Extra configuration. Contents will be added verbatim to the configuration file. Extra configuration. Contents will be added verbatim to the configuration file.
''; '';
}; };
web = mkOption { use = mkOption {
default = "web, web=checkip.dyndns.com/, web-skip='Current IP Address: '" ; default = "web, web=checkip.dyndns.com/, web-skip='Current IP Address: '";
description = ""; type = str;
description = ''
Method to determine the IP address to send to the dymanic DNS provider.
'';
}; };
}; };
}; };
###### implementation ###### implementation
config = mkIf config.services.ddclient.enable { config = mkIf config.services.ddclient.enable {
environment.systemPackages = [ ddclient ]; environment.systemPackages = [ ddclient ];
users.extraUsers = singleton users.extraUsers = singleton {
{ name = ddclientUser; name = ddclientUser;
uid = config.ids.uids.ddclient; uid = config.ids.uids.ddclient;
description = "ddclient daemon user"; description = "ddclient daemon user";
home = stateDir; home = stateDir;
};
systemd.services.ddclient = {
description = "Dynamic DNS Client";
wantedBy = [ "multi-user.target" ];
after = [ "network.target" ];
serviceConfig = {
# This may change back to forking if too many problems occur:
type = "simple";
User = ddclientUser;
Group = "nogroup"; #TODO get this to work
PermissionsStartOnly = "true";
PIDFile = ddclientPIDFile;
ExecStartPre = ''
${pkgs.stdenv.shell} -c "${pkgs.coreutils}/bin/mkdir -m 0755 -p ${stateDir} && ${pkgs.coreutils}/bin/chown ${ddclientUser} ${stateDir}"
'';
ExecStart = "${ddclient}/bin/ddclient ${ddclientFlags}";
#ExecStartPost = "${pkgs.coreutils}/bin/rm -r ${stateDir}"; # Should we have this?
}; };
};
jobs.ddclient =
{ name = "ddclient";
startOn = "startup";
preStart =
''
mkdir -m 0755 -p ${stateDir}
chown ${ddclientUser} ${stateDir}
'';
exec = "${ddclient}/bin/ddclient ${ddclientFlags}";
};
}; };
} }