commit 860a0449cebd29682c87960af319ec6a2336b1e2 · pyrox.dev/nixpkgs

+5 -5

nixos/modules/system/boot/loader/generations-dir/generations-dir.nix

···

       22
        
             enable = mkOption {

     

       23
        
               default = false;

     

       24
        
               type = types.bool;

     

       25
       -
               description = ''

     

       26
        
                 Whether to create symlinks to the system generations under

     

       27
       -
                 <literal>/boot</literal>.  When enabled,

     

       28
       -
                 <literal>/boot/default/kernel</literal>,

     

       29
       -
                 <literal>/boot/default/initrd</literal>, etc., are updated to

     

       30
        
                 point to the current generation's kernel image, initial RAM

     

       31
        
                 disk, and other bootstrap files.

     

       32
        
       

     
···

       41
        
             copyKernels = mkOption {

     

       42
        
               default = false;

     

       43
        
               type = types.bool;

     

       44
       -
               description = ''

     

       45
        
                 Whether copy the necessary boot files into /boot, so

     

       46
        
                 /nix/store is not needed by the boot loader.

     

       47
        
               '';

···

       22
        
             enable = mkOption {

     

       23
        
               default = false;

     

       24
        
               type = types.bool;

     

       25
       +
               description = lib.mdDoc ''

     

       26
        
                 Whether to create symlinks to the system generations under

     

       27
       +
                 `/boot`.  When enabled,

     

       28
       +
                 `/boot/default/kernel`,

     

       29
       +
                 `/boot/default/initrd`, etc., are updated to

     

       30
        
                 point to the current generation's kernel image, initial RAM

     

       31
        
                 disk, and other bootstrap files.

     

       32
        
       

     
···

       41
        
             copyKernels = mkOption {

     

       42
        
               default = false;

     

       43
        
               type = types.bool;

     

       44
       +
               description = lib.mdDoc ''

     

       45
        
                 Whether copy the necessary boot files into /boot, so

     

       46
        
                 /nix/store is not needed by the boot loader.

     

       47
        
               '';

+35 -35

nixos/modules/system/boot/systemd.nix

···

       177
        
             default = pkgs.systemd;

     

       178
        
             defaultText = literalExpression "pkgs.systemd";

     

       179
        
             type = types.package;

     

       180
       -
             description = "The systemd package.";

     

       181
        
           };

     

       182
        
       

     

       183
        
           systemd.units = mkOption {

     

       184
       -
             description = "Definition of systemd units.";

     

       185
        
             default = {};

     

       186
        
             type = systemdUtils.types.units;

     

       187
        
           };

     
···

       190
        
             default = [];

     

       191
        
             type = types.listOf types.package;

     

       192
        
             example = literalExpression "[ pkgs.systemd-cryptsetup-generator ]";

     

       193
       -
             description = "Packages providing systemd units and hooks.";

     

       194
        
           };

     

       195
        
       

     

       196
        
           systemd.targets = mkOption {

     

       197
        
             default = {};

     

       198
        
             type = systemdUtils.types.targets;

     

       199
       -
             description = "Definition of systemd target units.";

     

       200
        
           };

     

       201
        
       

     

       202
        
           systemd.services = mkOption {

     

       203
        
             default = {};

     

       204
        
             type = systemdUtils.types.services;

     

       205
       -
             description = "Definition of systemd service units.";

     

       206
        
           };

     

       207
        
       

     

       208
        
           systemd.sockets = mkOption {

     

       209
        
             default = {};

     

       210
        
             type = systemdUtils.types.sockets;

     

       211
       -
             description = "Definition of systemd socket units.";

     

       212
        
           };

     

       213
        
       

     

       214
        
           systemd.timers = mkOption {

     

       215
        
             default = {};

     

       216
        
             type = systemdUtils.types.timers;

     

       217
       -
             description = "Definition of systemd timer units.";

     

       218
        
           };

     

       219
        
       

     

       220
        
           systemd.paths = mkOption {

     

       221
        
             default = {};

     

       222
        
             type = systemdUtils.types.paths;

     

       223
       -
             description = "Definition of systemd path units.";

     

       224
        
           };

     

       225
        
       

     

       226
        
           systemd.mounts = mkOption {

     

       227
        
             default = [];

     

       228
        
             type = systemdUtils.types.mounts;

     

       229
       -
             description = ''

     

       230
        
               Definition of systemd mount units.

     

       231
        
               This is a list instead of an attrSet, because systemd mandates the names to be derived from

     

       232
        
               the 'where' attribute.

     
···

       236
        
           systemd.automounts = mkOption {

     

       237
        
             default = [];

     

       238
        
             type = systemdUtils.types.automounts;

     

       239
       -
             description = ''

     

       240
        
               Definition of systemd automount units.

     

       241
        
               This is a list instead of an attrSet, because systemd mandates the names to be derived from

     

       242
        
               the 'where' attribute.

     
···

       246
        
           systemd.slices = mkOption {

     

       247
        
             default = {};

     

       248
        
             type = systemdUtils.types.slices;

     

       249
       -
             description = "Definition of slice configurations.";

     

       250
        
           };

     

       251
        
       

     

       252
        
           systemd.generators = mkOption {

     

       253
        
             type = types.attrsOf types.path;

     

       254
        
             default = {};

     

       255
        
             example = { systemd-gpt-auto-generator = "/dev/null"; };

     

       256
       -
             description = ''

     

       257
        
               Definition of systemd generators.

     

       258
       -
               For each <literal>NAME = VALUE</literal> pair of the attrSet, a link is generated from

     

       259
       -
               <literal>/etc/systemd/system-generators/NAME</literal> to <literal>VALUE</literal>.

     

       260
        
             '';

     

       261
        
           };

     

       262
        
       

     

       263
        
           systemd.shutdown = mkOption {

     

       264
        
             type = types.attrsOf types.path;

     

       265
        
             default = {};

     

       266
       -
             description = ''

     

       267
        
               Definition of systemd shutdown executables.

     

       268
       -
               For each <literal>NAME = VALUE</literal> pair of the attrSet, a link is generated from

     

       269
       -
               <literal>/etc/systemd/system-shutdown/NAME</literal> to <literal>VALUE</literal>.

     

       270
        
             '';

     

       271
        
           };

     

       272
        
       

     

       273
        
           systemd.defaultUnit = mkOption {

     

       274
        
             default = "multi-user.target";

     

       275
        
             type = types.str;

     

       276
       -
             description = "Default unit started when the system boots.";

     

       277
        
           };

     

       278
        
       

     

       279
        
           systemd.ctrlAltDelUnit = mkOption {

     

       280
        
             default = "reboot.target";

     

       281
        
             type = types.str;

     

       282
        
             example = "poweroff.target";

     

       283
       -
             description = ''

     

       284
        
               Target that should be started when Ctrl-Alt-Delete is pressed.

     

       285
        
             '';

     

       286
        
           };

     
···

       289
        
             type = with types; attrsOf (nullOr (oneOf [ str path package ]));

     

       290
        
             default = {};

     

       291
        
             example = { TZ = "CET"; };

     

       292
       -
             description = ''

     

       293
       -
               Environment variables passed to <emphasis>all</emphasis> systemd units.

     

       294
        
             '';

     

       295
        
           };

     

       296
        
       

     
···

       298
        
             type = with types; attrsOf (nullOr (oneOf [ str path package ]));

     

       299
        
             default = {};

     

       300
        
             example = { SYSTEMD_LOG_LEVEL = "debug"; };

     

       301
       -
             description = ''

     

       302
        
               Environment variables of PID 1. These variables are

     

       303
       -
               <emphasis>not</emphasis> passed to started units.

     

       304
        
             '';

     

       305
        
           };

     

       306
        
       

     

       307
        
           systemd.enableCgroupAccounting = mkOption {

     

       308
        
             default = true;

     

       309
        
             type = types.bool;

     

       310
       -
             description = ''

     

       311
        
               Whether to enable cgroup accounting.

     

       312
        
             '';

     

       313
        
           };

     
···

       315
        
           systemd.enableUnifiedCgroupHierarchy = mkOption {

     

       316
        
             default = true;

     

       317
        
             type = types.bool;

     

       318
       -
             description = ''

     

       319
        
               Whether to enable the unified cgroup hierarchy (cgroupsv2).

     

       320
        
             '';

     

       321
        
           };

     
···

       324
        
             default = "";

     

       325
        
             type = types.lines;

     

       326
        
             example = "DefaultLimitCORE=infinity";

     

       327
       -
             description = ''

     

       328
        
               Extra config options for systemd. See man systemd-system.conf for

     

       329
        
               available options.

     

       330
        
             '';

     
···

       334
        
             default = "";

     

       335
        
             type = types.lines;

     

       336
        
             example = "HibernateDelaySec=1h";

     

       337
       -
             description = ''

     

       338
        
               Extra config options for systemd sleep state logic.

     

       339
        
               See sleep.conf.d(5) man page for available options.

     

       340
        
             '';

     
···

       344
        
             default = [ ];

     

       345
        
             type = types.listOf types.str;

     

       346
        
             example = [ "debug-shell.service" "systemd-quotacheck.service" ];

     

       347
       -
             description = ''

     

       348
        
               Additional units shipped with systemd that shall be enabled.

     

       349
        
             '';

     

       350
        
           };

     
···

       353
        
             default = [ ];

     

       354
        
             type = types.listOf types.str;

     

       355
        
             example = [ "systemd-backlight@.service" ];

     

       356
       -
             description = ''

     

       357
        
               A list of units to skip when generating system systemd configuration directory. This has

     

       358
       -
               priority over upstream units, <option>systemd.units</option>, and

     

       359
       -
               <option>systemd.additionalUpstreamSystemUnits</option>. The main purpose of this is to

     

       360
        
               prevent a upstream systemd unit from being added to the initrd with any modifications made to it

     

       361
        
               by other NixOS modules.

     

       362
        
             '';

     
···

       366
        
             type = types.nullOr types.path;

     

       367
        
             default = null;

     

       368
        
             example = "/dev/watchdog";

     

       369
       -
             description = ''

     

       370
        
               The path to a hardware watchdog device which will be managed by systemd.

     

       371
        
               If not specified, systemd will default to /dev/watchdog.

     

       372
        
             '';

     
···

       376
        
             type = types.nullOr types.str;

     

       377
        
             default = null;

     

       378
        
             example = "30s";

     

       379
       -
             description = ''

     

       380
        
               The amount of time which can elapse before a watchdog hardware device

     

       381
        
               will automatically reboot the system. Valid time units include "ms",

     

       382
        
               "s", "min", "h", "d", and "w".

     
···

       387
        
             type = types.nullOr types.str;

     

       388
        
             default = null;

     

       389
        
             example = "10m";

     

       390
       -
             description = ''

     

       391
        
               The amount of time which can elapse after a reboot has been triggered

     

       392
        
               before a watchdog hardware device will automatically reboot the system.

     

       393
        
               Valid time units include "ms", "s", "min", "h", "d", and "w".

     
···

       398
        
             type = types.nullOr types.str;

     

       399
        
             default = null;

     

       400
        
             example = "10m";

     

       401
       -
             description = ''

     

       402
        
               The amount of time which can elapse when kexec is being executed before

     

       403
        
               a watchdog hardware device will automatically reboot the system. This

     

       404
        
               option should only be enabled if reloadTime is also enabled. Valid

···

       177
        
             default = pkgs.systemd;

     

       178
        
             defaultText = literalExpression "pkgs.systemd";

     

       179
        
             type = types.package;

     

       180
       +
             description = lib.mdDoc "The systemd package.";

     

       181
        
           };

     

       182
        
       

     

       183
        
           systemd.units = mkOption {

     

       184
       +
             description = lib.mdDoc "Definition of systemd units.";

     

       185
        
             default = {};

     

       186
        
             type = systemdUtils.types.units;

     

       187
        
           };

     
