commit 31aedcfbee577d8118709cbfd1ecc0d61ff49f82 · pyrox.dev/nixpkgs

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

···

       258
        
       - `services.paperless` now installs `paperless-manage` as a normal system package instead of creating a symlink in `/var/lib/paperless`.

     

       259
        
         `paperless-manage` now also changes to the appropriate user when being executed.

     

       260
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       261
        
       - `asusd` has been upgraded to version 6 which supports multiple aura devices. To account for this, the single `auraConfig` configuration option has been replaced with `auraConfigs` which is an attribute set of config options per each device. The config files may also be now specified as either source files or text strings; to account for this you will need to specify that `text` is used for your existing configs, e.g.:

     

       262
        
         ```diff

     

       263
        
         -services.asusd.asusdConfig = '''file contents'''

···

       258
        
       - `services.paperless` now installs `paperless-manage` as a normal system package instead of creating a symlink in `/var/lib/paperless`.

     

       259
        
         `paperless-manage` now also changes to the appropriate user when being executed.

     

       260
        
       

     

       261
       +
       - The `gotenberg` package has been updated to 8.16.0, which brings breaking changes to the configuration from version 8.13.0. See the [upstream release notes](https://github.com/gotenberg/gotenberg/releases/tag/v8.13.0)

     

       262
       +
         for that release to get all the details. The `services.gotenberg` module has been updated appropriately to ensure your configuration is valid with this new release.

     

       263
       +
       

     

       264
        
       - `asusd` has been upgraded to version 6 which supports multiple aura devices. To account for this, the single `auraConfig` configuration option has been replaced with `auraConfigs` which is an attribute set of config options per each device. The config files may also be now specified as either source files or text strings; to account for this you will need to specify that `text` is used for your existing configs, e.g.:

     

       265
        
         ```diff

     

       266
        
         -services.asusd.asusdConfig = '''file contents'''

+119 -21

nixos/modules/services/misc/gotenberg.nix

···

       16
        
             "--chromium-max-queue-size=${toString cfg.chromium.maxQueueSize}"

     

       17
        
             "--libreoffice-restart-after=${toString cfg.libreoffice.restartAfter}"

     

       18
        
             "--libreoffice-max-queue-size=${toString cfg.libreoffice.maxQueueSize}"

     

       19
       -
             "--pdfengines-engines=${lib.concatStringsSep "," cfg.pdfEngines}"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       20
        
           ]

     

       21
        
           ++ optional cfg.enableBasicAuth "--api-enable-basic-auth"

     

       22
        
           ++ optional cfg.chromium.autoStart "--chromium-auto-start"

     

       23
        
           ++ optional cfg.chromium.disableJavascript "--chromium-disable-javascript"

     

       24
        
           ++ optional cfg.chromium.disableRoutes "--chromium-disable-routes"

     

       25
        
           ++ optional cfg.libreoffice.autoStart "--libreoffice-auto-start"

     

       26
       -
           ++ optional cfg.libreoffice.disableRoutes "--libreoffice-disable-routes";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       27
        
       

     

       28
        
         inherit (lib)

     

       29
        
           mkEnableOption

     
