commit f3b9f4789177572842e51aea79cac0d43a76138f · pyrox.dev/nixpkgs

nixos/doc/manual/redirects.json

···

       1289
       1289
        
         "module-services-foundationdb-full-docs": [

     

       1290
       1290
        
           "index.html#module-services-foundationdb-full-docs"

     

       1291
       1291
        
         ],

     

       1292
       1292
       +
         "module-service-umurmur": [

     

       1293
       1293
       +
           "index.html#module-service-umurmur"

     

       1294
       1294
       +
         ],

     

       1295
       1295
       +
         "module-service-umurmur-quick-start": [

     

       1296
       1296
       +
           "index.html#module-service-umurmur-quick-start"

     

       1297
       1297
       +
         ],

     

       1292
       1298
        
         "module-borgbase": [

     

       1293
       1299
        
           "index.html#module-borgbase"

     

       1294
       1300
        
         ],

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

···

       77
       77
        
       

     

       78
       78
        
       - [Yggdrasil-Jumper](https://github.com/one-d-wide/yggdrasil-jumper) is an independent project that aims to transparently reduce latency of a connection over Yggdrasil network, utilizing NAT traversal to automatically bypass intermediary nodes.

     

       79
       79
        
       

     

       80
       80
       +
       - [uMurmur](https://umurmur.net), minimalistic Mumble server primarily targeted to run on embedded computers. Available as [services.umurmur](options.html#opt-services.umurmur).

     

       81
       81
       +
       

     

       80
       82
        
       - [Zenoh](https://zenoh.io/), a pub/sub/query protocol with low overhead. The Zenoh router daemon is available as [services.zenohd](options.html#opt-services.zenohd.enable)

     

       81
       83
        
       

     

       82
       84
        
       - [ytdl-sub](https://github.com/jmbannon/ytdl-sub), a tool that downloads media via yt-dlp and prepares it for your favorite media player, including Kodi, Jellyfin, Plex, Emby, and modern music players. Available as [services.ytdl-sub](options.html#opt-services.ytdl-sub.instances).

nixos/modules/module-list.nix

···

       1315
       1315
        
         ./services/networking/trickster.nix

     

       1316
       1316
        
         ./services/networking/twingate.nix

     

       1317
       1317
        
         ./services/networking/ucarp.nix

     

       1318
       1318
       +
         ./services/networking/umurmur.nix

     

       1318
       1319
        
         ./services/networking/unbound.nix

     

       1319
       1320
        
         ./services/networking/unifi.nix

     

       1320
       1321
        
         ./services/networking/uptermd.nix

+33

nixos/modules/services/networking/umurmur.md

···

       1
       1
       +
       # uMurmur {#module-service-umurmur}

     

       2
       2
       +
       

     

       3
       3
       +
       [uMurmur](http://umurmur.net/) is a minimalistic Mumble server primarily targeted to run on embedded computers. This module enables it (`umurmurd`).

     

       4
       4
       +
       

     

       5
       5
       +
       ## Quick Start {#module-service-umurmur-quick-start}

     

       6
       6
       +
       

     

       7
       7
       +
       ```nix

     

       8
       8
       +
       {

     

       9
       9
       +
         services.umurmur = {

     

       10
       10
       +
           enable = true;

     

       11
       11
       +
           openFirewall = true;

     

       12
       12
       +
           settings = {

     

       13
       13
       +
             port = 7365;

     

       14
       14
       +
             channels = [

     

       15
       15
       +
               {

     

       16
       16
       +
                 name = "root";

     

       17
       17
       +
                 parent = "";

     

       18
       18
       +
                 description = "Root channel. No entry.";

     

       19
       19
       +
                 noenter = true;

     

       20
       20
       +
               }

     

       21
       21
       +
               {

     

       22
       22
       +
                 name = "lobby";

     

       23
       23
       +
                 parent = "root";

     

       24
       24
       +
                 description = "Lobby channel";

     

       25
       25
       +
               }

     

       26
       26
       +
             ];

     

       27
       27
       +
             default_channel = "lobby";

     

       28
       28
       +
           };

     

       29
       29
       +
         };

     

       30
       30
       +
       }

     

       31
       31
       +
       ```

     

       32
       32
       +
       

     

       33
       33
       +
       See a full configuration in [umurmur.conf.example](https://github.com/umurmur/umurmur/blob/master/umurmur.conf.example)

+244

nixos/modules/services/networking/umurmur.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         cfg = config.services.umurmur;

     

       10
       10
       +
         dumpAttrset =

     

       11
       11
       +
           x: top_level:

     

       12
       12
       +
           (lib.optionalString (!top_level) "{")

     

       13
       13
       +
           + (lib.concatLines (lib.mapAttrsToList (name: value: "${name} = ${toConfigValue value false};") x))

     

       14
       14
       +
           + (lib.optionalString (!top_level) "}");

     

       15
       15
       +
         dumpList = x: top_level: "(${lib.concatStringsSep ",\n" (map (y: "${toConfigValue y false}") x)})";

     

       16
       16
       +
       

     

       17
       17
       +
         toConfigValue =

     

       18
       18
       +
           x: top_level:

     

       19
       19
       +
           if builtins.isList x then

     

       20
       20
       +
             dumpList x top_level

     

       21
       21
       +
           else if builtins.isAttrs x then

     

       22
       22
       +
             dumpAttrset x top_level

     

       23
       23
       +
           else

     

       24
       24
       +
             builtins.toJSON x;

     

       25
       25
       +
         dumpCfg = x: toConfigValue x true;

     

       26
       26
       +
         configAttrs = lib.filterAttrsRecursive (name: value: value != null) cfg.settings;

     

       27
       27
       +
         configFile = pkgs.writeTextFile {

     

       28
       28
       +
           name = "umurmur.conf";

     

       29
       29
       +
           checkPhase = ''

     

       30
       30
       +
             ${lib.getExe cfg.package} -t -c "$target"

     

       31
       31
       +
           '';

     

       32
       32
       +
           text = "\n" + (dumpCfg configAttrs) + "\n";

     

       33
       33
       +
         };

     

       34
       34
       +
       in

     

       35
       35
       +
       {

     

       36
       36
       +
         options = {

     

       37
       37
       +
           services.umurmur = {

     

       38
       38
       +
             enable = lib.mkEnableOption "uMurmur Mumble server";

     

       39
       39
       +
       

     

       40
       40
       +
             package = lib.mkPackageOption pkgs "umurmur" { };

     

       41
       41
       +
       

     

       42
       42
       +
             openFirewall = lib.mkOption {

     

       43
       43
       +
               type = lib.types.bool;

     

       44
       44
       +
               default = false;

     

       45
       45
       +
               description = ''

     

       46
       46
       +
                 Open ports in the firewall for the uMurmur Mumble server.

     

       47
       47
       +
               '';

     

       48
       48
       +
             };

     

       49
       49
       +
       

     

       50
       50
       +
             settings = lib.mkOption {

     

       51
       51
       +
               type = lib.types.submodule {

     

       52
       52
       +
                 freeformType =

     

       53
       53
       +
                   let

     

       54
       54
       +
                     valueType =

     

       55
       55
       +
                       with lib.types;

     

       56
       56
       +
                       oneOf [

     

       57
       57
       +
                         bool

     

       58
       58
       +
                         int

     

       59
       59
       +
                         float

     

       60
       60
       +
                         str

     

       61
       61
       +
                         path

     

       62
       62
       +
                         (listOf (attrsOf valueType))

     

       63
       63
       +
                       ]

     

       64
       64
       +
                       // {

     

       65
       65
       +
                         description = "uMurmur config value";

     

       66
       66
       +
                       };

     

       67
       67
       +
                   in

     

       68
       68
       +
                   valueType;

     

       69
       69
       +
                 options = {

     

       70
       70
       +
                   welcometext = lib.mkOption {

     

       71
       71
       +
                     type = lib.types.nullOr lib.types.str;

     

       72
       72
       +
                     default = "Welcome to uMurmur!";

     

       73
       73
       +
                     description = "Welcome message for connected clients.";

     

       74
       74
       +
                   };

     

       75
       75
       +
       

     

       76
       76
       +
                   bindaddr = lib.mkOption {

     

       77
       77
       +
                     type = lib.types.str;

     

       78
       78
       +
                     default = "0.0.0.0";

     

       79
       79
       +
                     description = "IPv4 address to bind to. Defaults binding on all addresses.";

     

       80
       80
       +
                   };

     

       81
       81
       +
       

     

       82
       82
       +
                   bindaddr6 = lib.mkOption {

     

       83
       83
       +
                     type = lib.types.str;

     

       84
       84
       +
                     default = "::";

     

       85
       85
       +
                     description = "IPv6 address to bind to. Defaults binding on all addresses.";

     

       86
       86
       +
                   };

     

       87
       87
       +
       

     

       88
       88
       +
                   bindport = lib.mkOption {

     

       89
       89
       +
                     type = lib.types.port;

     

       90
       90
       +
                     default = 64739;

     

       91
       91
       +
                     description = "Port to bind to (UDP and TCP).";

     

       92
       92
       +
                   };

     

       93
       93
       +
       

     

       94
       94
       +
                   password = lib.mkOption {

     

       95
       95
       +
                     type = lib.types.nullOr lib.types.str;

     

       96
       96
       +
                     default = null;

     

       97
       97
       +
                     description = "Required password to join server, if specified.";

     

       98
       98
       +
                   };

     

       99
       99
       +
       

     

       100
       100
       +
                   max_bandwidth = lib.mkOption {

     

       101
       101
       +
                     type = lib.types.int;

     

       102
       102
       +
                     default = 48000;

     

       103
       103
       +
                     description = ''

     

       104
       104
       +
                       Maximum bandwidth (in bits per second) that clients may send

     

       105
       105
       +
                       speech at.

     

       106
       106
       +
                     '';

     

       107
       107
       +
                   };

     

       108
       108
       +
       

     

       109
       109
       +
                   max_users = lib.mkOption {

     

       110
       110
       +
                     type = lib.types.int;

     

       111
       111
       +
                     default = 10;

     

       112
       112
       +
                     description = "Maximum number of concurrent clients allowed.";

     

       113
       113
       +
                   };

     

       114
       114
       +
       

     

       115
       115
       +
                   certificate = lib.mkOption {

     

       116
       116
       +
                     type = lib.types.str;

     

       117
       117
       +
                     default = "/var/lib/private/umurmur/cert.crt";

     

       118
       118
       +
                     description = "Path to your SSL certificate. Generates self-signed automatically if not exists.";

     

       119
       119
       +
                   };

     

       120
       120
       +
       

     

       121
       121
       +
                   private_key = lib.mkOption {

     

       122
       122
       +
                     type = lib.types.str;

     

       123
       123
       +
                     default = "/var/lib/private/umurmur/key.key";

     

       124
       124
       +
                     description = "Path to your SSL key. Generates self-signed automatically if not exists.";

     

       125
       125
       +
                   };

     

       126
       126
       +
       

     

       127
       127
       +
                   ca_path = lib.mkOption {

     

       128
       128
       +
                     type = lib.types.nullOr lib.types.str;

     

       129
       129
       +
                     default = null;

     

       130
       130
       +
                     description = "Path to your SSL CA certificate.";

     

       131
       131
       +
                   };

     

       132
       132
       +
       

     

       133
       133
       +
                   channels = lib.mkOption {

     

       134
       134
       +
                     type = lib.types.listOf lib.types.attrs;

     

       135
       135
       +
                     default = [

     

       136
       136
       +
                       {

     

       137
       137
       +
                         name = "root";

     

       138
       138
       +
                         parent = "";

     

       139
       139
       +
                         description = "Root channel.";

     

       140
       140
       +
                         noenter = false;

     

       141
       141
       +
                       }

     

       142
       142
       +
                     ];

     

       143
       143
       +
                     description = "Channel tree definitions.";

     

       144
       144
       +
                   };

     

       145
       145
       +
       

     

       146
       146
       +
                   channel_links = lib.mkOption {

     

       147
       147
       +
                     type = lib.types.listOf lib.types.attrs;

     

       148
       148
       +
                     default = [ ];

     

       149
       149
       +
                     example = [

     

       150
       150
       +
                       {

     

       151
       151
       +
                         source = "Lobby";

     

       152
       152
       +
                         destination = "Red team";

     

       153
       153
       +
                       }

     

       154
       154
       +
                     ];

     

       155
       155
       +
                     description = "Channel tree definitions.";

     

       156
       156
       +
                   };

     

       157
       157
       +
       

     

       158
       158
       +
                   default_channel = lib.mkOption {

     

       159
       159
       +
                     type = lib.types.str;

     

       160
       160
       +
                     default = "root";

     

       161
       161
       +
                     description = "The channel in which users will appear in when connecting.";

     

       162
       162
       +
                   };

     

       163
       163
       +
       

     

       164
       164
       +
                 };

     

       165
       165
       +
               };

     

       166
       166
       +
               default = { };

     

       167
       167
       +
               description = "Settings of uMurmur. For reference see https://github.com/umurmur/umurmur/blob/master/umurmur.conf.example";

     

       168
       168
       +
             };

     

       169
       169
       +
       

     

       170
       170
       +
             configFile = lib.mkOption rec {

     

       171
       171
       +
               type = lib.types.path;

     

       172
       172
       +
               default = configFile;

     

       173
       173
       +
               description = "Configuration file, default is generated from config.service.umurmur.settings";

     

       174
       174
       +
               defaultText = description;

     

       175
       175
       +
             };

     

       176
       176
       +
           };

     

       177
       177
       +
         };

     

       178
       178
       +
       

     

       179
       179
       +
         config = lib.mkIf cfg.enable {

     

       180
       180
       +
           networking.firewall = lib.mkIf cfg.openFirewall {

     

       181
       181
       +
             allowedTCPPorts = [ cfg.settings.bindport ];

     

       182
       182
       +
             allowedUDPPorts = [ cfg.settings.bindport ];

     

       183
       183
       +
           };

     

       184
       184
       +
       

     

       185
       185
       +
           systemd.services.umurmur = {

     

       186
       186
       +
             description = "uMurmur Mumble Server";

     

       187
       187
       +
             wants = [ "network.target" ];

     

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

     

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

     

       190
       190
       +
             serviceConfig = {

     

       191
       191
       +
               Type = "exec";

     

       192
       192
       +
               ExecStart = "${lib.getExe cfg.package} -d -c ${cfg.configFile}";

     

       193
       193
       +
               Restart = "on-failure";

     

       194
       194
       +
               DynamicUser = true;

     

       195
       195
       +
               StateDirectory = "umurmur";

     

       196
       196
       +
               ReadWritePaths = "/dev/shm";

     

       197
       197
       +
       

     

       198
       198
       +
               # hardening

     

       199
       199
       +
               UMask = 27;

     

       200
       200
       +
               MemoryDenyWriteExecute = true;

     

       201
       201
       +
               AmbientCapabilities = [ "" ];

     

       202
       202
       +
               CapabilityBoundingSet = [ "" ];

     

       203
       203
       +
               DevicePolicy = "closed";

     

       204
       204
       +
               LockPersonality = true;

     

       205
       205
       +
               NoNewPrivileges = true;

     

       206
       206
       +
               PrivateDevices = true;

     

       207
       207
       +
               PrivateTmp = true;

     

       208
       208
       +
               PrivateUsers = true;

     

       209
       209
       +
               ProtectSystem = "full";

     

       210
       210
       +
               ProtectClock = true;

     

       211
       211
       +
               ProtectControlGroups = true;

     

       212
       212
       +
               ProtectHome = true;

     

       213
       213
       +
               ProtectHostname = true;

     

       214
       214
       +
               ProtectKernelLogs = true;

     

       215
       215
       +
               ProtectKernelModules = true;

     

       216
       216
       +
               ProtectKernelTunables = true;

     

       217
       217
       +
               ProcSubset = "pid";

     

       218
       218
       +
               ProtectProc = "invisible";

     

       219
       219
       +
               RemoveIPC = true;

     

       220
       220
       +
               RestrictAddressFamilies = [

     

       221
       221
       +
                 "AF_UNIX"

     

       222
       222
       +
                 "AF_INET"

     

       223
       223
       +
                 "AF_INET6"

     

       224
       224
       +
               ];

     

       225
       225
       +
               RestrictNamespaces = true;

     

       226
       226
       +
               RestrictRealtime = true;

     

       227
       227
       +
               RestrictSUIDSGID = true;

     

       228
       228
       +
               SystemCallArchitectures = "native";

     

       229
       229
       +
               SystemCallFilter = [

     

       230
       230
       +
                 "@system-service"

     

       231
       231
       +
                 "~@cpu-emulation"

     

       232
       232
       +
                 "~@debug"

     

       233
       233
       +
                 "~@mount"

     

       234
       234
       +
                 "~@obsolete"

     

       235
       235
       +
                 "~@privileged"

     

       236
       236
       +
                 "~@resources"

     

       237
       237
       +
               ];

     

       238
       238
       +
             };

     

       239
       239
       +
           };

     

       240
       240
       +
         };

     

       241
       241
       +
       

     

       242
       242
       +
         meta.maintainers = with lib.maintainers; [ _3JlOy-PYCCKUi ];

     

       243
       243
       +
         meta.doc = ./umurmur.md;

     

       244
       244
       +
       }

nixos/tests/all-tests.nix

···

       1186
       1186
        
         ucarp = handleTest ./ucarp.nix {};

     

       1187
       1187
        
         udisks2 = handleTest ./udisks2.nix {};

     

       1188
       1188
        
         ulogd = handleTest ./ulogd/ulogd.nix {};

     

       1189
       1189
       +
         umurmur = handleTest ./umurmur.nix {};

     

       1189
       1190
        
         unbound = handleTest ./unbound.nix {};

     

       1190
       1191
        
         unifi = handleTest ./unifi.nix {};

     

       1191
       1192
        
         unit-php = handleTest ./web-servers/unit-php.nix {};

+99

nixos/tests/umurmur.nix

···

       1
       1
       +
       import ./make-test-python.nix (

     

       2
       2
       +
         { pkgs, ... }:

     

       3
       3
       +
       

     

       4
       4
       +
         let

     

       5
       5
       +
           client =

     

       6
       6
       +
             { pkgs, ... }:

     

       7
       7
       +
             {

     

       8
       8
       +
               imports = [ ./common/x11.nix ];

     

       9
       9
       +
               environment.systemPackages = [ pkgs.mumble ];

     

       10
       10
       +
             };

     

       11
       11
       +
           port = 56457;

     

       12
       12
       +
         in

     

       13
       13
       +
         {

     

       14
       14
       +
           name = "mumble";

     

       15
       15
       +
           meta = with pkgs.lib.maintainers; {

     

       16
       16
       +
             maintainers = [ _3JlOy-PYCCKUi ];

     

       17
       17
       +
           };

     

       18
       18
       +
       

     

       19
       19
       +
           nodes = {

     

       20
       20
       +
             server =

     

       21
       21
       +
               { ... }:

     

       22
       22
       +
               {

     

       23
       23
       +
                 services.umurmur = {

     

       24
       24
       +
                   enable = true;

     

       25
       25
       +
                   openFirewall = true;

     

       26
       26
       +
                   settings = {

     

       27
       27
       +
                     password = "testpassword";

     

       28
       28
       +
                     channels = [

     

       29
       29
       +
                       {

     

       30
       30
       +
                         name = "root";

     

       31
       31
       +
                         parent = "";

     

       32
       32
       +
                         description = "Root channel. No entry.";

     

       33
       33
       +
                         noenter = true;

     

       34
       34
       +
                       }

     

       35
       35
       +
                       {

     

       36
       36
       +
                         name = "lobby";

     

       37
       37
       +
                         parent = "root";

     

       38
       38
       +
                         description = "Lobby channel";

     

       39
       39
       +
                       }

     

       40
       40
       +
                     ];

     

       41
       41
       +
                     default_channel = "lobby";

     

       42
       42
       +
                     bindport = port;

     

       43
       43
       +
                   };

     

       44
       44
       +
                 };

     

       45
       45
       +
               };

     

       46
       46
       +
       

     

       47
       47
       +
             client1 = client;

     

       48
       48
       +
             client2 = client;

     

       49
       49
       +
           };

     

       50
       50
       +
       

     

       51
       51
       +
           testScript = ''

     

       52
       52
       +
             start_all()

     

       53
       53
       +
       

     

       54
       54
       +
             server.wait_for_unit("umurmur.service")

     

       55
       55
       +
             client1.wait_for_x()

     

       56
       56
       +
             client2.wait_for_x()

     

       57
       57
       +
       

     

       58
       58
       +
             client1.execute("mumble mumble://client1:testpassword\@server:${toString port}/lobby >&2 &")

     

       59
       59
       +
             client2.execute("mumble mumble://client2:testpassword\@server:${toString port}/lobby >&2 &")

     

       60
       60
       +
       

     

       61
       61
       +
             # cancel client audio configuration

     

       62
       62
       +
             client1.wait_for_window(r"Audio Tuning Wizard")

     

       63
       63
       +
             client2.wait_for_window(r"Audio Tuning Wizard")

     

       64
       64
       +
             server.sleep(5)  # wait because mumble is slow to register event handlers

     

       65
       65
       +
             client1.send_key("esc")

     

       66
       66
       +
             client2.send_key("esc")

     

       67
       67
       +
       

     

       68
       68
       +
             # cancel client cert configuration

     

       69
       69
       +
             client1.wait_for_window(r"Certificate Management")

     

       70
       70
       +
             client2.wait_for_window(r"Certificate Management")

     

       71
       71
       +
             server.sleep(5)  # wait because mumble is slow to register event handlers

     

       72
       72
       +
             client1.send_key("esc")

     

       73
       73
       +
             client2.send_key("esc")

     

       74
       74
       +
       

     

       75
       75
       +
             # accept server certificate

     

       76
       76
       +
             client1.wait_for_window(r"^Mumble$")

     

       77
       77
       +
             client2.wait_for_window(r"^Mumble$")

     

       78
       78
       +
             server.sleep(5)  # wait because mumble is slow to register event handlers

     

       79
       79
       +
             client1.send_chars("y")

     

       80
       80
       +
             client2.send_chars("y")

     

       81
       81
       +
             server.sleep(5)  # wait because mumble is slow to register event handlers

     

       82
       82
       +
       

     

       83
       83
       +
             # sometimes the wrong of the 2 windows is focused, we switch focus and try pressing "y" again

     

       84
       84
       +
             client1.send_key("alt-tab")

     

       85
       85
       +
             client2.send_key("alt-tab")

     

       86
       86
       +
             server.sleep(5)  # wait because mumble is slow to register event handlers

     

       87
       87
       +
             client1.send_chars("y")

     

       88
       88
       +
             client2.send_chars("y")

     

       89
       89
       +
       

     

       90
       90
       +
             # Find clients in logs

     

       91
       91
       +
             server.wait_until_succeeds(

     

       92
       92
       +
                 "journalctl -eu umurmur -o cat | grep -q 'User client1 authenticated'"

     

       93
       93
       +
             )

     

       94
       94
       +
             server.wait_until_succeeds(

     

       95
       95
       +
                 "journalctl -eu umurmur -o cat | grep -q 'User client2 authenticated'"

     

       96
       96
       +
             )

     

       97
       97
       +
           '';

     

       98
       98
       +
         }

     

       99
       99
       +
       )

pkgs/by-name/um/umurmur/package.nix

···

       7
       7
        
         openssl,

     

       8
       8
        
         protobufc,

     

       9
       9
        
         libconfig,

     

       10
       10
       +
         nixosTests,

     

       10
       11
        
       }:

     

       11
       12
        
       

     

       12
       13
        
       stdenv.mkDerivation rec {

     
···

       39
       40
        
           "--with-ssl=openssl"

     

       40
       41
        
           "--enable-shmapi"

     

       41
       42
        
         ];

     

       43
       43
       +
       

     

       44
       44
       +
         passthru = {

     

       45
       45
       +
           tests = {

     

       46
       46
       +
             inherit (nixosTests) umurmur;

     

       47
       47
       +
           };

     

       48
       48
       +
         };

     

       42
       49
        
       

     

       43
       50
        
         meta = with lib; {

     

       44
       51
        
           description = "Minimalistic Murmur (Mumble server)";