···

       190
        
             default = [];

     

       191
        
             type = types.listOf types.package;

     

       192
        
             example = literalExpression "[ pkgs.systemd-cryptsetup-generator ]";

     

       193
       +
             description = lib.mdDoc "Packages providing systemd units and hooks.";

     

       194
        
           };

     

       195
        
       

     

       196
        
           systemd.targets = mkOption {

     

       197
        
             default = {};

     

       198
        
             type = systemdUtils.types.targets;

     

       199
       +
             description = lib.mdDoc "Definition of systemd target units.";

     

       200
        
           };

     

       201
        
       

     

       202
        
           systemd.services = mkOption {

     

       203
        
             default = {};

     

       204
        
             type = systemdUtils.types.services;

     

       205
       +
             description = lib.mdDoc "Definition of systemd service units.";

     

       206
        
           };

     

       207
        
       

     

       208
        
           systemd.sockets = mkOption {

     

       209
        
             default = {};

     

       210
        
             type = systemdUtils.types.sockets;

     

       211
       +
             description = lib.mdDoc "Definition of systemd socket units.";

     

       212
        
           };

     

       213
        
       

     

       214
        
           systemd.timers = mkOption {

     

       215
        
             default = {};

     

       216
        
             type = systemdUtils.types.timers;

     

       217
       +
             description = lib.mdDoc "Definition of systemd timer units.";

     

       218
        
           };

     

       219
        
       

     

       220
        
           systemd.paths = mkOption {

     

       221
        
             default = {};

     

       222
        
             type = systemdUtils.types.paths;

     

       223
       +
             description = lib.mdDoc "Definition of systemd path units.";

     

       224
        
           };

     

       225
        
       

     

       226
        
           systemd.mounts = mkOption {

     

       227
        
             default = [];

     

       228
        
             type = systemdUtils.types.mounts;

     

       229
       +
             description = lib.mdDoc ''

     

       230
        
               Definition of systemd mount units.

     

       231
        
               This is a list instead of an attrSet, because systemd mandates the names to be derived from

     

       232
        
               the 'where' attribute.

     
···

       236
        
           systemd.automounts = mkOption {

     

       237
        
             default = [];

     

       238
        
             type = systemdUtils.types.automounts;

     

       239
       +
             description = lib.mdDoc ''

     

       240
        
               Definition of systemd automount units.

     

       241
        
               This is a list instead of an attrSet, because systemd mandates the names to be derived from

     

       242
        
               the 'where' attribute.

     
···

       246
        
           systemd.slices = mkOption {

     

       247
        
             default = {};

     

       248
        
             type = systemdUtils.types.slices;

     

       249
       +
             description = lib.mdDoc "Definition of slice configurations.";

     

       250
        
           };

     

       251
        
       

     

       252
        
           systemd.generators = mkOption {

     

       253
        
             type = types.attrsOf types.path;

     

       254
        
             default = {};

     

       255
        
             example = { systemd-gpt-auto-generator = "/dev/null"; };

     

       256
       +
             description = lib.mdDoc ''

     

       257
        
               Definition of systemd generators.

     

       258
       +
               For each `NAME = VALUE` pair of the attrSet, a link is generated from

     

       259
       +
               `/etc/systemd/system-generators/NAME` to `VALUE`.

     

       260
        
             '';

     

       261
        
           };

     

       262
        
       

     

       263
        
           systemd.shutdown = mkOption {

     

       264
        
             type = types.attrsOf types.path;

     

       265
        
             default = {};

     

       266
       +
             description = lib.mdDoc ''

     

       267
        
               Definition of systemd shutdown executables.

     

       268
       +
               For each `NAME = VALUE` pair of the attrSet, a link is generated from

     

       269
       +
               `/etc/systemd/system-shutdown/NAME` to `VALUE`.

     

       270
        
             '';

     

       271
        
           };

     

       272
        
       

     

       273
        
           systemd.defaultUnit = mkOption {

     

       274
        
             default = "multi-user.target";

     

       275
        
             type = types.str;

     

       276
       +
             description = lib.mdDoc "Default unit started when the system boots.";

     

       277
        
           };

     

       278
        
       

     

       279
        
           systemd.ctrlAltDelUnit = mkOption {

     

       280
        
             default = "reboot.target";

     

       281
        
             type = types.str;

     

       282
        
             example = "poweroff.target";

     

       283
       +
             description = lib.mdDoc ''

     

       284
        
               Target that should be started when Ctrl-Alt-Delete is pressed.

     

       285
        
             '';

     

       286
        
           };

     
···

       289
        
             type = with types; attrsOf (nullOr (oneOf [ str path package ]));

     

       290
        
             default = {};

     

       291
        
             example = { TZ = "CET"; };

     

       292
       +
             description = lib.mdDoc ''

     

       293
       +
               Environment variables passed to *all* systemd units.

     

       294
        
             '';

     

       295
        
           };

     

       296
        
       

     
···

       298
        
             type = with types; attrsOf (nullOr (oneOf [ str path package ]));

     

       299
        
             default = {};

     

       300
        
             example = { SYSTEMD_LOG_LEVEL = "debug"; };

     

       301
       +
             description = lib.mdDoc ''

     

       302
        
               Environment variables of PID 1. These variables are

     

       303
       +
               *not* passed to started units.

     

       304
        
             '';

     

       305
        
           };

     

       306
        
       

     

       307
        
           systemd.enableCgroupAccounting = mkOption {

     

       308
        
             default = true;

     

       309
        
             type = types.bool;

     

       310
       +
             description = lib.mdDoc ''

     

       311
        
               Whether to enable cgroup accounting.

     

       312
        
             '';

     

       313
        
           };

     
