Additional arguments passed to each module in addition to ones like lib, config, and pkgs, modulesPath.

This option is also available to all submodules. Submodules do not inherit args from their parent module, nor do they provide args to their parent module or sibling submodules. The sole exception to this is the argument name which is provided by parent modules to a submodule and contains the attribute name the submodule is bound to, or a unique generated name if it is not bound to an attribute.

Some arguments are already passed by default, of which the following cannot be changed with this option:

• lib: The nixpkgs library.

• config: The results of all options after merging the values from all modules together.

• options: The options declared in all modules.

• specialArgs: The specialArgs argument passed to evalModules.

• All attributes of specialArgs

  Whereas option values can generally depend on other option values thanks to laziness, this does not apply to imports, which must be computed statically before anything else.

  For this reason, callers of the module system can provide specialArgs which are available during import resolution.

  For NixOS, specialArgs includes modulesPath, which allows you to import extra modules from the nixpkgs package tree without having to somehow make the module aware of the location of the nixpkgs or NixOS directories.

  { modulesPath, ... }: {
    imports = [
      (modulesPath + "/profiles/minimal.nix")
    ];
  }
  

For NixOS, the default value for this option includes at least this argument:

• pkgs: The nixpkgs package set according to the nixpkgs.pkgs option.

The kernel console loglevel. All Kernel Messages with a log level smaller than this setting will be printed to the console.

Size limit for the /dev/shm tmpfs. Look at mount(8), tmpfs size option, for the accepted syntax.

Size limit for the /dev tmpfs. Look at mount(8), tmpfs size option, for the accepted syntax.

A list of additional packages supplying kernel modules.

List of available backends.

Executable that stage 2 will hand off to as PID 1.

Extra files required by the init system, passed directly to environment.etc and uses the same syntax.

Whether this /etc file should be generated. This option allows specific /etc files to be disabled.

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

Group name of file owner.

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

When services.userborn.enable, this option has no effect. You have to assign a gid instead. Otherwise this option takes precedence over gid.

If set to something else than symlink, the file is copied instead of symlinked, with the given file mode.

Path of the source file.

Name of symlink (relative to /etc). Defaults to the attribute name.

Text of the file.

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

User name of file owner.

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

When services.userborn.enable, this option has no effect. You have to assign a uid instead. Otherwise this option takes precedence over uid.

Name of the init backend used after stage-2 activation.

Packages which are required for the backend to function.

Function which takes config.micros.services as an input and outputs files to be appended to environment.etc.

Extra features offered by the init backend, e.g. dependency management

Init backend used after stage-2 activation has completed.

Executable that stage 2 will hand off to as PID 1.

Extra files required by the init system, passed directly to environment.etc and uses the same syntax.

Whether this /etc file should be generated. This option allows specific /etc files to be disabled.

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

Group name of file owner.

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

When services.userborn.enable, this option has no effect. You have to assign a gid instead. Otherwise this option takes precedence over gid.

If set to something else than symlink, the file is copied instead of symlinked, with the given file mode.

Path of the source file.

Name of symlink (relative to /etc). Defaults to the attribute name.

Text of the file.

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

User name of file owner.

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

When services.userborn.enable, this option has no effect. You have to assign a uid instead. Otherwise this option takes precedence over uid.

Name of the init backend used after stage-2 activation.

Packages which are required for the backend to function.

Function which takes config.micros.services as an input and outputs files to be appended to environment.etc.

Extra features offered by the init backend, e.g. dependency management

Executable that stage 2 will hand off to as PID 1.

PATH value used by stage 2 before handing off to the init backend.

Whether to enable initrd.

Whether the initrd can be built even though modules listed in boot.initrd.kernelModules or boot.initrd.availableKernelModules are missing from the kernel. This is useful when combining configurations that include a lot of modules, such as hardware.enableAllHardware, with kernels that don't provide as many modules as typical NixOS kernels.

Note that enabling this is discouraged. Instead, try disabling individual modules by setting e.g. boot.initrd.availableKernelModules.foo = lib.mkForce false;

