Whether to enable the validation of bootspec documents for each build. This will introduce Go in the build-time closure as we are relying on Cuelang for schema validation. Enable this option if you want to ascertain that your documents are correct .

The package to use for bootspec.

User-defined data that extends the bootspec document.

To reduce incompatibility and prevent names from clashing between applications, it is highly recommended to use a unique namespace for your extensions.

A list of additional packages supplying kernel modules.

Executable run as stage-2 PID 1, symlinked as ${config.system.build.toplevel}/init.

Whether to enable the NixOS initial RAM disk (initrd). This may be needed to perform some initialisation tasks (like mounting network/encrypted file systems) before continuing the boot process.

the initrd to use for your system... use a module to build one

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.

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.

Contents of the initrd.

This option has no description.

This option has no description.

Set to true for unauthenticated emergency access to the initramfs rescue shell, and false or null for no access.

Can also be set to a hashed super user password to allow authenticated access to the rescue mode.

When access is denied, finix prints the failure reason on console and reboots after 10s instead of opening a shell.

Lines of shell commands that are run after coldbooting the device-manager and before mounting file-systems.

An attribute set of one-shot commands to run in sequence when entering a runlevel. run commands are guaranteed to be completed before running the next command. Useful when serialization is required.

See upstream documentation for additional details.

Whether to enable this stanza.

A directory name, resolved under /var/cache, created before the service starts and owned by its user and group. Absolute paths and .. are refused. The resolved path is exported to the process environment as $CACHE_DIRECTORY.

See upstream documentation for additional details.

The mode of cache-dir, locked down again on every start, default: 0755. Modes are octal, with the leading zero.

Allow services to run with minimal required privileges instead of running as root.

The cgroup to place this process under, keyed by the name of a top-level cgroup. delegate hands the subtree over to the service itself, for container runtimes like docker, podman, systemd-nspawn or lxc; every other key names a cgroup file.

See upstream documentation and kernel documentation for additional details.

The command to execute.

See upstream documentation for details.

A directory name, resolved under /etc, created before the service starts. Absolute paths and .. are refused. The resolved path is exported to the process environment as $CONFIGURATION_DIRECTORY.

As in systemd, config-dir is the odd one out: it is created but never chowned.

See upstream documentation for additional details.

The mode of config-dir, locked down again on every start, default: 0755. Modes are octal, with the leading zero.

If you have conflicting services and want to prevent them from starting.

A human-readable description of this service, displayed by initctl.

Either a path or a path prefixed with a '-' to indicate a missing file is fine.

Environment variables passed to this service.

A script which will be called when the service is removed.

A script which will be called before the service is started.

A script which will be called after the service has stopped.

Explicitly specify supplementary groups, in addition to reading group membership from /etc/group.

The group this service should be executed as.

The instance identifier, derived from the attribute name if it contains an @ character.

Only register this stanza when the given condition is asserted, or when the named service exists. Prefix with ! to invert.

See upstream documentation for details.

Redirect stderr and stdout of the application to a file or syslog using the native logit tool. This is useful for programs that do not support syslog on their own, which is sometimes the case when running in the foreground.

See upstream documentation for additional details.

A directory name, resolved under /var/log, created before the service starts and owned by its user and group. Absolute paths and .. are refused. The resolved path is exported to the process environment as $LOGS_DIRECTORY.

See upstream documentation for additional details.

The mode of logs-dir, locked down again on every start, default: 0755. Modes are octal, with the leading zero.

If a service should not be automatically started, it can be configured as manual. The service can then be started at any time by running initctl start <service>.

The name of this stanza, derived from the attribute name.

Packages added to the PATH environment variable of this service.

Order of this run command in relation to the others. The semantics are the same as with lib.mkOrder. Smaller values have a greater priority.

An arbitrary list of items such as derivations. If any item in the list changes between reconfigurations, the service will be reloaded or restarted if reloads are not supported.

By default, a run or task will re-run each time its runlevel is entered, and its exec-stop-post script does not run on completion.

With remain-after-exit, the task runs once and does not re-run on runlevel. The exec-stop-post script will run if the task is explicitly stopped or when the task leaves its valid runlevels.

Enable endless restarts without counting toward the retry limit. When set, the service will be restarted indefinitely regardless of the restart-max limit.

The number of times finit tries to restart a crashing service. When this limit is reached the service is marked crashed and must be restarted manually with initctl restart NAME. When null, finit's built-in default applies.

The number of seconds before Finit tries to restart a crashing service, default: 2 seconds for the first five retries, then back-off to 5 seconds. The maximum of this configured value and the above (2 and 5) will be used.

An attribute set of resource limits that will be apply by finit.

See upstream documentation for additional details.

See upstream documentation for details.

A directory name, resolved under /run, created before the service starts and owned by its user and group. Absolute paths and .. are refused. The resolved path is exported to the process environment as $RUNTIME_DIRECTORY.

Removed again when the service stops, after any exec-stop-post script has run, unless runtime-dir-preserve says otherwise.

See upstream documentation for additional details.

The mode of runtime-dir, locked down again on every start, default: 0755. Modes are octal, with the leading zero.