···

       315
        
           systemd.enableUnifiedCgroupHierarchy = mkOption {

     

       316
        
             default = true;

     

       317
        
             type = types.bool;

     

       318
       +
             description = lib.mdDoc ''

     

       319
        
               Whether to enable the unified cgroup hierarchy (cgroupsv2).

     

       320
        
             '';

     

       321
        
           };

     
···

       324
        
             default = "";

     

       325
        
             type = types.lines;

     

       326
        
             example = "DefaultLimitCORE=infinity";

     

       327
       +
             description = lib.mdDoc ''

     

       328
        
               Extra config options for systemd. See man systemd-system.conf for

     

       329
        
               available options.

     

       330
        
             '';

     
···

       334
        
             default = "";

     

       335
        
             type = types.lines;

     

       336
        
             example = "HibernateDelaySec=1h";

     

       337
       +
             description = lib.mdDoc ''

     

       338
        
               Extra config options for systemd sleep state logic.

     

       339
        
               See sleep.conf.d(5) man page for available options.

     

       340
        
             '';

     
···

       344
        
             default = [ ];

     

       345
        
             type = types.listOf types.str;

     

       346
        
             example = [ "debug-shell.service" "systemd-quotacheck.service" ];

     

       347
       +
             description = lib.mdDoc ''

     

       348
        
               Additional units shipped with systemd that shall be enabled.

     

       349
        
             '';

     

       350
        
           };

     