The set of kernel modules in the initial ramdisk used during the boot process. This set must include all modules necessary for mounting the root device. That is, it should include modules for the physical device (e.g., SCSI drivers) and for the file system (e.g., ext3). The set specified here is automatically closed under the module dependency relation, i.e., all dependencies of the modules list here are included automatically. The modules listed here are available in the initrd, but are only loaded on demand (e.g., the ext3 module is loaded automatically when an ext3 filesystem is mounted, and modules for PCI devices are loaded when they match the PCI ID of a device in your system). To force a module to be loaded, include it in boot.initrd.kernelModules.

This can either be a list of modules, or an attrset. In an attrset, names that are set to true represent modules that will be included. Note that setting these names to false does not prevent the module from being loaded. For that, use boot.blacklistedKernelModules.

The compressor to use on the initrd image. May be any of:

• The name of one of the predefined compressors, see pkgs/build-support/kernel/initrd-compressor-meta.nix for the definitions.
• A function which, given the nixpkgs package set, returns the path to a compressor tool, e.g. pkgs: "${pkgs.pigz}/bin/pigz"
• (not recommended, because it does not work when cross-compiling) the full path to a compressor tool, e.g. "${pkgs.pigz}/bin/pigz"

The given program should read data from stdin and write it to stdout compressed.

Arguments to pass to the compressor for the initrd image, or null to use the compressor's defaults.

This option, if set, adds a collection of default kernel modules to boot.initrd.availableKernelModules and boot.initrd.kernelModules.

Set of modules that are always loaded by the initrd.

This can either be a list of modules, or an attrset. In an attrset, names that are set to true represent modules that will be included. Note that setting these names to false does not prevent the module from being loaded. For that, use boot.blacklistedKernelModules.

Whether the image is a container.

Whether to enable the Linux kernel. This is useful for systemd-like containers which do not require a kernel.

Provides a custom seed for the RANDSTRUCT security option of the Linux kernel. Note that RANDSTRUCT is only enabled in NixOS hardened kernels. Using a custom seed requires building the kernel and dependent packages locally, since this customization happens at build time.

Runtime parameters of the Linux kernel, as set by sysctl(8). Note that sysctl parameters names must be enclosed in quotes (e.g. "vm.swappiness" instead of vm.swappiness). The value of each parameter may be a string, integer, boolean, or null (signifying the option will not appear at all).

The maximum receive socket buffer size in bytes. In case of conflicting values, the highest will be used.

The maximum send socket buffer size in bytes. In case of conflicting values, the highest will be used.

The set of kernel modules to be loaded in the second stage of the boot process. Note that modules that are needed to mount the root file system should be added to boot.initrd.availableKernelModules or boot.initrd.kernelModules.

This can either be a list of modules, or an attrset. In an attrset, names that are set to true represent modules that will be included. Note that setting these names to false does not prevent the module from being loaded. For that, use boot.blacklistedKernelModules.

This option allows you to override the Linux kernel used by NixOS. Since things like external kernel module packages are tied to the kernel you're using, it also overrides those. This option is a function that takes Nixpkgs as an argument (as a convenience), and returns an attribute set containing at the very least an attribute kernel. Additional attributes may be needed depending on your configuration. For instance, if you use the NVIDIA X driver, then it also needs to contain an attribute nvidia_x11.

Please note that we strictly support kernel versions that are maintained by the Linux developers only. More information on the availability of kernel versions is documented in the Linux section of the manual.

Parameters added to the kernel command line.

A list of additional patches to apply to the kernel.

Every item should be an attribute set with the following attributes:

{
  name = "foo";                 # descriptive name, required

  patch = ./foo.patch;          # path or derivation that contains the patch source
                                # (required, but can be null if only config changes
                                # are needed)

  structuredExtraConfig = {     # attrset of extra configuration parameters without the CONFIG_ prefix
    FOO = lib.kernel.yes;       # (optional)
  };                            # values should generally be lib.kernel.yes,
                                # lib.kernel.no or lib.kernel.module

  features = {                  # attrset of extra "features" the kernel is considered to have
    foo = true;                 # (may be checked by other NixOS modules, optional)
  };

  extraConfig = "FOO y";        # extra configuration options in string form without the CONFIG_ prefix
                                # (optional, multiple lines allowed to specify multiple options)
                                # (deprecated, use structuredExtraConfig instead)
}