···

       51
        
               description = "Port on which the API should listen.";

     

       52
        
             };

     

       53
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       54
        
             timeout = mkOption {

     

       55
        
               type = types.nullOr types.str;

     

       56
        
               default = "30s";

     
···

       74
        
               '';

     

       75
        
             };

     

       76
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       77
        
             extraFontPackages = mkOption {

     

       78
        
               type = types.listOf types.package;

     

       79
        
               default = [ ];

     
···

       108
        
               };

     

       109
        
             };

     

       110
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       111
        
             libreoffice = {

     

       112
        
               package = mkPackageOption pkgs "libreoffice" { };

     

       113
        
       

     
···

       136
        
               };

     

       137
        
             };

     

       138
        
       

     

       139
       -
             pdfEngines = mkOption {

     

       140
       -
               type = types.listOf (

     

       141
       -
                 types.enum [

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       142
        
                   "pdftk"

     

       143
       -
                   "qpdf"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       144
        
                   "libreoffice-pdfengine"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       145
        
                   "exiftool"

     

       146
       -
                   "pdfcpu"

     

       147
       -
                 ]

     

       148
       -
               );

     

       149
       -
               default = [

     

       150
       -
                 "pdftk"

     

       151
       -
                 "qpdf"

     

       152
       -
                 "libreoffice-pdfengine"

     

       153
       -
                 "exiftool"

     

       154
       -
                 "pdfcpu"

     

       155
       -
               ];

     

       156
       -
               description = ''

     

       157
       -
                 PDF engines to enable. Each one can be used to perform a specific task.

     

       158
       -
                 See [the documentation](https://gotenberg.dev/docs/configuration#pdf-engines) for more details.

     

       159
       -
                 Defaults to all possible PDF engines.

     

       160
       -
               '';

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       161
        
             };

     

       162
        
       

     

       163
        
             logLevel = mkOption {

     
···

       196
        
                 See `services.gotenberg.enableBasicAuth` for the names of those variables.

     

       197
        
               '';

     

       198
        
             }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       199
        
           ];

     

       200
        
       

     

       201
        
           systemd.services.gotenberg = {

     
···

       209
        
               FONTCONFIG_FILE = pkgs.makeFontsConf {

     

       210
        
                 fontDirectories = [ pkgs.liberation_ttf_v2 ] ++ cfg.extraFontPackages;

     

       211
        
               };

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       212
        
             };

     

       213
        
             serviceConfig = {

     

       214
        
               Type = "simple";

     

       215
        
               DynamicUser = true;

     

       216
        
               ExecStart = "${lib.getExe cfg.package} ${lib.escapeShellArgs args}";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       217
        
       

     

       218
        
               # Hardening options

     

       219
        
               PrivateDevices = true;

     
···

       243
        
               SystemCallFilter = [

     

       244
        
                 "@sandbox"

     

       245
        
                 "@system-service"

     

       0
        
       
     

       246
        
               ];

     

       247
        
               SystemCallArchitectures = "native";

     

       248

···

       16
        
             "--chromium-max-queue-size=${toString cfg.chromium.maxQueueSize}"

     

       17
        
             "--libreoffice-restart-after=${toString cfg.libreoffice.restartAfter}"

     

       18
        
             "--libreoffice-max-queue-size=${toString cfg.libreoffice.maxQueueSize}"

     

       19
       +
             "--pdfengines-merge-engines=${lib.concatStringsSep "," cfg.pdfEngines.merge}"

     

       20
       +
             "--pdfengines-convert-engines=${lib.concatStringsSep "," cfg.pdfEngines.convert}"

     

       21
       +
             "--pdfengines-read-metadata-engines=${lib.concatStringsSep "," cfg.pdfEngines.readMetadata}"

     

       22
       +
             "--pdfengines-write-metadata-engines=${lib.concatStringsSep "," cfg.pdfEngines.writeMetadata}"

     

       23
       +
             "--api-download-from-allow-list=${cfg.downloadFrom.allowList}"

     

       24
       +
             "--api-download-from-max-retry=${toString cfg.downloadFrom.maxRetries}"

     

       25
        
           ]

     

       26
        
           ++ optional cfg.enableBasicAuth "--api-enable-basic-auth"

     

       27
        
           ++ optional cfg.chromium.autoStart "--chromium-auto-start"

     

       28
        
           ++ optional cfg.chromium.disableJavascript "--chromium-disable-javascript"

     

       29
        
           ++ optional cfg.chromium.disableRoutes "--chromium-disable-routes"

     

       30
        
           ++ optional cfg.libreoffice.autoStart "--libreoffice-auto-start"

     

       31
       +
           ++ optional cfg.libreoffice.disableRoutes "--libreoffice-disable-routes"

     

       32
       +
           ++ optional cfg.pdfEngines.disableRoutes "--pdfengines-disable-routes"

     

       33
       +
           ++ optional (

     

       34
       +
             cfg.downloadFrom.denyList != null

     

       35
       +
           ) "--api-download-from-deny-list=${cfg.downloadFrom.denyList}"

     

       36
       +
           ++ optional cfg.downloadFrom.disable "--api-disable-download-from"

     

       37
       +
           ++ optional (cfg.bodyLimit != null) "--api-body-limit=${cfg.bodyLimit}"

     

       38
       +
           ++ lib.optionals (cfg.extraArgs != [ ]) cfg.extraArgs;

     

       39
        
       

     

       40
        
         inherit (lib)

     

       41
        
           mkEnableOption

     