···

       353
        
             default = [ ];

     

       354
        
             type = types.listOf types.str;

     

       355
        
             example = [ "systemd-backlight@.service" ];

     

       356
       +
             description = lib.mdDoc ''

     

       357
        
               A list of units to skip when generating system systemd configuration directory. This has

     

       358
       +
               priority over upstream units, {option}`systemd.units`, and

     

       359
       +
               {option}`systemd.additionalUpstreamSystemUnits`. The main purpose of this is to

     

       360
        
               prevent a upstream systemd unit from being added to the initrd with any modifications made to it

     

       361
        
               by other NixOS modules.

     

       362
        
             '';

     
···

       366
        
             type = types.nullOr types.path;

     

       367
        
             default = null;

     

       368
        
             example = "/dev/watchdog";

     

       369
       +
             description = lib.mdDoc ''

     

       370
        
               The path to a hardware watchdog device which will be managed by systemd.

     

       371
        
               If not specified, systemd will default to /dev/watchdog.

     

       372
        
             '';

     
···

       376
        
             type = types.nullOr types.str;

     

       377
        
             default = null;

     

       378
        
             example = "30s";

     

       379
       +
             description = lib.mdDoc ''

     

       380
        
               The amount of time which can elapse before a watchdog hardware device

     

       381
        
               will automatically reboot the system. Valid time units include "ms",

     

       382
        
               "s", "min", "h", "d", and "w".

     
···

       387
        
             type = types.nullOr types.str;

     

       388
        
             default = null;

     

       389
        
             example = "10m";

     

       390
       +
             description = lib.mdDoc ''

     

       391
        
               The amount of time which can elapse after a reboot has been triggered

     

       392
        
               before a watchdog hardware device will automatically reboot the system.

     

       393
        
               Valid time units include "ms", "s", "min", "h", "d", and "w".

     
···

       398
        
             type = types.nullOr types.str;

     

       399
        
             default = null;

     

       400
        
             example = "10m";

     

       401
       +
             description = lib.mdDoc ''

     

       402
        
               The amount of time which can elapse when kexec is being executed before

     

       403
        
               a watchdog hardware device will automatically reboot the system. This

     

       404
        
               option should only be enabled if reloadTime is also enabled. Valid

