nixos/modules/services/networking/zeronet.nix

   1 { config, lib, pkgs, ... }:
   2
   3 let
   4   inherit (lib) generators literalExpression mkEnableOption mkIf mkOption recursiveUpdate types;
   5   cfg = config.services.zeronet;
   6   dataDir = "/var/lib/zeronet";
   7   configFile = pkgs.writeText "zeronet.conf" (generators.toINI {} (recursiveUpdate defaultSettings cfg.settings));
   8
   9   defaultSettings = {
  10     global = {
  11       data_dir = dataDir;
  12       log_dir = dataDir;
  13       ui_port = cfg.port;
  14       fileserver_port = cfg.fileserverPort;
  15       tor = if !cfg.tor then "disable" else if cfg.torAlways then "always" else "enable";
  16     };
  17   };
  18 in with lib; {
  19   options.services.zeronet = {
  20     enable = mkEnableOption (lib.mdDoc "zeronet");
  21
  22     package = mkOption {
  23       type = types.package;
  24       default = pkgs.zeronet;
  25       defaultText = literalExpression "pkgs.zeronet";
  26       description = lib.mdDoc "ZeroNet package to use";
  27     };
  28
  29     settings = mkOption {
  30       type = with types; attrsOf (oneOf [ str int bool (listOf str) ]);
  31       default = {};
  32       example = literalExpression "{ global.tor = enable; }";
  33
  34       description = lib.mdDoc ''
  35         {file}`zeronet.conf` configuration. Refer to
  36         <https://zeronet.readthedocs.io/en/latest/faq/#is-it-possible-to-use-a-configuration-file>
  37         for details on supported values;
  38       '';
  39     };
  40
  41     port = mkOption {
  42       type = types.port;
  43       default = 43110;
  44       description = lib.mdDoc "Optional zeronet web UI port.";
  45     };
  46
  47     fileserverPort = mkOption {
  48       # Not optional: when absent zeronet tries to write one to the
  49       # read-only config file and crashes
  50       type = types.port;
  51       default = 12261;
  52       description = lib.mdDoc "Zeronet fileserver port.";
  53     };
  54
  55     tor = mkOption {
  56       type = types.bool;
  57       default = false;
  58       description = lib.mdDoc "Use TOR for zeronet traffic where possible.";
  59     };
  60
  61     torAlways = mkOption {
  62       type = types.bool;
  63       default = false;
  64       description = lib.mdDoc "Use TOR for all zeronet traffic.";
  65     };
  66   };
  67
  68   config = mkIf cfg.enable {
  69     services.tor = mkIf cfg.tor {
  70       enable = true;
  71       controlPort = 9051;
  72
  73       extraConfig = ''
  74         CacheDirectoryGroupReadable 1
  75         CookieAuthentication 1
  76         CookieAuthFileGroupReadable 1
  77       '';
  78     };
  79
  80     systemd.services.zeronet = {
  81       description = "zeronet";
  82       after = [ "network.target" ] ++ optional cfg.tor "tor.service";
  83       wantedBy = [ "multi-user.target" ];
  84
  85       serviceConfig = {
  86         User = "zeronet";
  87         DynamicUser = true;
  88         StateDirectory = "zeronet";
  89         SupplementaryGroups = mkIf cfg.tor [ "tor" ];
  90         ExecStart = "${cfg.package}/bin/zeronet --config_file ${configFile}";
  91       };
  92     };
  93   };
  94
  95   imports = [
  96     (mkRemovedOptionModule [ "services" "zeronet" "dataDir" ] "Zeronet will store data by default in /var/lib/zeronet")
  97     (mkRemovedOptionModule [ "services" "zeronet" "logDir" ] "Zeronet will log by default in /var/lib/zeronet")
  98   ];
  99
 100   meta.maintainers = with maintainers; [ Madouura ];
 101 }