commit 71fb79ee6b2485c2c91ddec5213eec553fe6aa42 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       806
       806
        
         ./services/networking/smartdns.nix

     

       807
       807
        
         ./services/networking/smokeping.nix

     

       808
       808
        
         ./services/networking/softether.nix

     

       809
       809
       +
         ./services/networking/solanum.nix

     

       809
       810
        
         ./services/networking/spacecookie.nix

     

       810
       811
        
         ./services/networking/spiped.nix

     

       811
       812
        
         ./services/networking/squid.nix

+104

nixos/modules/services/networking/solanum.nix

···

       1
       1
       +
       { config, lib, pkgs, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       let

     

       4
       4
       +
         inherit (lib) mkEnableOption mkIf mkOption types;

     

       5
       5
       +
         inherit (pkgs) solanum;

     

       6
       6
       +
         cfg = config.services.solanum;

     

       7
       7
       +
       

     

       8
       8
       +
         configFile = pkgs.writeText "solanum.conf" cfg.config;

     

       9
       9
       +
       in

     

       10
       10
       +
       

     

       11
       11
       +
       {

     

       12
       12
       +
       

     

       13
       13
       +
         ###### interface

     

       14
       14
       +
       

     

       15
       15
       +
         options = {

     

       16
       16
       +
       

     

       17
       17
       +
           services.solanum = {

     

       18
       18
       +
       

     

       19
       19
       +
             enable = mkEnableOption "Solanum IRC daemon";

     

       20
       20
       +
       

     

       21
       21
       +
             config = mkOption {

     

       22
       22
       +
               type = types.str;

     

       23
       23
       +
               default = ''

     

       24
       24
       +
                 serverinfo {

     

       25
       25
       +
                   name = "irc.example.com";

     

       26
       26
       +
                   sid = "1ix";

     

       27
       27
       +
                   description = "irc!";

     

       28
       28
       +
       

     

       29
       29
       +
                   vhost = "0.0.0.0";

     

       30
       30
       +
                   vhost6 = "::";

     

       31
       31
       +
                 };

     

       32
       32
       +
       

     

       33
       33
       +
                 listen {

     

       34
       34
       +
                   host = "0.0.0.0";

     

       35
       35
       +
                   port = 6667;

     

       36
       36
       +
                 };

     

       37
       37
       +
       

     

       38
       38
       +
                 auth {

     

       39
       39
       +
                   user = "*@*";

     

       40
       40
       +
                   class = "users";

     

       41
       41
       +
                   flags = exceed_limit;

     

       42
       42
       +
                 };

     

       43
       43
       +
                 channel {

     

       44
       44
       +
                   default_split_user_count = 0;

     

       45
       45
       +
                 };

     

       46
       46
       +
               '';

     

       47
       47
       +
               description = ''

     

       48
       48
       +
                 Solanum IRC daemon configuration file.

     

       49
       49
       +
                 check <link xlink:href="https://github.com/solanum-ircd/solanum/blob/main/doc/reference.conf"/> for all options.

     

       50
       50
       +
               '';

     

       51
       51
       +
             };

     

       52
       52
       +
       

     

       53
       53
       +
             openFilesLimit = mkOption {

     

       54
       54
       +
               type = types.int;

     

       55
       55
       +
               default = 1024;

     

       56
       56
       +
               description = ''

     

       57
       57
       +
                 Maximum number of open files. Limits the clients and server connections.

     

       58
       58
       +
               '';

     

       59
       59
       +
             };

     

       60
       60
       +
       

     

       61
       61
       +
             motd = mkOption {

     

       62
       62
       +
               type = types.nullOr types.lines;

     

       63
       63
       +
               default = null;

     

       64
       64
       +
               description = ''

     

       65
       65
       +
                 Solanum MOTD text.

     

       66
       66
       +
       

     

       67
       67
       +
                 Solanum will read its MOTD from <literal>/etc/solanum/ircd.motd</literal>.

     

       68
       68
       +
                 If set, the value of this option will be written to this path.

     

       69
       69
       +
               '';

     

       70
       70
       +
             };

     

       71
       71
       +
       

     

       72
       72
       +
           };

     

       73
       73
       +
       

     

       74
       74
       +
         };

     

       75
       75
       +
       

     

       76
       76
       +
       

     

       77
       77
       +
         ###### implementation

     

       78
       78
       +
       

     

       79
       79
       +
         config = mkIf cfg.enable (lib.mkMerge [

     

       80
       80
       +
           {

     

       81
       81
       +
             systemd.services.solanum = {

     

       82
       82
       +
               description = "Solanum IRC daemon";

     

       83
       83
       +
               after = [ "network.target" ];

     

       84
       84
       +
               wantedBy = [ "multi-user.target" ];

     

       85
       85
       +
               environment = {

     

       86
       86
       +
                 BANDB_DBPATH = "/var/lib/solanum/ban.db";

     

       87
       87
       +
               };

     

       88
       88
       +
               serviceConfig = {

     

       89
       89
       +
                 ExecStart   = "${solanum}/bin/solanum -foreground -logfile /dev/stdout -configfile ${configFile} -pidfile /run/solanum/ircd.pid";

     

       90
       90
       +
                 DynamicUser = true;

     

       91
       91
       +
                 User = "solanum";

     

       92
       92
       +
                 StateDirectory = "solanum";

     

       93
       93
       +
                 RuntimeDirectory = "solanum";

     

       94
       94
       +
                 LimitNOFILE = "${toString cfg.openFilesLimit}";

     

       95
       95
       +
               };

     

       96
       96
       +
             };

     

       97
       97
       +
       

     

       98
       98
       +
           }

     

       99
       99
       +
       

     

       100
       100
       +
           (mkIf (cfg.motd != null) {

     

       101
       101
       +
             environment.etc."solanum/ircd.motd".text = cfg.motd;

     

       102
       102
       +
           })

     

       103
       103
       +
         ]);

     

       104
       104
       +
       }

nixos/tests/all-tests.nix

···

       384
       384
        
         snapcast = handleTest ./snapcast.nix {};

     

       385
       385
        
         snapper = handleTest ./snapper.nix {};

     

       386
       386
        
         sogo = handleTest ./sogo.nix {};

     

       387
       387
       +
         solanum = handleTest ./solanum.nix {};

     

       387
       388
        
         solr = handleTest ./solr.nix {};

     

       388
       389
        
         sonarr = handleTest ./sonarr.nix {};

     

       389
       390
        
         spacecookie = handleTest ./spacecookie.nix {};

+89

nixos/tests/solanum.nix

···

       1
       1
       +
       let

     

       2
       2
       +
         clients = [

     

       3
       3
       +
           "ircclient1"

     

       4
       4
       +
           "ircclient2"

     

       5
       5
       +
         ];

     

       6
       6
       +
         server = "solanum";

     

       7
       7
       +
         ircPort = 6667;

     

       8
       8
       +
         channel = "nixos-cat";

     

       9
       9
       +
         iiDir = "/tmp/irc";

     

       10
       10
       +
       in

     

       11
       11
       +
       

     

       12
       12
       +
       import ./make-test-python.nix ({ pkgs, lib, ... }: {

     

       13
       13
       +
         name = "solanum";

     

       14
       14
       +
         nodes = {

     

       15
       15
       +
           "${server}" = {

     

       16
       16
       +
             networking.firewall.allowedTCPPorts = [ ircPort ];

     

       17
       17
       +
             services.solanum = {

     

       18
       18
       +
               enable = true;

     

       19
       19
       +
             };

     

       20
       20
       +
           };

     

       21
       21
       +
         } // lib.listToAttrs (builtins.map (client: lib.nameValuePair client {

     

       22
       22
       +
           imports = [

     

       23
       23
       +
             ./common/user-account.nix

     

       24
       24
       +
           ];

     

       25
       25
       +
       

     

       26
       26
       +
           systemd.services.ii = {

     

       27
       27
       +
             requires = [ "network.target" ];

     

       28
       28
       +
             wantedBy = [ "default.target" ];

     

       29
       29
       +
       

     

       30
       30
       +
             serviceConfig = {

     

       31
       31
       +
               Type = "simple";

     

       32
       32
       +
               ExecPreStartPre = "mkdir -p ${iiDir}";

     

       33
       33
       +
               ExecStart = ''

     

       34
       34
       +
                 ${lib.getBin pkgs.ii}/bin/ii -n ${client} -s ${server} -i ${iiDir}

     

       35
       35
       +
               '';

     

       36
       36
       +
               User = "alice";

     

       37
       37
       +
             };

     

       38
       38
       +
           };

     

       39
       39
       +
         }) clients);

     

       40
       40
       +
       

     

       41
       41
       +
         testScript =

     

       42
       42
       +
           let

     

       43
       43
       +
             msg = client: "Hello, my name is ${client}";

     

       44
       44
       +
             clientScript = client: [

     

       45
       45
       +
               ''

     

       46
       46
       +
                 ${client}.wait_for_unit("network.target")

     

       47
       47
       +
                 ${client}.systemctl("start ii")

     

       48
       48
       +
                 ${client}.wait_for_unit("ii")

     

       49
       49
       +
                 ${client}.wait_for_file("${iiDir}/${server}/out")

     

       50
       50
       +
               ''

     

       51
       51
       +
               # wait until first PING from server arrives before joining,

     

       52
       52
       +
               # so we don't try it too early

     

       53
       53
       +
               ''

     

       54
       54
       +
                 ${client}.wait_until_succeeds("grep 'PING' ${iiDir}/${server}/out")

     

       55
       55
       +
               ''

     

       56
       56
       +
               # join ${channel}

     

       57
       57
       +
               ''

     

       58
       58
       +
                 ${client}.succeed("echo '/j #${channel}' > ${iiDir}/${server}/in")

     

       59
       59
       +
                 ${client}.wait_for_file("${iiDir}/${server}/#${channel}/in")

     

       60
       60
       +
               ''

     

       61
       61
       +
               # send a greeting

     

       62
       62
       +
               ''

     

       63
       63
       +
                 ${client}.succeed(

     

       64
       64
       +
                     "echo '${msg client}' > ${iiDir}/${server}/#${channel}/in"

     

       65
       65
       +
                 )

     

       66
       66
       +
               ''

     

       67
       67
       +
               # check that all greetings arrived on all clients

     

       68
       68
       +
             ] ++ builtins.map (other: ''

     

       69
       69
       +
               ${client}.succeed(

     

       70
       70
       +
                   "grep '${msg other}$' ${iiDir}/${server}/#${channel}/out"

     

       71
       71
       +
               )

     

       72
       72
       +
             '') clients;

     

       73
       73
       +
       

     

       74
       74
       +
             # foldl', but requires a non-empty list instead of a start value

     

       75
       75
       +
             reduce = f: list:

     

       76
       76
       +
               builtins.foldl' f (builtins.head list) (builtins.tail list);

     

       77
       77
       +
           in ''

     

       78
       78
       +
             start_all()

     

       79
       79
       +
             ${server}.systemctl("status solanum")

     

       80
       80
       +
             ${server}.wait_for_open_port(${toString ircPort})

     

       81
       81
       +
       

     

       82
       82
       +
             # run clientScript for all clients so that every list

     

       83
       83
       +
             # entry is executed by every client before advancing

     

       84
       84
       +
             # to the next one.

     

       85
       85
       +
           '' + lib.concatStrings

     

       86
       86
       +
             (reduce

     

       87
       87
       +
               (lib.zipListsWith (cs: c: cs + c))

     

       88
       88
       +
               (builtins.map clientScript clients));

     

       89
       89
       +
       })