commit 1440b865c08f6ae66d4e2e30f06fa4e3bfb6bad6 · pyrox.dev/nixpkgs

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

···

       55
       55
        
       

     

       56
       56
        
       - The `hardware.pulseaudio` module now sets permission of pulse user home directory to 755 when running in "systemWide" mode. It fixes [issue 114399](https://github.com/NixOS/nixpkgs/issues/114399).

     

       57
       57
        
       

     

       58
       58
       +
       - The `btrbk` module now automatically selects and provides required compression

     

       59
       59
       +
         program depending on the configured `stream_compress` option. Since this

     

       60
       60
       +
         replaces the need for the `extraPackages` option, this option will be

     

       61
       61
       +
         deprecated in future releases.

     

       62
       62
       +
       

     

       58
       63
        
       - QtMultimedia has changed its default backend to `QT_MEDIA_BACKEND=ffmpeg` (previously `gstreamer` on Linux or `darwin` on MacOS).

     

       59
       64
        
         The previous native backends remain available but are now minimally maintained. Refer to [upstream documentation](https://doc.qt.io/qt-6/qtmultimedia-index.html#ffmpeg-as-the-default-backend) for further details about each platform.

+46 -4

nixos/modules/services/backup/btrbk.nix

···

       6
       6
        
           concatMapStringsSep

     

       7
       7
        
           concatStringsSep

     

       8
       8
        
           filterAttrs

     

       9
       9
       +
           flatten

     

       10
       10
       +
           getAttr

     

       9
       11
        
           isAttrs

     

       10
       12
        
           literalExpression

     

       11
       13
        
           mapAttrs'

     

       12
       14
        
           mapAttrsToList

     

       13
       15
        
           mkIf

     

       14
       16
        
           mkOption

     

       17
       17
       +
           optional

     

       15
       18
        
           optionalString

     

       16
       19
        
           sort

     

       17
       20
        
           types

     
···

       84
       87
        
           '';

     

       85
       88
        
         };

     

       86
       89
        
       

     

       90
       90
       +
         streamCompressMap = {

     

       91
       91
       +
           gzip = pkgs.gzip;

     

       92
       92
       +
           pigz = pkgs.pigz;

     

       93
       93
       +
           bzip2 = pkgs.bzip2;

     

       94
       94
       +
           pbzip2 = pkgs.pbzip2;

     

       95
       95
       +
           bzip3 = pkgs.bzip3;

     

       96
       96
       +
           xz = pkgs.xz;

     

       97
       97
       +
           lzo = pkgs.lzo;

     

       98
       98
       +
           lz4 = pkgs.lz4;

     

       99
       99
       +
           zstd = pkgs.zstd;

     

       100
       100
       +
         };

     

       101
       101
       +
       

     

       87
       102
        
         cfg = config.services.btrbk;

     

       88
       103
        
         sshEnabled = cfg.sshAccess != [ ];

     

       89
       104
        
         serviceEnabled = cfg.instances != { };

     
···

       94
       109
        
         options = {

     

       95
       110
        
           services.btrbk = {

     

       96
       111
        
             extraPackages = mkOption {

     

       97
       97
       -
               description = lib.mdDoc "Extra packages for btrbk, like compression utilities for `stream_compress`";

     

       112
       112
       +
               description = lib.mdDoc ''

     

       113
       113
       +
                 Extra packages for btrbk, like compression utilities for `stream_compress`.

     

       114
       114
       +
       

     

       115
       115
       +
                 **Note**: This option will get deprecated in future releases.

     

       116
       116
       +
                 Required compression programs will get automatically provided to btrbk

     

       117
       117
       +
                 depending on configured compression method in

     

       118
       118
       +
                 `services.btrbk.instances.<name>.settings` option.

     

       119
       119
       +
               '';

     

       98
       120
        
               type = types.listOf types.package;

     

       99
       121
        
               default = [ ];

     

       100
       122
        
               example = literalExpression "[ pkgs.xz ]";

     
···

       124
       146
        
                         '';

     

       125
       147
        
                       };

     

       126
       148
        
                       settings = mkOption {

     

       127
       127
       -
                         type = let t = types.attrsOf (types.either types.str (t // { description = "instances of this type recursively"; })); in t;

     

       149
       149
       +
                         type = types.submodule {

     

       150
       150
       +
                           freeformType = let t = types.attrsOf (types.either types.str (t // { description = "instances of this type recursively"; })); in t;

     

       151
       151
       +
                           options = {

     

       152
       152
       +
                             stream_compress = mkOption {

     

       153
       153
       +
                               description = lib.mdDoc ''

     

       154
       154
       +
                                 Compress the btrfs send stream before transferring it from/to remote locations using a

     

       155
       155
       +
                                 compression command.

     

       156
       156
       +
                               '';

     

       157
       157
       +
                               type = types.enum ["gzip" "pigz" "bzip2" "pbzip2" "bzip3" "xz" "lzo" "lz4" "zstd" "no"];

     

       158
       158
       +
                               default = "no";

     

       159
       159
       +
                             };

     

       160
       160
       +
                           };

     

       161
       161
       +
                         };

     

       128
       162
        
                         default = { };

     

       129
       163
        
                         example = {

     

       130
       164
        
                           snapshot_preserve_min = "2d";

     
···

       169
       203
        
       

     

       170
       204
        
         };

     

       171
       205
        
         config = mkIf (sshEnabled || serviceEnabled) {

     

       206
       206
       +
       

     

       207
       207
       +
           warnings = optional (cfg.extraPackages != []) ''

     

       208
       208
       +
             extraPackages option will be deprecated in future releases. Programs required for compression are now automatically selected depending on services.btrbk.instances.<name>.settings.stream_compress option.

     

       209
       209
       +
           '';

     

       210
       210
       +
       

     

       172
       211
        
           environment.systemPackages = [ pkgs.btrbk ] ++ cfg.extraPackages;

     

       173
       212
        
       

     

       174
       213
        
           security.sudo.extraRules = mkIf (sudo_doas == "sudo") [ sudoRule ];

     
···

       232
       271
        
             cfg.instances;

     

       233
       272
        
           systemd.services = mapAttrs'

     

       234
       273
        
             (

     

       235
       235
       -
               name: _: {

     

       274
       274
       +
               name: instance: {

     

       236
       275
        
                 name = "btrbk-${name}";

     

       237
       276
        
                 value = {

     

       238
       277
        
                   description = "Takes BTRFS snapshots and maintains retention policies.";

     

       239
       278
        
                   unitConfig.Documentation = "man:btrbk(1)";

     

       240
       240
       -
                   path = [ "/run/wrappers" ] ++ cfg.extraPackages;

     

       279
       279
       +
                   path = [ "/run/wrappers" ]

     

       280
       280
       +
                     ++ cfg.extraPackages

     

       281
       281
       +
                     ++ optional (instance.settings.stream_compress != "no")

     

       282
       282
       +
                       (getAttr instance.settings.stream_compress streamCompressMap);

     

       241
       283
        
                   serviceConfig = {

     

       242
       284
        
                     User = "btrbk";

     

       243
       285
        
                     Group = "btrbk";

-1

nixos/tests/btrbk.nix

···

       27
       27
        
               # don't do it with real ssh keys.

     

       28
       28
        
               environment.etc."btrbk_key".text = privateKey;

     

       29
       29
        
               services.btrbk = {

     

       30
       30
       -
                 extraPackages = [ pkgs.lz4 ];

     

       31
       30
        
                 instances = {

     

       32
       31
        
                   remote = {

     

       33
       32
        
                     onCalendar = "minutely";