+20 -20

nixos/modules/system/boot/systemd/initrd.nix

···

       150
        
           };

     

       151
        
       

     

       152
        
           contents = mkOption {

     

       153
       -
             description = "Set of files that have to be linked into the initrd";

     

       154
        
             example = literalExpression ''

     

       155
        
               {

     

       156
        
                 "/etc/hostname".text = "mymachine";

     
···

       162
        
           };

     

       163
        
       

     

       164
        
           storePaths = mkOption {

     

       165
       -
             description = ''

     

       166
        
               Store paths to copy into the initrd as well.

     

       167
        
             '';

     

       168
        
             type = with types; listOf (oneOf [ singleLineStr package ]);

     
···

       170
        
           };

     

       171
        
       

     

       172
        
           extraBin = mkOption {

     

       173
       -
             description = ''

     

       174
        
               Tools to add to /bin

     

       175
        
             '';

     

       176
        
             example = literalExpression ''

     
···

       183
        
           };

     

       184
        
       

     

       185
        
           suppressedStorePaths = mkOption {

     

       186
       -
             description = ''

     

       187
        
               Store paths specified in the storePaths option that

     

       188
        
               should not be copied.

     

       189
        
             '';

     
···

       194
        
           emergencyAccess = mkOption {

     

       195
        
             type = with types; oneOf [ bool singleLineStr ];

     

       196
        
             visible = false;

     

       197
       -
             description = ''

     

       198
        
               Set to true for unauthenticated emergency access, and false for

     

       199
        
               no emergency access.

     

       200
        
       

     
···

       208
        
             type = types.listOf types.package;

     

       209
        
             default = [];

     

       210
        
             visible = false;

     

       211
       -
             description = ''

     

       212
        
               Packages to include in /bin for the stage 1 emergency shell.

     

       213
        
             '';

     

       214
        
           };

     
···

       218
        
             type = types.listOf types.str;

     

       219
        
             visible = false;

     

       220
        
             example = [ "debug-shell.service" "systemd-quotacheck.service" ];

     

       221
       -
             description = ''

     

       222
        
               Additional units shipped with systemd that shall be enabled.

     

       223
        
             '';

     

       224
        
           };

     
···

       228
        
             type = types.listOf types.str;

     

       229
        
             example = [ "systemd-backlight@.service" ];

     

       230
        
             visible = false;

     

       231
       -
             description = ''

     

       232
        
               A list of units to skip when generating system systemd configuration directory. This has

     

       233
       -
               priority over upstream units, <option>boot.initrd.systemd.units</option>, and

     

       234
       -
               <option>boot.initrd.systemd.additionalUpstreamUnits</option>. The main purpose of this is to

     

       235
        
               prevent a upstream systemd unit from being added to the initrd with any modifications made to it

     

       236
        
               by other NixOS modules.

     

       237
        
             '';

     

       238
        
           };

     

       239
        
       

     

       240
        
           units = mkOption {

     

       241
       -
             description = "Definition of systemd units.";

     

       242
        
             default = {};

     

       243
        
             visible = false;

     

       244
        
             type = systemdUtils.types.units;

     
···

       249
        
             visible = false;

     

       250
        
             type = types.listOf types.package;

     

       251
        
             example = literalExpression "[ pkgs.systemd-cryptsetup-generator ]";

     

       252
       -
             description = "Packages providing systemd units and hooks.";

     

       253
        
           };

     

       254
        
       

     

       255
        
           targets = mkOption {

     

       256
        
             default = {};

     

       257
        
             visible = false;

     

       258
        
             type = systemdUtils.types.initrdTargets;

     

       259
       -
             description = "Definition of systemd target units.";

     

       260
        
           };

     

       261
        
       

     

       262
        
           services = mkOption {

     

       263
        
             default = {};

     

       264
        
             type = systemdUtils.types.initrdServices;

     

       265
        
             visible = false;

     

       266
       -
             description = "Definition of systemd service units.";

     

       267
        
           };

     

       268
        
       

     

       269
        
           sockets = mkOption {

     

       270
        
             default = {};

     

       271
        
             type = systemdUtils.types.initrdSockets;

     

       272
        
             visible = false;

     

       273
       -
             description = "Definition of systemd socket units.";

     

       274
        
           };

     

       275
        
       

     

       276
        
           timers = mkOption {

     

       277
        
             default = {};

     

       278
        
             type = systemdUtils.types.initrdTimers;

     

       279
        
             visible = false;

     

       280
       -
             description = "Definition of systemd timer units.";

     

       281
        
           };

     

       282
        
       

     

       283
        
           paths = mkOption {

     

       284
        
             default = {};

     

       285
        
             type = systemdUtils.types.initrdPaths;

     

       286
        
             visible = false;

     

       287
       -
             description = "Definition of systemd path units.";

     

       288
        
           };

     

       289
        
       

     

       290
        
           mounts = mkOption {

     

       291
        
             default = [];

     

       292
        
             type = systemdUtils.types.initrdMounts;

     

       293
        
             visible = false;

     

       294
       -
             description = ''

     

       295
        
               Definition of systemd mount units.

     

       296
        
               This is a list instead of an attrSet, because systemd mandates the names to be derived from

     

       297
        
               the 'where' attribute.

     
···

       302
        
             default = [];

     

       303
        
             type = systemdUtils.types.automounts;

     

       304
        
             visible = false;

     

       305
       -
             description = ''

     

       306
        
               Definition of systemd automount units.

     

       307
        
               This is a list instead of an attrSet, because systemd mandates the names to be derived from

     

       308
        
               the 'where' attribute.

     
···

       313
        
             default = {};

     

       314
        
             type = systemdUtils.types.slices;

     

       315
        
             visible = false;

     

       316
       -
             description = "Definition of slice configurations.";

     

       317
        
           };

     

       318
        
         };

     

       319