Whether runtime-dir survives the service stopping, the same values as systemd's RuntimeDirectoryPreserve=, default: false.

• false - removed when the service stops
• "restart" - kept across restarts, removed on a real stop
• true - never removed

Shell commands executed as the main process.

A directory name, resolved under /var/lib, created before the service starts and owned by its user and group. Absolute paths and .. are refused. The resolved path is exported to the process environment as $STATE_DIRECTORY.

See upstream documentation for additional details.

The mode of state-dir, locked down again on every start, default: 0755. Modes are octal, with the leading zero.

Give this stanza a controlling terminal on the given device, connecting its stdin, stdout, and stderr to the TTY. May be a device node like /dev/ttyS0 or the special keyword @console.

See upstream documentation for additional details.

The user this service should be executed as.

An attribute set of services, or daemons, to be monitored and automatically restarted if they exit prematurely.

See upstream documentation for additional details.

Whether to enable this stanza.

A directory name, resolved under /var/cache, created before the service starts and owned by its user and group. Absolute paths and .. are refused. The resolved path is exported to the process environment as $CACHE_DIRECTORY.

See upstream documentation for additional details.

The mode of cache-dir, locked down again on every start, default: 0755. Modes are octal, with the leading zero.

Allow services to run with minimal required privileges instead of running as root.

The cgroup to place this process under, keyed by the name of a top-level cgroup. delegate hands the subtree over to the service itself, for container runtimes like docker, podman, systemd-nspawn or lxc; every other key names a cgroup file.

See upstream documentation and kernel documentation for additional details.

The command to execute.

See upstream documentation for details.

A directory name, resolved under /etc, created before the service starts. Absolute paths and .. are refused. The resolved path is exported to the process environment as $CONFIGURATION_DIRECTORY.

As in systemd, config-dir is the odd one out: it is created but never chowned.

See upstream documentation for additional details.

The mode of config-dir, locked down again on every start, default: 0755. Modes are octal, with the leading zero.

If you have conflicting services and want to prevent them from starting.

A human-readable description of this service, displayed by initctl.

Either a path or a path prefixed with a '-' to indicate a missing file is fine.

Environment variables passed to this service.

A script which will be called when the service is removed.

Some services do not support SIGHUP but may have other ways to update the configuration of a running daemon. When exec-reload is defined it is preferred over SIGHUP. Like systemd, finit sets ``$MAINPIDas a convenience to scripts, which in effect also allow settingexec-reload` to `kill -HUP $MAINPID`.

A script which will be called before the service is started.

A script which will be called when the service is ready.

Some services may require alternate methods to be stopped. If exec-stop is defined it is preferred over SIGTERM. Similar to exec-reload, finit sets $MAINPID.

A script which will be called after the service has stopped.

Explicitly specify supplementary groups, in addition to reading group membership from /etc/group.

The group this service should be executed as.

The instance identifier, derived from the attribute name if it contains an @ character.

Only register this stanza when the given condition is asserted, or when the named service exists. Prefix with ! to invert.

See upstream documentation for details.

Redirect stderr and stdout of the application to a file or syslog using the native logit tool. This is useful for programs that do not support syslog on their own, which is sometimes the case when running in the foreground.

See upstream documentation for additional details.

A directory name, resolved under /var/log, created before the service starts and owned by its user and group. Absolute paths and .. are refused. The resolved path is exported to the process environment as $LOGS_DIRECTORY.

See upstream documentation for additional details.

The mode of logs-dir, locked down again on every start, default: 0755. Modes are octal, with the leading zero.

If a service should not be automatically started, it can be configured as manual. The service can then be started at any time by running initctl start <service>.

The name of this stanza, derived from the attribute name.

Set when the service does not handle SIGHUP. Sets reload-signal = "none".

When null the stanza inherits finit.readiness, cf. service.c.

See upstream documentation for details.

• reboot - when all retries have failed, and the service has crashed, if this option is set the system is rebooted.
• script - similarly, but instead of rebooting, call the exec-stop-post script if set.

Packages added to the PATH environment variable of this service.

See upstream documentation for details.

Signal finit sends to reload the service, or "none" when the service does not handle SIGHUP and must be stopped and started on reconfiguration instead.

See upstream documentation for details.

An arbitrary list of items such as derivations. If any item in the list changes between reconfigurations, the service will be reloaded or restarted if reloads are not supported.

Enable endless restarts without counting toward the retry limit. When set, the service will be restarted indefinitely regardless of the restart-max limit.

The number of times finit tries to restart a crashing service. When this limit is reached the service is marked crashed and must be restarted manually with initctl restart NAME. When null, finit's built-in default applies.

The number of seconds before Finit tries to restart a crashing service, default: 2 seconds for the first five retries, then back-off to 5 seconds. The maximum of this configured value and the above (2 and 5) will be used.

An attribute set of resource limits that will be apply by finit.

See upstream documentation for additional details.

See upstream documentation for details.

A directory name, resolved under /run, created before the service starts and owned by its user and group. Absolute paths and .. are refused. The resolved path is exported to the process environment as $RUNTIME_DIRECTORY.

Removed again when the service stops, after any exec-stop-post script has run, unless runtime-dir-preserve says otherwise.

See upstream documentation for additional details.