nixos/modules/services/torrent/deluge.nix

   1 { config, lib, pkgs, ... }:
   2
   3 with lib;
   4
   5 let
   6   cfg = config.services.deluge;
   7   cfg_web = config.services.deluge.web;
   8   isDeluge1 = versionOlder cfg.package.version "2.0.0";
   9
  10   openFilesLimit = 4096;
  11   listenPortsDefault = [ 6881 6889 ];
  12
  13   listToRange = x: { from = elemAt x 0; to = elemAt x 1; };
  14
  15   configDir = "${cfg.dataDir}/.config/deluge";
  16   configFile = pkgs.writeText "core.conf" (builtins.toJSON cfg.config);
  17   declarativeLockFile = "${configDir}/.declarative";
  18
  19   preStart = if cfg.declarative then ''
  20     if [ -e ${declarativeLockFile} ]; then
  21       # Was declarative before, no need to back up anything
  22       ${if isDeluge1 then "ln -sf" else "cp"} ${configFile} ${configDir}/core.conf
  23       ln -sf ${cfg.authFile} ${configDir}/auth
  24     else
  25       # Declarative for the first time, backup stateful files
  26       ${if isDeluge1 then "ln -s" else "cp"} -b --suffix=.stateful ${configFile} ${configDir}/core.conf
  27       ln -sb --suffix=.stateful ${cfg.authFile} ${configDir}/auth
  28       echo "Autogenerated file that signifies that this server configuration is managed declaratively by NixOS" \
  29         > ${declarativeLockFile}
  30     fi
  31   '' else ''
  32     if [ -e ${declarativeLockFile} ]; then
  33       rm ${declarativeLockFile}
  34     fi
  35   '';
  36 in {
  37   options = {
  38     services = {
  39       deluge = {
  40         enable = mkEnableOption "Deluge daemon";
  41
  42         openFilesLimit = mkOption {
  43           default = openFilesLimit;
  44           type = types.either types.int types.str;
  45           description = ''
  46             Number of files to allow deluged to open.
  47           '';
  48         };
  49
  50         config = mkOption {
  51           type = types.attrs;
  52           default = {};
  53           example = literalExpression ''
  54             {
  55               download_location = "/srv/torrents/";
  56               max_upload_speed = "1000.0";
  57               share_ratio_limit = "2.0";
  58               allow_remote = true;
  59               daemon_port = 58846;
  60               listen_ports = [ ${toString listenPortsDefault} ];
  61             }
  62           '';
  63           description = ''
  64             Deluge core configuration for the core.conf file. Only has an effect
  65             when {option}`services.deluge.declarative` is set to
  66             `true`. String values must be quoted, integer and
  67             boolean values must not. See
  68             <https://git.deluge-torrent.org/deluge/tree/deluge/core/preferencesmanager.py#n41>
  69             for the available options.
  70           '';
  71         };
  72
  73         declarative = mkOption {
  74           type = types.bool;
  75           default = false;
  76           description = ''
  77             Whether to use a declarative deluge configuration.
  78             Only if set to `true`, the options
  79             {option}`services.deluge.config`,
  80             {option}`services.deluge.openFirewall` and
  81             {option}`services.deluge.authFile` will be
  82             applied.
  83           '';
  84         };
  85
  86         openFirewall = mkOption {
  87           default = false;
  88           type = types.bool;
  89           description = ''
  90             Whether to open the firewall for the ports in
  91             {option}`services.deluge.config.listen_ports`. It only takes effet if
  92             {option}`services.deluge.declarative` is set to
  93             `true`.
  94
  95             It does NOT apply to the daemon port nor the web UI port. To access those
  96             ports securely check the documentation
  97             <https://dev.deluge-torrent.org/wiki/UserGuide/ThinClient#CreateSSHTunnel>
  98             or use a VPN or configure certificates for deluge.
  99           '';
 100         };
 101
 102         dataDir = mkOption {
 103           type = types.path;
 104           default = "/var/lib/deluge";
 105           description = ''
 106             The directory where deluge will create files.
 107           '';
 108         };
 109
 110         authFile = mkOption {
 111           type = types.path;
 112           example = "/run/keys/deluge-auth";
 113           description = ''
 114             The file managing the authentication for deluge, the format of this
 115             file is straightforward, each line contains a
 116             username:password:level tuple in plaintext. It only has an effect
 117             when {option}`services.deluge.declarative` is set to
 118             `true`.
 119             See <https://dev.deluge-torrent.org/wiki/UserGuide/Authentication> for
 120             more information.
 121           '';
 122         };
 123
 124         user = mkOption {
 125           type = types.str;
 126           default = "deluge";
 127           description = ''
 128             User account under which deluge runs.
 129           '';
 130         };
 131
 132         group = mkOption {
 133           type = types.str;
 134           default = "deluge";
 135           description = ''
 136             Group under which deluge runs.
 137           '';
 138         };
 139
 140         extraPackages = mkOption {
 141           type = types.listOf types.package;
 142           default = [];
 143           description = ''
 144             Extra packages available at runtime to enable Deluge's plugins. For example,
 145             extraction utilities are required for the built-in "Extractor" plugin.
 146             This always contains unzip, gnutar, xz and bzip2.
 147           '';
 148         };
 149
 150         package = mkPackageOption pkgs "deluge-2_x" { };
 151       };
 152
 153       deluge.web = {
 154         enable = mkEnableOption "Deluge Web daemon";
 155
 156         port = mkOption {
 157           type = types.port;
 158           default = 8112;
 159           description = ''
 160             Deluge web UI port.
 161           '';
 162         };
 163
 164         openFirewall = mkOption {
 165           type = types.bool;
 166           default = false;
 167           description = ''
 168             Open ports in the firewall for deluge web daemon
 169           '';
 170         };
 171       };
 172     };
 173   };
 174
 175   config = mkIf cfg.enable {
 176
 177     services.deluge.package = mkDefault (
 178       if versionAtLeast config.system.stateVersion "20.09" then
 179         pkgs.deluge-2_x
 180       else
 181         # deluge-1_x is no longer packaged and this will resolve to an error
 182         # thanks to the alias for this name.  This is left here so that anyone
 183         # using NixOS older than 20.09 receives that error when they upgrade
 184         # and is forced to make an intentional choice to switch to deluge-2_x.
 185         # That might be slightly inconvenient but there is no path to
 186         # downgrade from 2.x to 1.x so NixOS should not automatically perform
 187         # this state migration.
 188         pkgs.deluge-1_x
 189     );
 190
 191     # Provide a default set of `extraPackages`.
 192     services.deluge.extraPackages = with pkgs; [ unzip gnutar xz bzip2 ];
 193
 194     systemd.tmpfiles.settings."10-deluged" = let
 195       defaultConfig = {
 196         inherit (cfg) user group;
 197         mode = "0770";
 198       };
 199     in {
 200       "${cfg.dataDir}".d = defaultConfig;
 201       "${cfg.dataDir}/.config".d = defaultConfig;
 202       "${cfg.dataDir}/.config/deluge".d = defaultConfig;
 203     }
 204     // optionalAttrs (cfg.config ? download_location) {
 205       ${cfg.config.download_location}.d = defaultConfig;
 206     }
 207     // optionalAttrs (cfg.config ? torrentfiles_location) {
 208       ${cfg.config.torrentfiles_location}.d = defaultConfig;
 209     }
 210     // optionalAttrs (cfg.config ? move_completed_path) {
 211       ${cfg.config.move_completed_path}.d = defaultConfig;
 212     };
 213
 214     systemd.services.deluged = {
 215       after = [ "network.target" ];
 216       description = "Deluge BitTorrent Daemon";
 217       wantedBy = [ "multi-user.target" ];
 218       path = [ cfg.package ] ++ cfg.extraPackages;
 219       serviceConfig = {
 220         ExecStart = ''
 221           ${cfg.package}/bin/deluged \
 222             --do-not-daemonize \
 223             --config ${configDir}
 224         '';
 225         # To prevent "Quit & shutdown daemon" from working; we want systemd to
 226         # manage it!
 227         Restart = "on-success";
 228         User = cfg.user;
 229         Group = cfg.group;
 230         UMask = "0002";
 231         LimitNOFILE = cfg.openFilesLimit;
 232       };
 233       preStart = preStart;
 234     };
 235
 236     systemd.services.delugeweb = mkIf cfg_web.enable {
 237       after = [ "network.target" "deluged.service"];
 238       requires = [ "deluged.service" ];
 239       description = "Deluge BitTorrent WebUI";
 240       wantedBy = [ "multi-user.target" ];
 241       path = [ cfg.package ];
 242       serviceConfig = {
 243         ExecStart = ''
 244           ${cfg.package}/bin/deluge-web \
 245             ${optionalString (!isDeluge1) "--do-not-daemonize"} \
 246             --config ${configDir} \
 247             --port ${toString cfg.web.port}
 248         '';
 249         User = cfg.user;
 250         Group = cfg.group;
 251       };
 252     };
 253
 254     networking.firewall = mkMerge [
 255       (mkIf (cfg.declarative && cfg.openFirewall && !(cfg.config.random_port or true)) {
 256         allowedTCPPortRanges = singleton (listToRange (cfg.config.listen_ports or listenPortsDefault));
 257         allowedUDPPortRanges = singleton (listToRange (cfg.config.listen_ports or listenPortsDefault));
 258       })
 259       (mkIf (cfg.web.openFirewall) {
 260         allowedTCPPorts = [ cfg.web.port ];
 261       })
 262     ];
 263
 264     environment.systemPackages = [ cfg.package ];
 265
 266     users.users = mkIf (cfg.user == "deluge") {
 267       deluge = {
 268         group = cfg.group;
 269         uid = config.ids.uids.deluge;
 270         home = cfg.dataDir;
 271         description = "Deluge Daemon user";
 272       };
 273     };
 274
 275     users.groups = mkIf (cfg.group == "deluge") {
 276       deluge = {
 277         gid = config.ids.gids.deluge;
 278       };
 279     };
 280   };
 281 }