···

       150
        
           };

     

       151
        
       

     

       152
        
           contents = mkOption {

     

       153
       +
             description = lib.mdDoc "Set of files that have to be linked into the initrd";

     

       154
        
             example = literalExpression ''

     

       155
        
               {

     

       156
        
                 "/etc/hostname".text = "mymachine";

     
···

       162
        
           };

     

       163
        
       

     

       164
        
           storePaths = mkOption {

     

       165
       +
             description = lib.mdDoc ''

     

       166
        
               Store paths to copy into the initrd as well.

     

       167
        
             '';

     

       168
        
             type = with types; listOf (oneOf [ singleLineStr package ]);

     
···

       170
        
           };

     

       171
        
       

     

       172
        
           extraBin = mkOption {

     

       173
       +
             description = lib.mdDoc ''

     

       174
        
               Tools to add to /bin

     

       175
        
             '';

     

       176
        
             example = literalExpression ''

     
···

       183
        
           };

     

       184
        
       

     

       185
        
           suppressedStorePaths = mkOption {

     

       186
       +
             description = lib.mdDoc ''

     

       187
        
               Store paths specified in the storePaths option that

     

       188
        
               should not be copied.

     

       189
        
             '';

     
···

       194
        
           emergencyAccess = mkOption {

     

       195
        
             type = with types; oneOf [ bool singleLineStr ];

     

       196
        
             visible = false;

     

       197
       +
             description = lib.mdDoc ''

     

       198
        
               Set to true for unauthenticated emergency access, and false for

     

       199
        
               no emergency access.

     

       200
        
       

     
···

       208
        
             type = types.listOf types.package;

     

       209
        
             default = [];

     

       210
        
             visible = false;

     

       211
       +
             description = lib.mdDoc ''

     

       212
        
               Packages to include in /bin for the stage 1 emergency shell.

     

       213
        
             '';

     

       214
        
           };

     
···

       218
        
             type = types.listOf types.str;

     

       219
        
             visible = false;

     

       220
        
             example = [ "debug-shell.service" "systemd-quotacheck.service" ];

     

       221
       +
             description = lib.mdDoc ''

     

       222
        
               Additional units shipped with systemd that shall be enabled.

     

       223
        
             '';

     

       224
        
           };

     
···

       228
        
             type = types.listOf types.str;

     

       229
        
             example = [ "systemd-backlight@.service" ];

     

       230
        
             visible = false;

     

       231
       +
             description = lib.mdDoc ''

     

       232
        
               A list of units to skip when generating system systemd configuration directory. This has

     

       233
       +
               priority over upstream units, {option}`boot.initrd.systemd.units`, and

     

       234
       +
               {option}`boot.initrd.systemd.additionalUpstreamUnits`. The main purpose of this is to

     

       235
        
               prevent a upstream systemd unit from being added to the initrd with any modifications made to it

     

       236
        
               by other NixOS modules.

     

       237
        
             '';

     

       238
        
           };

     

       239
        
       

     

       240
        
           units = mkOption {

     

       241
       +
             description = lib.mdDoc "Definition of systemd units.";

     

       242
        
             default = {};

     

       243
        
             visible = false;

     

       244
        
             type = systemdUtils.types.units;

     
···

       249
        
             visible = false;

     

       250
        
             type = types.listOf types.package;

     

       251
        
             example = literalExpression "[ pkgs.systemd-cryptsetup-generator ]";

     

       252
       +
             description = lib.mdDoc "Packages providing systemd units and hooks.";

     

       253
        
           };

     

       254
        
       

     

       255
        
           targets = mkOption {

     

       256
        
             default = {};

     

       257
        
             visible = false;

     

       258
        
             type = systemdUtils.types.initrdTargets;

     

       259
       +
             description = lib.mdDoc "Definition of systemd target units.";

     

       260
        
           };

     

       261
        
       

     

       262
        
           services = mkOption {

     

       263
        
             default = {};

     

       264
        
             type = systemdUtils.types.initrdServices;

     

       265
        
             visible = false;

     

       266
       +
             description = lib.mdDoc "Definition of systemd service units.";

     

       267
        
           };

     

       268
        
       

     

       269
        
           sockets = mkOption {

     

       270
        
             default = {};

     

       271
        
             type = systemdUtils.types.initrdSockets;

     

       272
        
             visible = false;

     

       273
       +
             description = lib.mdDoc "Definition of systemd socket units.";

     

       274
        
           };

     

       275
        
       

     

       276
        
           timers = mkOption {

     

       277
        
             default = {};

     

       278
        
             type = systemdUtils.types.initrdTimers;

     

       279
        
             visible = false;

     

       280
       +
             description = lib.mdDoc "Definition of systemd timer units.";

     

       281
        
           };

     

       282
        
       

     

       283
        
           paths = mkOption {

     

       284
        
             default = {};

     

       285
        
             type = systemdUtils.types.initrdPaths;

     

       286
        
             visible = false;

     

       287
       +
             description = lib.mdDoc "Definition of systemd path units.";

     

       288
        
           };

     

       289
        
       

     

       290
        
           mounts = mkOption {

     

       291
        
             default = [];

     

       292
        
             type = systemdUtils.types.initrdMounts;

     

       293
        
             visible = false;

     

       294
       +
             description = lib.mdDoc ''

     

       295
        
               Definition of systemd mount units.

     

       296
        
               This is a list instead of an attrSet, because systemd mandates the names to be derived from

     

       297
        
               the 'where' attribute.

     
···

       302
        
             default = [];

     

       303
        
             type = systemdUtils.types.automounts;

     

       304
        
             visible = false;

     

       305
       +
             description = lib.mdDoc ''

     

       306
        
               Definition of systemd automount units.

     

       307
        
               This is a list instead of an attrSet, because systemd mandates the names to be derived from

     

       308
        
               the 'where' attribute.

     
···

       313
        
             default = {};

     

       314
        
             type = systemdUtils.types.slices;

     

       315
        
             visible = false;

     

       316
       +
             description = lib.mdDoc "Definition of slice configurations.";

     

       317
        
           };

     

       318
        
         };

     

       319