There's a small set of existing kernel patches in Nixpkgs, available as pkgs.kernelPatches, that follow this format and can be used directly.

Size limit for the /run tmpfs. Look at mount(8), tmpfs size option, for the accepted syntax.

Whether to enable the filesystem mount.

List of paths that should be mounted before this one. This filesystem's device and mountPoint are always checked and do not need to be included explicitly. If a path is added to this list, any other filesystem whose mount point is a parent of the path will be mounted before this filesystem. The paths do not need to actually be the mountPoint of some other filesystem.

Location of the device.

Type of the file system.

Location of the mounted file system.

Whether to mount filesystem in Stage 1

Options used to mount the file system.

UUID of the stratis pool that the fs is located in

Names of supported filesystem types, or an attribute set of file system types and their state. The set form may be used together with lib.mkForce to explicitly disable support for specific filesystems, e.g. to disable ZFS with an unsupported kernel.

The shell executable that is linked system-wide to /bin/sh.

Set of files that have to be linked in /etc.

Whether this /etc file should be generated. This option allows specific /etc files to be disabled.

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

Group name of file owner.

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

When services.userborn.enable, this option has no effect. You have to assign a gid instead. Otherwise this option takes precedence over gid.

If set to something else than symlink, the file is copied instead of symlinked, with the given file mode.

Path of the source file.

Name of symlink (relative to /etc). Defaults to the attribute name.

Text of the file.

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

User name of file owner.

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

When services.userborn.enable, this option has no effect. You have to assign a uid instead. Otherwise this option takes precedence over uid.

Shell script code called during global environment initialisation after all variables and profileVariables have been set. This code is assumed to be shell-independent, which means you should stick to pure sh without sh word split.

List of additional package outputs to be symlinked into /run/current-system/sw.

Shell fragments to be run after the system environment has been created.

This should only be used for things that need to modify the internals of the environment, e.g. generating MIME caches. The environment being built can be accessed at $out.

List of directories to be symlinked in /run/current-system/sw

The set of packages that appear in /run/current-system/sw.

These packages are automatically available to all users, and are automatically updated every time you rebuild the system configuration. (The latter is the main difference with installing them in the default profile, /nix/var/nix/profiles/default.

The file systems to be mounted. It must include an entry for the root directory (mountPoint = "/"). Each entry in the list is an attribute set with the following fields: mountPoint, device, fsType (a file system type recognised by mount; defaults to "auto"), and options (the mount options passed to mount using the -o flag; defaults to [ "defaults" ]).

Instead of specifying device, you can also specify a volume label (label) for file systems that support it, such as ext2/ext3 (see mke2fs -L).

Whether to enable the filesystem mount.

If the device does not currently contain a filesystem (as determined by blkid), then automatically format it with the filesystem type specified in fsType. Use with caution.

If set, the filesystem is grown to its maximum size before being mounted. (This is typically the size of the containing partition.) This is currently only supported for ext2/3/4 filesystems that are mounted during early boot.

List of paths that should be mounted before this one. This filesystem's device and mountPoint are always checked and do not need to be included explicitly. If a path is added to this list, any other filesystem whose mount point is a parent of the path will be mounted before this filesystem. The paths do not need to actually be the mountPoint of some other filesystem.

Location of the device.

Type of the file system.

Label of the device (if any).

Location of the mounted file system.

Whether to mount filesystem in Stage 1

Disable running fsck on this filesystem.

Options used to mount the file system.

UUID of the stratis pool that the fs is located in

Attrset of groups.

The group GID. If the GID is null, a free GID is picked on activation.

The user names of the group members, added to the /etc/group file.

The name of the group. If undefined, the name of the attribute set will be used.

Firmware packages