commit 3a4e234b072bd69e8901b8ed465be7bb659d1a93 · pyrox.dev/nixpkgs

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

···

       78
       78
        
       

     

       79
       79
        
       - `services.prometheus.exporters` has a new exporter to monitor electrical power consumption based on PowercapRAPL sensor called [Scaphandre](https://github.com/hubblo-org/scaphandre), see [#239803](https://github.com/NixOS/nixpkgs/pull/239803) for more details.

     

       80
       80
        
       

     

       81
       81
       +
       - The module `services.calibre-server` has new options to configure the `host`, `port`, `auth.enable`, `auth.mode` and `auth.userDb` path, see [#216497](https://github.com/NixOS/nixpkgs/pull/216497/) for more details.

     

       82
       82
       +
       

     

       81
       83
        
       ## Nixpkgs internals {#sec-release-23.11-nixpkgs-internals}

     

       82
       84
        
       

     

       83
       85
        
       - The `qemu-vm.nix` module by default now identifies block devices via

+77 -17

nixos/modules/services/misc/calibre-server.nix

···

       6
       6
        
       

     

       7
       7
        
         cfg = config.services.calibre-server;

     

       8
       8
        
       

     

       9
       9
       +
         documentationLink = "https://manual.calibre-ebook.com";

     

       10
       10
       +
         generatedDocumentationLink = documentationLink + "/generated/en/calibre-server.html";

     

       11
       11
       +
       

     

       12
       12
       +
         execFlags = (concatStringsSep " "

     

       13
       13
       +
           (mapAttrsToList (k: v: "${k} ${toString v}") (filterAttrs (name: value: value != null) {

     

       14
       14
       +
             "--listen-on" = cfg.host;

     

       15
       15
       +
             "--port" = cfg.port;

     

       16
       16
       +
             "--auth-mode" = cfg.auth.mode;

     

       17
       17
       +
             "--userdb" = cfg.auth.userDb;

     

       18
       18
       +
           }) ++ [(optionalString (cfg.auth.enable == true) "--enable-auth")])

     

       19
       19
       +
         );

     

       9
       20
        
       in

     

       10
       21
        
       

     

       11
       22
        
       {

     
···

       18
       29
        
           )

     

       19
       30
        
         ];

     

       20
       31
        
       

     

       21
       21
       -
         ###### interface

     

       22
       22
       -
       

     

       23
       32
        
         options = {

     

       24
       33
        
           services.calibre-server = {

     

       25
       34
        
       

     

       26
       35
        
             enable = mkEnableOption (lib.mdDoc "calibre-server");

     

       36
       36
       +
             package = lib.mkPackageOptionMD pkgs "calibre" { };

     

       27
       37
        
       

     

       28
       38
        
             libraries = mkOption {

     

       39
       39
       +
               type = types.listOf types.path;

     

       40
       40
       +
               default = [ "/var/lib/calibre-server" ];

     

       29
       41
        
               description = lib.mdDoc ''

     

       42
       42
       +
                 Make sure each library path is initialized before service startup.

     

       30
       43
        
                 The directories of the libraries to serve. They must be readable for the user under which the server runs.

     

       44
       44
       +
                 See the [calibredb documentation](${documentationLink}/generated/en/calibredb.html#add) for details.

     

       31
       45
        
               '';

     

       32
       32
       -
               type = types.listOf types.path;

     

       33
       46
        
             };

     

       34
       47
        
       

     

       35
       48
        
             user = mkOption {

     

       36
       36
       -
               description = lib.mdDoc "The user under which calibre-server runs.";

     

       37
       49
        
               type = types.str;

     

       38
       50
        
               default = "calibre-server";

     

       51
       51
       +
               description = lib.mdDoc "The user under which calibre-server runs.";

     

       39
       52
        
             };

     

       40
       53
        
       

     

       41
       54
        
             group = mkOption {

     

       42
       42
       -
               description = lib.mdDoc "The group under which calibre-server runs.";

     

       43
       55
        
               type = types.str;

     

       44
       56
        
               default = "calibre-server";

     

       57
       57
       +
               description = lib.mdDoc "The group under which calibre-server runs.";

     

       45
       58
        
             };

     

       46
       59
        
       

     

       47
       47
       -
           };

     

       48
       48
       -
         };

     

       60
       60
       +
             host = mkOption {

     

       61
       61
       +
               type = types.str;

     

       62
       62
       +
               default = "0.0.0.0";

     

       63
       63
       +
               example = "::1";

     

       64
       64
       +
               description = lib.mdDoc ''

     

       65
       65
       +
                 The interface on which to listen for connections.

     

       66
       66
       +
                 See the [calibre-server documentation](${generatedDocumentationLink}#cmdoption-calibre-server-listen-on) for details.

     

       67
       67
       +
               '';

     

       68
       68
       +
             };

     

       49
       69
        
       

     

       70
       70
       +
             port = mkOption {

     

       71
       71
       +
               default = 8080;

     

       72
       72
       +
               type = types.port;

     

       73
       73
       +
               description = lib.mdDoc ''

     

       74
       74
       +
                 The port on which to listen for connections.

     

       75
       75
       +
                 See the [calibre-server documentation](${generatedDocumentationLink}#cmdoption-calibre-server-port) for details.

     

       76
       76
       +
               '';

     

       77
       77
       +
             };

     

       50
       78
        
       

     

       51
       51
       -
         ###### implementation

     

       79
       79
       +
             auth = {

     

       80
       80
       +
               enable = mkOption {

     

       81
       81
       +
                 type = types.bool;

     

       82
       82
       +
                 default = false;

     

       83
       83
       +
                 description = lib.mdDoc ''

     

       84
       84
       +
                   Password based authentication to access the server.

     

       85
       85
       +
                   See the [calibre-server documentation](${generatedDocumentationLink}#cmdoption-calibre-server-enable-auth) for details.

     

       86
       86
       +
                 '';

     

       87
       87
       +
               };

     

       88
       88
       +
       

     

       89
       89
       +
               mode = mkOption {

     

       90
       90
       +
                 type = types.enum [ "auto" "basic" "digest" ];

     

       91
       91
       +
                 default = "auto";

     

       92
       92
       +
                 description = lib.mdDoc ''

     

       93
       93
       +
                   Choose the type of authentication used.

     

       94
       94
       +
                   Set the HTTP authentication mode used by the server.

     

       95
       95
       +
                   See the [calibre-server documentation](${generatedDocumentationLink}#cmdoption-calibre-server-auth-mode) for details.

     

       96
       96
       +
                 '';

     

       97
       97
       +
               };

     

       98
       98
       +
       

     

       99
       99
       +
               userDb = mkOption {

     

       100
       100
       +
                 default = null;

     

       101
       101
       +
                 type = types.nullOr types.path;

     

       102
       102
       +
                 description = lib.mdDoc ''

     

       103
       103
       +
                   Choose users database file to use for authentication.

     

       104
       104
       +
                   Make sure users database file is initialized before service startup.

     

       105
       105
       +
                   See the [calibre-server documentation](${documentationLink}/server.html#managing-user-accounts-from-the-command-line-only) for details.

     

       106
       106
       +
                 '';

     

       107
       107
       +
               };

     

       108
       108
       +
             };

     

       109
       109
       +
           };

     

       110
       110
       +
         };

     

       52
       111
        
       

     

       53
       112
        
         config = mkIf cfg.enable {

     

       54
       113
        
       

     

       55
       114
        
           systemd.services.calibre-server = {

     

       56
       56
       -
               description = "Calibre Server";

     

       57
       57
       -
               after = [ "network.target" ];

     

       58
       58
       -
               wantedBy = [ "multi-user.target" ];

     

       59
       59
       -
               serviceConfig = {

     

       60
       60
       -
                 User = cfg.user;

     

       61
       61
       -
                 Restart = "always";

     

       62
       62
       -
                 ExecStart = "${pkgs.calibre}/bin/calibre-server ${lib.concatStringsSep " " cfg.libraries}";

     

       63
       63
       -
               };

     

       115
       115
       +
             description = "Calibre Server";

     

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

     

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

     

       118
       118
       +
             serviceConfig = {

     

       119
       119
       +
               User = cfg.user;

     

       120
       120
       +
               Restart = "always";

     

       121
       121
       +
               ExecStart = "${cfg.package}/bin/calibre-server ${lib.concatStringsSep " " cfg.libraries} ${execFlags}";

     

       122
       122
       +
             };

     

       64
       123
        
       

     

       65
       65
       -
             };

     

       124
       124
       +
           };

     

       66
       125
        
       

     

       67
       126
        
           environment.systemPackages = [ pkgs.calibre ];

     

       68
       127
        
       

     
···

       83
       142
        
       

     

       84
       143
        
         };

     

       85
       144
        
       

     

       145
       145
       +
         meta.maintainers = with lib.maintainers; [ gaelreyrol ];

     

       86
       146
        
       }

nixos/tests/all-tests.nix

···

       151
       151
        
         cage = handleTest ./cage.nix {};

     

       152
       152
        
         cagebreak = handleTest ./cagebreak.nix {};

     

       153
       153
        
         calibre-web = handleTest ./calibre-web.nix {};

     

       154
       154
       +
         calibre-server = handleTest ./calibre-server.nix {};

     

       154
       155
        
         cassandra_3_0 = handleTest ./cassandra.nix { testPackage = pkgs.cassandra_3_0; };

     

       155
       156
        
         cassandra_3_11 = handleTest ./cassandra.nix { testPackage = pkgs.cassandra_3_11; };

     

       156
       157
        
         cassandra_4 = handleTest ./cassandra.nix { testPackage = pkgs.cassandra_4; };

+104

nixos/tests/calibre-server.nix

···

       1
       1
       +
       { system ? builtins.currentSystem

     

       2
       2
       +
       , config ? { }

     

       3
       3
       +
       , pkgs ? import ../.. { inherit system config; }

     

       4
       4
       +
       }:

     

       5
       5
       +
       

     

       6
       6
       +
       let

     

       7
       7
       +
         inherit (import ../lib/testing-python.nix { inherit system pkgs; }) makeTest;

     

       8
       8
       +
         inherit (pkgs.lib) concatStringsSep maintainers mapAttrs mkMerge

     

       9
       9
       +
           removeSuffix splitString;

     

       10
       10
       +
       

     

       11
       11
       +
         tests = {

     

       12
       12
       +
           default = {

     

       13
       13
       +
             calibreConfig = {};

     

       14
       14
       +
             calibreScript = ''

     

       15
       15
       +
               wait_for_unit("calibre-server.service")

     

       16
       16
       +
             '';

     

       17
       17
       +
           };

     

       18
       18
       +
           customLibrary = {

     

       19
       19
       +
             calibreConfig = {

     

       20
       20
       +
               libraries = [ "/var/lib/calibre-data" ];

     

       21
       21
       +
             };

     

       22
       22
       +
             calibreScript = ''

     

       23
       23
       +
               succeed("ls -la /var/lib/calibre-data")

     

       24
       24
       +
               wait_for_unit("calibre-server.service")

     

       25
       25
       +
             '';

     

       26
       26
       +
           };

     

       27
       27
       +
           multipleLibraries = {

     

       28
       28
       +
             calibreConfig = {

     

       29
       29
       +
               libraries = [ "/var/lib/calibre-data" "/var/lib/calibre-server" ];

     

       30
       30
       +
             };

     

       31
       31
       +
             calibreScript = ''

     

       32
       32
       +
               succeed("ls -la /var/lib/calibre-data")

     

       33
       33
       +
               succeed("ls -la /var/lib/calibre-server")

     

       34
       34
       +
               wait_for_unit("calibre-server.service")

     

       35
       35
       +
             '';

     

       36
       36
       +
           };

     

       37
       37
       +
           hostAndPort = {

     

       38
       38
       +
             calibreConfig = {

     

       39
       39
       +
               host = "127.0.0.1";

     

       40
       40
       +
               port = 8888;

     

       41
       41
       +
             };

     

       42
       42
       +
             calibreScript = ''

     

       43
       43
       +
               wait_for_unit("calibre-server.service")

     

       44
       44
       +
               wait_for_open_port(8888)

     

       45
       45
       +
               succeed("curl --fail http://127.0.0.1:8888")

     

       46
       46
       +
             '';

     

       47
       47
       +
           };

     

       48
       48
       +
           basicAuth = {

     

       49
       49
       +
             calibreConfig = {

     

       50
       50
       +
               host = "127.0.0.1";

     

       51
       51
       +
               port = 8888;

     

       52
       52
       +
               auth = {

     

       53
       53
       +
                 enable = true;

     

       54
       54
       +
                 mode = "basic";

     

       55
       55
       +
               };

     

       56
       56
       +
             };

     

       57
       57
       +
             calibreScript = ''

     

       58
       58
       +
               wait_for_unit("calibre-server.service")

     

       59
       59
       +
               wait_for_open_port(8888)

     

       60
       60
       +
               fail("curl --fail http://127.0.0.1:8888")

     

       61
       61
       +
             '';

     

       62
       62
       +
           };

     

       63
       63
       +
         };

     

       64
       64
       +
       in

     

       65
       65
       +
       mapAttrs

     

       66
       66
       +
         (test: testConfig: (makeTest (

     

       67
       67
       +
           let

     

       68
       68
       +
             nodeName = testConfig.nodeName or test;

     

       69
       69
       +
             calibreConfig = {

     

       70
       70
       +
               enable = true;

     

       71
       71
       +
               libraries = [ "/var/lib/calibre-server" ];

     

       72
       72
       +
             } // testConfig.calibreConfig or {};

     

       73
       73
       +
             librariesInitScript = path: ''

     

       74
       74
       +
               ${nodeName}.execute("touch /tmp/test.epub")

     

       75
       75
       +
               ${nodeName}.execute("zip -r /tmp/test.zip /tmp/test.epub")

     

       76
       76
       +
               ${nodeName}.execute("mkdir -p ${path}")

     

       77
       77
       +
               ${nodeName}.execute("calibredb add -d --with-library ${path} /tmp/test.zip")

     

       78
       78
       +
             '';

     

       79
       79
       +
           in

     

       80
       80
       +
           {

     

       81
       81
       +
             name = "calibre-server-${test}";

     

       82
       82
       +
       

     

       83
       83
       +
             nodes.${nodeName} = mkMerge [{

     

       84
       84
       +
               environment.systemPackages = [ pkgs.zip ];

     

       85
       85
       +
               services.calibre-server = calibreConfig;

     

       86
       86
       +
             } testConfig.calibreProvider or { }];

     

       87
       87
       +
       

     

       88
       88
       +
             testScript = ''

     

       89
       89
       +
               ${nodeName}.start()

     

       90
       90
       +
               ${concatStringsSep "\n" (map librariesInitScript calibreConfig.libraries)}

     

       91
       91
       +
               ${concatStringsSep "\n" (map (line:

     

       92
       92
       +
                 if (builtins.substring 0 1 line == " " || builtins.substring 0 1 line == ")")

     

       93
       93
       +
                 then line

     

       94
       94
       +
                 else "${nodeName}.${line}"

     

       95
       95
       +
               ) (splitString "\n" (removeSuffix "\n" testConfig.calibreScript)))}

     

       96
       96
       +
               ${nodeName}.shutdown()

     

       97
       97
       +
             '';

     

       98
       98
       +
       

     

       99
       99
       +
             meta = with maintainers; {

     

       100
       100
       +
               maintainers = [ gaelreyrol ];

     

       101
       101
       +
             };

     

       102
       102
       +
           }

     

       103
       103
       +
         )))

     

       104
       104
       +
         tests