+5 -5

nixos/modules/system/boot/tmp.nix

···

       14
        
           boot.cleanTmpDir = mkOption {

     

       15
        
             type = types.bool;

     

       16
        
             default = false;

     

       17
       -
             description = ''

     

       18
       -
               Whether to delete all files in <filename>/tmp</filename> during boot.

     

       19
        
             '';

     

       20
        
           };

     

       21
        
       

     

       22
        
           boot.tmpOnTmpfs = mkOption {

     

       23
        
             type = types.bool;

     

       24
        
             default = false;

     

       25
       -
             description = ''

     

       26
       -
                Whether to mount a tmpfs on <filename>/tmp</filename> during boot.

     

       27
        
             '';

     

       28
        
           };

     

       29
        
       

     

       30
        
           boot.tmpOnTmpfsSize = mkOption {

     

       31
        
             type = types.oneOf [ types.str types.types.ints.positive ];

     

       32
        
             default = "50%";

     

       33
       -
             description = ''

     

       34
        
               Size of tmpfs in percentage.

     

       35
        
               Percentage is defined by systemd.

     

       36
        
             '';

···

       14
        
           boot.cleanTmpDir = mkOption {

     

       15
        
             type = types.bool;

     

       16
        
             default = false;

     

       17
       +
             description = lib.mdDoc ''

     

       18
       +
               Whether to delete all files in {file}`/tmp` during boot.

     

       19
        
             '';

     

       20
        
           };

     

       21
        
       

     

       22
        
           boot.tmpOnTmpfs = mkOption {

     

       23
        
             type = types.bool;

     

       24
        
             default = false;

     

       25
       +
             description = lib.mdDoc ''

     

       26
       +
                Whether to mount a tmpfs on {file}`/tmp` during boot.

     

       27
        
             '';

     

       28
        
           };

     

       29
        
       

     

       30
        
           boot.tmpOnTmpfsSize = mkOption {

     

       31
        
             type = types.oneOf [ types.str types.types.ints.positive ];

     

       32
        
             default = "50%";

     

       33
       +
             description = lib.mdDoc ''

     

       34
        
               Size of tmpfs in percentage.

     

       35
        
               Percentage is defined by systemd.

     

       36
        
             '';

+15 -15

nixos/modules/system/etc/etc.nix

···

       82
        
                 "default/useradd".text = "GROUP=100 ...";

     

       83
        
               }

     

       84
        
             '';

     

       85
       -
             description = ''

     

       86
       -
               Set of files that have to be linked in <filename>/etc</filename>.

     

       87
        
             '';

     

       88
        
       

     

       89
        
             type = with types; attrsOf (submodule (

     
···

       93
        
                   enable = mkOption {

     

       94
        
                     type = types.bool;

     

       95
        
                     default = true;

     

       96
       -
                     description = ''

     

       97
        
                       Whether this /etc file should be generated.  This

     

       98
        
                       option allows specific /etc files to be disabled.

     

       99
        
                     '';

     
···

       101
        
       

     

       102
        
                   target = mkOption {

     

       103
        
                     type = types.str;

     

       104
       -
                     description = ''

     

       105
        
                       Name of symlink (relative to

     

       106
       -
                       <filename>/etc</filename>).  Defaults to the attribute

     

       107
        
                       name.

     

       108
        
                     '';

     

       109
        
                   };

     
···

       111
        
                   text = mkOption {

     

       112
        
                     default = null;

     

       113
        
                     type = types.nullOr types.lines;

     

       114
       -
                     description = "Text of the file.";

     

       115
        
                   };

     

       116
        
       

     

       117
        
                   source = mkOption {

     

       118
        
                     type = types.path;

     

       119
       -
                     description = "Path of the source file.";

     

       120
        
                   };

     

       121
        
       

     

       122
        
                   mode = mkOption {

     

       123
        
                     type = types.str;

     

       124
        
                     default = "symlink";

     

       125
        
                     example = "0600";

     

       126
       -
                     description = ''

     

       127
       -
                       If set to something else than <literal>symlink</literal>,

     

       128
        
                       the file is copied instead of symlinked, with the given

     

       129
        
                       file mode.

     

       130
        
                     '';

     
···

       133
        
                   uid = mkOption {

     

       134
        
                     default = 0;

     

       135
        
                     type = types.int;

     

       136
       -
                     description = ''

     

       137
        
                       UID of created file. Only takes effect when the file is

     

       138
        
                       copied (that is, the mode is not 'symlink').

     

       139
        
                       '';

     
···

       142
        
                   gid = mkOption {

     

       143
        
                     default = 0;

     

       144
        
                     type = types.int;

     

       145
       -
                     description = ''

     

       146
        
                       GID of created file. Only takes effect when the file is

     

       147
        
                       copied (that is, the mode is not 'symlink').

     

       148
        
                     '';

     
···

       151
        
                   user = mkOption {

     

       152
        
                     default = "+${toString config.uid}";

     

       153
        
                     type = types.str;

     

       154
       -
                     description = ''

     

       155
        
                       User name of created file.

     

       156
        
                       Only takes effect when the file is copied (that is, the mode is not 'symlink').

     

       157
       -
                       Changing this option takes precedence over <literal>uid</literal>.

     

       158
        
                     '';

     

       159
        
                   };

     

       160
        
       

     

       161
        
                   group = mkOption {

     

       162
        
                     default = "+${toString config.gid}";

     

       163
        
                     type = types.str;

     

       164
       -
                     description = ''

     

       165
        
                       Group name of created file.

     

       166
        
                       Only takes effect when the file is copied (that is, the mode is not 'symlink').

     

       167
       -
                       Changing this option takes precedence over <literal>gid</literal>.

     

       168
        
                     '';

     

       169
        
                   };

     

       170

···

       82
        
                 "default/useradd".text = "GROUP=100 ...";

     

       83
        
               }

     

       84
        
             '';

     

       85
       +
             description = lib.mdDoc ''

     

       86
       +
               Set of files that have to be linked in {file}`/etc`.

     

       87
        
             '';

     

       88
        
       

     

       89
        
             type = with types; attrsOf (submodule (

     
···

       93
        
                   enable = mkOption {

     

       94
        
                     type = types.bool;

     

       95
        
                     default = true;

     

       96
       +
                     description = lib.mdDoc ''

     

       97
        
                       Whether this /etc file should be generated.  This

     

       98
        
                       option allows specific /etc files to be disabled.

     

       99
        
                     '';

     
···

       101
        
       

     

       102
        
                   target = mkOption {

     

       103
        
                     type = types.str;

     

       104
       +
                     description = lib.mdDoc ''

     

       105
        
                       Name of symlink (relative to

     

       106
       +
                       {file}`/etc`).  Defaults to the attribute

     

       107
        
                       name.

     

       108
        
                     '';

     

       109
        
                   };

     
···

       111
        
                   text = mkOption {

     

       112
        
                     default = null;

     

       113
        
                     type = types.nullOr types.lines;

     

       114
       +
                     description = lib.mdDoc "Text of the file.";

     

       115
        
                   };

     

       116
        
       

     

       117
        
                   source = mkOption {

     

       118
        
                     type = types.path;

     

       119
       +
                     description = lib.mdDoc "Path of the source file.";

     

       120
        
                   };

     

       121
        
       

     

       122
        
                   mode = mkOption {

     

       123
        
                     type = types.str;

     

       124
        
                     default = "symlink";

     

       125
        
                     example = "0600";

     

       126
       +
                     description = lib.mdDoc ''

     

       127
       +
                       If set to something else than `symlink`,

     

       128
        
                       the file is copied instead of symlinked, with the given

     

       129
        
                       file mode.

     

       130
        
                     '';

     
···

       133
        
                   uid = mkOption {

     

       134
        
                     default = 0;

     

       135
        
                     type = types.int;

     

       136
       +
                     description = lib.mdDoc ''

     

       137
        
                       UID of created file. Only takes effect when the file is

     

       138
        
                       copied (that is, the mode is not 'symlink').

     

       139
        
                       '';

     
···

       142
        
                   gid = mkOption {

     

       143
        
                     default = 0;

     

       144
        
                     type = types.int;

     

       145
       +
                     description = lib.mdDoc ''

     

       146
        
                       GID of created file. Only takes effect when the file is

     

       147
        
                       copied (that is, the mode is not 'symlink').

     

       148
        
                     '';

     
···

       151
        
                   user = mkOption {

     

       152
        
                     default = "+${toString config.uid}";

     

       153
        
                     type = types.str;

     

       154
       +
                     description = lib.mdDoc ''

     

       155
        
                       User name of created file.

     

       156
        
                       Only takes effect when the file is copied (that is, the mode is not 'symlink').

     

       157
       +
                       Changing this option takes precedence over `uid`.

     

       158
        
                     '';

     

       159
        
                   };

     

       160
        
       

     

       161
        
                   group = mkOption {

     

       162
        
                     default = "+${toString config.gid}";

     

       163
        
                     type = types.str;

     

       164
       +
                     description = lib.mdDoc ''

     

       165
        
                       Group name of created file.

     

       166
        
                       Only takes effect when the file is copied (that is, the mode is not 'symlink').

     

       167
       +
                       Changing this option takes precedence over `gid`.

     

       168
        
                     '';

     

       169
        
                   };

     

       170