commit 8785ef0a2d4d22af523b0dccabf7a3885f96af4d · pyrox.dev/nixpkgs

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

···

       118
       118
        
         Matter Controller Server exposing websocket connections for use with other services, notably Home Assistant.

     

       119
       119
        
         Available as [services.matter-server](#opt-services.matter-server.enable)

     

       120
       120
        
       

     

       121
       121
       +
       - [db-rest](https://github.com/derhuerst/db-rest), a wrapper around Deutsche Bahn's internal API for public transport data. Available as [services.db-rest](#opt-services.db-rest.enable).

     

       122
       122
       +
       

     

       121
       123
        
       - [Anki Sync Server](https://docs.ankiweb.net/sync-server.html), the official sync server built into recent versions of Anki. Available as [services.anki-sync-server](#opt-services.anki-sync-server.enable).

     

       122
       124
        
       The pre-existing [services.ankisyncd](#opt-services.ankisyncd.enable) has been marked deprecated and will be dropped after 24.05 due to lack of maintenance of the anki-sync-server softwares.

     

       123
       125

nixos/modules/module-list.nix

···

       690
       690
        
         ./services/misc/clipmenu.nix

     

       691
       691
        
         ./services/misc/confd.nix

     

       692
       692
        
         ./services/misc/cpuminer-cryptonight.nix

     

       693
       693
       +
         ./services/misc/db-rest.nix

     

       693
       694
        
         ./services/misc/devmon.nix

     

       694
       695
        
         ./services/misc/dictd.nix

     

       695
       696
        
         ./services/misc/disnix.nix

+182

nixos/modules/services/misc/db-rest.nix

···

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

     

       2
       2
       +
       let

     

       3
       3
       +
         inherit (lib) mkOption types mkIf mkMerge mkDefault mkEnableOption mkPackageOption maintainers;

     

       4
       4
       +
         cfg = config.services.db-rest;

     

       5
       5
       +
       in

     

       6
       6
       +
       {

     

       7
       7
       +
         options = {

     

       8
       8
       +
           services.db-rest = {

     

       9
       9
       +
             enable = mkEnableOption "db-rest service";

     

       10
       10
       +
       

     

       11
       11
       +
             user = mkOption {

     

       12
       12
       +
               type = types.str;

     

       13
       13
       +
               default = "db-rest";

     

       14
       14
       +
               description = "User account under which db-rest runs.";

     

       15
       15
       +
             };

     

       16
       16
       +
       

     

       17
       17
       +
             group = mkOption {

     

       18
       18
       +
               type = types.str;

     

       19
       19
       +
               default = "db-rest";

     

       20
       20
       +
               description = "Group under which db-rest runs.";

     

       21
       21
       +
             };

     

       22
       22
       +
       

     

       23
       23
       +
             host = mkOption {

     

       24
       24
       +
               type = types.str;

     

       25
       25
       +
               default = "127.0.0.1";

     

       26
       26
       +
               description = "The host address the db-rest server should listen on.";

     

       27
       27
       +
             };

     

       28
       28
       +
       

     

       29
       29
       +
             port = mkOption {

     

       30
       30
       +
               type = types.port;

     

       31
       31
       +
               default = 3000;

     

       32
       32
       +
               description = "The port the db-rest server should listen on.";

     

       33
       33
       +
             };

     

       34
       34
       +
       

     

       35
       35
       +
             redis = {

     

       36
       36
       +
               enable = mkOption {

     

       37
       37
       +
                 type = types.bool;

     

       38
       38
       +
                 default = false;

     

       39
       39
       +
                 description = "Enable caching with redis for db-rest.";

     

       40
       40
       +
               };

     

       41
       41
       +
       

     

       42
       42
       +
               createLocally = mkOption {

     

       43
       43
       +
                 type = types.bool;

     

       44
       44
       +
                 default = true;

     

       45
       45
       +
                 description = "Configure a local redis server for db-rest.";

     

       46
       46
       +
               };

     

       47
       47
       +
       

     

       48
       48
       +
               host = mkOption {

     

       49
       49
       +
                 type = with types; nullOr str;

     

       50
       50
       +
                 default = null;

     

       51
       51
       +
                 description = "Redis host.";

     

       52
       52
       +
               };

     

       53
       53
       +
       

     

       54
       54
       +
               port = mkOption {

     

       55
       55
       +
                 type = with types; nullOr port;

     

       56
       56
       +
                 default = null;

     

       57
       57
       +
                 description = "Redis port.";

     

       58
       58
       +
               };

     

       59
       59
       +
       

     

       60
       60
       +
               user = mkOption {

     

       61
       61
       +
                 type = with types; nullOr str;

     

       62
       62
       +
                 default = null;

     

       63
       63
       +
                 description = "Optional username used for authentication with redis.";

     

       64
       64
       +
               };

     

       65
       65
       +
       

     

       66
       66
       +
               passwordFile = mkOption {

     

       67
       67
       +
                 type = with types; nullOr path;

     

       68
       68
       +
                 default = null;

     

       69
       69
       +
                 example = "/run/keys/db-rest/pasword-redis-db";

     

       70
       70
       +
                 description = "Path to a file containing the redis password.";

     

       71
       71
       +
               };

     

       72
       72
       +
       

     

       73
       73
       +
               useSSL = mkOption {

     

       74
       74
       +
                 type = types.bool;

     

       75
       75
       +
                 default = true;

     

       76
       76
       +
                 description = "Use SSL if using a redis network connection.";

     

       77
       77
       +
               };

     

       78
       78
       +
             };

     

       79
       79
       +
       

     

       80
       80
       +
             package = mkPackageOption pkgs "db-rest" { };

     

       81
       81
       +
           };

     

       82
       82
       +
         };

     

       83
       83
       +
       

     

       84
       84
       +
         config = mkIf cfg.enable {

     

       85
       85
       +
           assertions = [

     

       86
       86
       +
             {

     

       87
       87
       +
               assertion = (cfg.redis.enable && !cfg.redis.createLocally) -> (cfg.redis.host != null && cfg.redis.port != null);

     

       88
       88
       +
               message = ''

     

       89
       89
       +
                 {option}`services.db-rest.redis.createLocally` and redis network connection ({option}`services.db-rest.redis.host` or {option}`services.db-rest.redis.port`) enabled. Disable either of them.

     

       90
       90
       +
               '';

     

       91
       91
       +
             }

     

       92
       92
       +
             {

     

       93
       93
       +
               assertion = (cfg.redis.enable && !cfg.redis.createLocally) -> (cfg.redis.passwordFile != null);

     

       94
       94
       +
               message = ''

     

       95
       95
       +
                 {option}`services.db-rest.redis.createLocally` is disabled, but {option}`services.db-rest.redis.passwordFile` is not set.

     

       96
       96
       +
               '';

     

       97
       97
       +
             }

     

       98
       98
       +
           ];

     

       99
       99
       +
       

     

       100
       100
       +
           systemd.services.db-rest = mkMerge [

     

       101
       101
       +
             {

     

       102
       102
       +
               description = "db-rest service";

     

       103
       103
       +
               after = [ "network.target" ]

     

       104
       104
       +
                 ++ lib.optional cfg.redis.createLocally "redis-db-rest.service";

     

       105
       105
       +
               requires = lib.optional cfg.redis.createLocally "redis-db-rest.service";

     

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

     

       107
       107
       +
               serviceConfig = {

     

       108
       108
       +
                 Type = "simple";

     

       109
       109
       +
                 Restart = "always";

     

       110
       110
       +
                 RestartSec = 5;

     

       111
       111
       +
                 WorkingDirectory = cfg.package;

     

       112
       112
       +
                 User = cfg.user;

     

       113
       113
       +
                 Group = cfg.group;

     

       114
       114
       +
                 RestrictAddressFamilies = [ "AF_UNIX" "AF_INET" "AF_INET6" ];

     

       115
       115
       +
                 MemoryDenyWriteExecute = false;

     

       116
       116
       +
                 LoadCredential = lib.optional (cfg.redis.enable && cfg.redis.passwordFile != null) "REDIS_PASSWORD:${cfg.redis.passwordFile}";

     

       117
       117
       +
                 ExecStart = mkDefault "${cfg.package}/bin/db-rest";

     

       118
       118
       +
       

     

       119
       119
       +
                 RemoveIPC = true;

     

       120
       120
       +
                 NoNewPrivileges = true;

     

       121
       121
       +
                 PrivateDevices = true;

     

       122
       122
       +
                 ProtectClock = true;

     

       123
       123
       +
                 ProtectKernelLogs = true;

     

       124
       124
       +
                 ProtectControlGroups = true;

     

       125
       125
       +
                 ProtectKernelModules = true;

     

       126
       126
       +
                 PrivateMounts = true;

     

       127
       127
       +
                 SystemCallArchitectures = "native";

     

       128
       128
       +
                 ProtectHostname = true;

     

       129
       129
       +
                 LockPersonality = true;

     

       130
       130
       +
                 ProtectKernelTunables = true;

     

       131
       131
       +
                 RestrictRealtime = true;

     

       132
       132
       +
                 RestrictSUIDSGID = true;

     

       133
       133
       +
                 RestrictNamespaces = true;

     

       134
       134
       +
                 ProtectSystem = "strict";

     

       135
       135
       +
                 ProtectProc = "invisible";

     

       136
       136
       +
                 ProcSubset = "pid";

     

       137
       137
       +
                 ProtectHome = true;

     

       138
       138
       +
                 PrivateUsers = true;

     

       139
       139
       +
                 PrivateTmp = true;

     

       140
       140
       +
                 CapabilityBoundingSet = "";

     

       141
       141
       +
               };

     

       142
       142
       +
               environment = {

     

       143
       143
       +
                 NODE_ENV = "production";

     

       144
       144
       +
                 NODE_EXTRA_CA_CERTS = "/etc/ssl/certs/ca-certificates.crt";

     

       145
       145
       +
                 HOSTNAME = cfg.host;

     

       146
       146
       +
                 PORT = toString cfg.port;

     

       147
       147
       +
               };

     

       148
       148
       +
             }

     

       149
       149
       +
             (mkIf cfg.redis.enable (if cfg.redis.createLocally then

     

       150
       150
       +
               { environment.REDIS_URL = config.services.redis.servers.db-rest.unixSocket; }

     

       151
       151
       +
             else

     

       152
       152
       +
               {

     

       153
       153
       +
                 script =

     

       154
       154
       +
                   let

     

       155
       155
       +
                     username = lib.optionalString (cfg.redis.user != null) (cfg.redis.user);

     

       156
       156
       +
                     host = cfg.redis.host;

     

       157
       157
       +
                     port = toString cfg.redis.port;

     

       158
       158
       +
                     protocol = if cfg.redis.useSSL then "rediss" else "redis";

     

       159
       159
       +
                   in

     

       160
       160
       +
                   ''

     

       161
       161
       +
                     export REDIS_URL="${protocol}://${username}:$(${config.systemd.package}/bin/systemd-creds cat REDIS_PASSWORD)@${host}:${port}"

     

       162
       162
       +
                     exec ${cfg.package}/bin/db-rest

     

       163
       163
       +
                   '';

     

       164
       164
       +
               }))

     

       165
       165
       +
           ];

     

       166
       166
       +
       

     

       167
       167
       +
           users.users = lib.mkMerge [

     

       168
       168
       +
             (lib.mkIf (cfg.user == "db-rest") {

     

       169
       169
       +
               db-rest = {

     

       170
       170
       +
                 isSystemUser = true;

     

       171
       171
       +
                 group = cfg.group;

     

       172
       172
       +
               };

     

       173
       173
       +
             })

     

       174
       174
       +
             (lib.mkIf cfg.redis.createLocally { ${cfg.user}.extraGroups = [ "redis-db-rest" ]; })

     

       175
       175
       +
           ];

     

       176
       176
       +
       

     

       177
       177
       +
           users.groups = lib.mkIf (cfg.group == "db-rest") { db-rest = { }; };

     

       178
       178
       +
       

     

       179
       179
       +
           services.redis.servers.db-rest.enable = cfg.redis.enable && cfg.redis.createLocally;

     

       180
       180
       +
         };

     

       181
       181
       +
         meta.maintainers = with maintainers; [ marie ];

     

       182
       182
       +
       }

nixos/tests/all-tests.nix

···

       236
       236
        
         darling = handleTest ./darling.nix {};

     

       237
       237
        
         dae = handleTest ./dae.nix {};

     

       238
       238
        
         davis = handleTest ./davis.nix {};

     

       239
       239
       +
         db-rest = handleTest ./db-rest.nix {};

     

       239
       240
        
         dconf = handleTest ./dconf.nix {};

     

       240
       241
        
         deconz = handleTest ./deconz.nix {};

     

       241
       242
        
         deepin = handleTest ./deepin.nix {};

+107

nixos/tests/db-rest.nix

···

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

     

       2
       2
       +
       {

     

       3
       3
       +
         name = "db-rest";

     

       4
       4
       +
         meta.maintainers = with pkgs.lib.maintainers; [ marie ];

     

       5
       5
       +
       

     

       6
       6
       +
         nodes = {

     

       7
       7
       +
           database = {

     

       8
       8
       +
             networking = {

     

       9
       9
       +
               interfaces.eth1 = {

     

       10
       10
       +
                 ipv4.addresses = [

     

       11
       11
       +
                   { address = "192.168.2.10"; prefixLength = 24; }

     

       12
       12
       +
                 ];

     

       13
       13
       +
               };

     

       14
       14
       +
               firewall.allowedTCPPorts = [ 31638 ];

     

       15
       15
       +
             };

     

       16
       16
       +
       

     

       17
       17
       +
             services.redis.servers.db-rest = {

     

       18
       18
       +
               enable = true;

     

       19
       19
       +
               bind = "0.0.0.0";

     

       20
       20
       +
               requirePass = "choochoo";

     

       21
       21
       +
               port = 31638;

     

       22
       22
       +
             };

     

       23
       23
       +
           };

     

       24
       24
       +
       

     

       25
       25
       +
           serverWithTcp = { pkgs, ... }: {

     

       26
       26
       +
             environment = {

     

       27
       27
       +
               etc = {

     

       28
       28
       +
                 "db-rest/password-redis-db".text = ''

     

       29
       29
       +
                   choochoo

     

       30
       30
       +
                 '';

     

       31
       31
       +
               };

     

       32
       32
       +
             };

     

       33
       33
       +
       

     

       34
       34
       +
             networking = {

     

       35
       35
       +
               interfaces.eth1 = {

     

       36
       36
       +
                 ipv4.addresses = [

     

       37
       37
       +
                   { address = "192.168.2.11"; prefixLength = 24; }

     

       38
       38
       +
                 ];

     

       39
       39
       +
               };

     

       40
       40
       +
               firewall.allowedTCPPorts = [ 3000 ];

     

       41
       41
       +
             };

     

       42
       42
       +
       

     

       43
       43
       +
             services.db-rest = {

     

       44
       44
       +
               enable = true;

     

       45
       45
       +
               host = "0.0.0.0";

     

       46
       46
       +
               redis = {

     

       47
       47
       +
                 enable = true;

     

       48
       48
       +
                 createLocally = false;

     

       49
       49
       +
                 host = "192.168.2.10";

     

       50
       50
       +
                 port = 31638;

     

       51
       51
       +
                 passwordFile = "/etc/db-rest/password-redis-db";

     

       52
       52
       +
                 useSSL = false;

     

       53
       53
       +
               };

     

       54
       54
       +
             };

     

       55
       55
       +
           };

     

       56
       56
       +
       

     

       57
       57
       +
           serverWithUnixSocket = { pkgs, ... }: {

     

       58
       58
       +
             networking = {

     

       59
       59
       +
               interfaces.eth1 = {

     

       60
       60
       +
                 ipv4.addresses = [

     

       61
       61
       +
                   { address = "192.168.2.12"; prefixLength = 24; }

     

       62
       62
       +
                 ];

     

       63
       63
       +
               };

     

       64
       64
       +
               firewall.allowedTCPPorts = [ 3000 ];

     

       65
       65
       +
             };

     

       66
       66
       +
       

     

       67
       67
       +
             services.db-rest = {

     

       68
       68
       +
               enable = true;

     

       69
       69
       +
               host = "0.0.0.0";

     

       70
       70
       +
               redis = {

     

       71
       71
       +
                 enable = true;

     

       72
       72
       +
                 createLocally = true;

     

       73
       73
       +
               };

     

       74
       74
       +
             };

     

       75
       75
       +
           };

     

       76
       76
       +
       

     

       77
       77
       +
           client = {

     

       78
       78
       +
             environment.systemPackages = [ pkgs.jq ];

     

       79
       79
       +
             networking = {

     

       80
       80
       +
               interfaces.eth1 = {

     

       81
       81
       +
                 ipv4.addresses = [

     

       82
       82
       +
                   { address = "192.168.2.13"; prefixLength = 24; }

     

       83
       83
       +
                 ];

     

       84
       84
       +
               };

     

       85
       85
       +
             };

     

       86
       86
       +
           };

     

       87
       87
       +
         };

     

       88
       88
       +
       

     

       89
       89
       +
         testScript = ''

     

       90
       90
       +
           start_all()

     

       91
       91
       +
       

     

       92
       92
       +
           with subtest("db-rest redis with TCP socket"):

     

       93
       93
       +
             database.wait_for_unit("redis-db-rest.service")

     

       94
       94
       +
             database.wait_for_open_port(31638)

     

       95
       95
       +
       

     

       96
       96
       +
             serverWithTcp.wait_for_unit("db-rest.service")

     

       97
       97
       +
             serverWithTcp.wait_for_open_port(3000)

     

       98
       98
       +
       

     

       99
       99
       +
             client.succeed("curl --fail --get http://192.168.2.11:3000/stations --data-urlencode 'query=Köln Hbf' | jq -r '.\"8000207\".name' | grep 'Köln Hbf'")

     

       100
       100
       +
       

     

       101
       101
       +
           with subtest("db-rest redis with Unix socket"):

     

       102
       102
       +
             serverWithUnixSocket.wait_for_unit("db-rest.service")

     

       103
       103
       +
             serverWithUnixSocket.wait_for_open_port(3000)

     

       104
       104
       +
       

     

       105
       105
       +
             client.succeed("curl --fail --get http://192.168.2.12:3000/stations --data-urlencode 'query=Köln Hbf' | jq -r '.\"8000207\".name' | grep 'Köln Hbf'")

     

       106
       106
       +
         '';

     

       107
       107
       +
       })

pkgs/servers/db-rest/default.nix

···

       4
       4
        
       , nodejs_18

     

       5
       5
        
       , nix-update-script

     

       6
       6
        
       , fetchpatch

     

       7
       7
       +
       , nixosTests

     

       7
       8
        
       }:

     

       8
       9
        
       buildNpmPackage rec {

     

       9
       10
        
         pname = "db-rest";

     
···

       25
       26
        
         '';

     

       26
       27
        
       

     

       27
       28
        
         passthru.updateScript = nix-update-script { };

     

       29
       29
       +
         passthru.tests = {

     

       30
       30
       +
           inherit (nixosTests) db-rest;

     

       31
       31
       +
         };

     

       28
       32
        
       

     

       29
       33
        
         meta = {

     

       30
       34
        
           description = "A clean REST API wrapping around the Deutsche Bahn API";