···

       63
        
               description = "Port on which the API should listen.";

     

       64
        
             };

     

       65
        
       

     

       66
       +
             bindIP = mkOption {

     

       67
       +
               type = types.nullOr types.str;

     

       68
       +
               default = "127.0.0.1";

     

       69
       +
               description = "Port the API listener should bind to. Set to 0.0.0.0 to listen on all available IPs.";

     

       70
       +
             };

     

       71
       +
       

     

       72
        
             timeout = mkOption {

     

       73
        
               type = types.nullOr types.str;

     

       74
        
               default = "30s";

     
···

       92
        
               '';

     

       93
        
             };

     

       94
        
       

     

       95
       +
             bodyLimit = mkOption {

     

       96
       +
               type = types.nullOr types.str;

     

       97
       +
               default = null;

     

       98
       +
               description = "Sets the max limit for `multipart/form-data` requests. Accepts values like '5M', '20G', etc.";

     

       99
       +
             };

     

       100
       +
       

     

       101
        
             extraFontPackages = mkOption {

     

       102
        
               type = types.listOf types.package;

     

       103
        
               default = [ ];

     
···

       132
        
               };

     

       133
        
             };

     

       134
        
       

     

       135
       +
             downloadFrom = {

     

       136
       +
               allowList = mkOption {

     

       137
       +
                 type = types.nullOr types.str;

     

       138
       +
                 default = ".*";

     

       139
       +
                 description = "Allow these URLs to be used in the `downloadFrom` API field. Accepts a regular expression.";

     

       140
       +
               };

     

       141
       +
               denyList = mkOption {

     

       142
       +
                 type = types.nullOr types.str;

     

       143
       +
                 default = null;

     

       144
       +
                 description = "Deny accepting URLs from these domains in the `downloadFrom` API field. Accepts a regular expression.";

     

       145
       +
               };

     

       146
       +
               maxRetries = mkOption {

     

       147
       +
                 type = types.int;

     

       148
       +
                 default = 4;

     

       149
       +
                 description = "The maximum amount of times to retry downloading a file specified with `downloadFrom`.";

     

       150
       +
               };

     

       151
       +
               disable = mkOption {

     

       152
       +
                 type = types.bool;

     

       153
       +
                 default = false;

     

       154
       +
                 description = "Whether to disable the ability to download files for conversion from outside sources.";

     

       155
       +
               };

     

       156
       +
             };

     

       157
       +
       

     

       158
        
             libreoffice = {

     

       159
        
               package = mkPackageOption pkgs "libreoffice" { };

     

       160
        
       

     
···

       183
        
               };

     

       184
        
             };

     

       185
        
       

     

       186
       +
             pdfEngines = {

     

       187
       +
               merge = mkOption {

     

       188
       +
                 type = types.listOf (

     

       189
       +
                   types.enum [

     

       190
       +
                     "qpdf"

     

       191
       +
                     "pdfcpu"

     

       192
       +
                     "pdftk"

     

       193
       +
                   ]

     

       194
       +
                 );

     

       195
       +
                 default = [

     

       196
       +
                   "qpdf"

     

       197
       +
                   "pdfcpu"

     

       198
        
                   "pdftk"

     

       199
       +
                 ];

     

       200
       +
                 description = "PDF Engines to use for merging files.";

     

       201
       +
               };

     

       202
       +
               convert = mkOption {

     

       203
       +
                 type = types.listOf (

     

       204
       +
                   types.enum [

     

       205
       +
                     "libreoffice-pdfengine"

     

       206
       +
                   ]

     

       207
       +
                 );

     

       208
       +
                 default = [

     

       209
        
                   "libreoffice-pdfengine"

     

       210
       +
                 ];

     

       211
       +
                 description = "PDF Engines to use for converting files.";

     

       212
       +
               };

     

       213
       +
               readMetadata = mkOption {

     

       214
       +
                 type = types.listOf (

     

       215
       +
                   types.enum [

     

       216
       +
                     "exiftool"

     

       217
       +
                   ]

     

       218
       +
                 );

     

       219
       +
                 default = [

     

       220
        
                   "exiftool"

     

       221
       +
                 ];

     

       222
       +
                 description = "PDF Engines to use for reading metadata from files.";

     

       223
       +
               };

     

       224
       +
               writeMetadata = mkOption {

     

       225
       +
                 type = types.listOf (

     

       226
       +
                   types.enum [

     

       227
       +
                     "exiftool"

     

       228
       +
                   ]

     

       229
       +
                 );

     

       230
       +
                 default = [

     

       231
       +
                   "exiftool"

     

       232
       +
                 ];

     

       233
       +
                 description = "PDF Engines to use for writing metadata to files.";

     

       234
       +
               };

     

       235
       +
       

     

       236
       +
               disableRoutes = mkOption {

     

       237
       +
                 type = types.bool;

     

       238
       +
                 default = false;

     

       239
       +
                 description = "Disable routes related to PDF engines.";

     

       240
       +
               };

     

       241
        
             };

     

       242
        
       

     

       243
        
             logLevel = mkOption {

     
···

       276
        
                 See `services.gotenberg.enableBasicAuth` for the names of those variables.

     

       277
        
               '';

     

       278
        
             }

     

       279
       +
             {

     

       280
       +
               assertion = !(lib.isList cfg.pdfEngines);

     

       281
       +
               message = ''

     

       282
       +
                 Setting `services.gotenberg.pdfEngines` to a list is now deprecated.

     

       283
       +
                 Use the new `pdfEngines.mergeEngines`, `pdfEngines.convertEngines`, `pdfEngines.readMetadataEngines`, and `pdfEngines.writeMetadataEngines` settings instead.

     

       284
       +
       

     

       285
       +
                 The previous option was using a method that is now deprecated by upstream.

     

       286
       +
               '';

     

       287
       +
             }

     

       288
        
           ];

     

       289
        
       

     

       290
        
           systemd.services.gotenberg = {

     
···

       298
        
               FONTCONFIG_FILE = pkgs.makeFontsConf {

     

       299
        
                 fontDirectories = [ pkgs.liberation_ttf_v2 ] ++ cfg.extraFontPackages;

     

       300
        
               };

     

       301
       +
               # Needed for LibreOffice to work correctly.

     

       302
       +
               # https://github.com/NixOS/nixpkgs/issues/349123#issuecomment-2418330936

     

       303
       +
               HOME = "/run/gotenberg";

     

       304
        
             };

     

       305
        
             serviceConfig = {

     

       306
        
               Type = "simple";

     

       307
        
               DynamicUser = true;

     

       308
        
               ExecStart = "${lib.getExe cfg.package} ${lib.escapeShellArgs args}";

     

       309
       +
       

     

       310
       +
               # Needed for LibreOffice to work correctly.

     

       311
       +
               # See above issue comment.

     

       312
       +
               WorkingDirectory = "/run/gotenberg";

     

       313
       +
               RuntimeDirectory = "gotenberg";

     

       314
        
       

     

       315
        
               # Hardening options

     

       316
        
               PrivateDevices = true;

     
···

       340
        
               SystemCallFilter = [

     

       341
        
                 "@sandbox"

     

       342
        
                 "@system-service"

     

       343
       +
                 "@chown"

     

       344
        
               ];

     

       345
        
               SystemCallArchitectures = "native";

     

       346