The Hjem CLI package to use.

The default override behaviour for files managed by Hjem.

While true, existing files will be overriden with new files on rebuild. The behaviour may be modified per-user by setting hjem.users.<username>.clobberFiles to the desired value.

Additional modules to be evaluated as a part of the users module inside config.hjem.users.<username>. This can be used to extend each user configuration with additional options.

Package to use to link files.

By default, Hjem uses its own standalone CLI linker.

Setting this to null will use systemd-tmpfiles, which is only supported on Linux.

Specifying a non-null package uses an external linker that is invoked with Hjem-managed manifests.

Additional linker configuration.

When using Hjem's built-in standalone linker, only prefix is consumed from an attribute set.

Additional specialArgs are passed to Hjem, allowing extra arguments to be passed down to to all imported modules.

Hjem-managed user configurations.

Whether to enable home management for this user.

Packages to install for this user.

The default override behaviour for files managed by Hjem for a particular user.

A top level option exists under the Hjem module option hjem.clobberByDefault. Per-file behaviour can be modified with hjem.users.<username>.files.<path>.clobber.

The home directory for the user, to which files configured in hjem.users.<username>.files will be relative to by default.

A POSIX compliant shell script containing the user session variables needed to bootstrap the session.

As there is no reliable and agnostic way of setting session variables, Hjem's environment module does nothing by itself. Rather, it provides a POSIX compliant shell script that needs to be sourced where needed.

A set of environment variables used in the user environment. If a list of strings is used, they will be concatenated with colon characters.

A list of paths/packages that should be included in the system closure but generally not visible to users.

On NixOS these paths are forwarded to system.extraDependencies. On nix-darwin, which has no equivalent host option, the paths are pinned to the system closure by listing them in /etc/hjem/extra-dependencies.

Hjem-managed files.

Whether to enable creation of this file.

Whether to "clobber" existing target paths.

• If using the systemd-tmpfiles hook (Linux only), tmpfile rules will be constructed with L+ (recreate) instead of L (create) type while this is set to true.

Whether to set the execute bit on the target file.

Function that when applied to value will create the source or text of the file.

Detection is automatic, as we check if the generator generates a derivation or a string after applying to value.

Group ID to set as owner on the target path.

Permissions (in octal) to set on the target path.

Path of the source file or directory.

Path to target file relative to /home/‹username›.

Text of the file.

Type of path to create.

User ID to set as owner on the target path.

Value passed to the generator.

Whether to enable Hjem management of systemd units.

Packages containing systemd user unit files to be linked into ~/.config/systemd/user/. Unit files are taken from $pkg/etc/systemd/user/ and $pkg/lib/systemd/user/.

Units declared in systemd.services and friends take precedence over package-provided units with the same name.

Definition of systemd per-user path units.

If set to false, this unit will be a symlink to /dev/null. This is primarily useful to prevent specific template instances (e.g. serial-getty@ttyS0) from being started. Note that enable=true does not make a unit start by default at boot; if you want that, see wantedBy.

If the specified units are started at the same time as this unit, delay this unit until they have started.

Aliases of that unit.

If the specified units are started at the same time as this unit, delay them until this unit has started.

Like ‘requires’, but in addition, if the specified units unexpectedly disappear, this unit will be stopped as well.

If the specified units are started, then this unit is stopped and vice versa.

Description of this unit used in systemd messages and progress indicators.

A list of URIs referencing documentation for this unit or its configuration.

The name of this systemd unit, including its extension. This can be used to refer to this unit from other systemd units.

A list of one or more units that are activated when this unit enters the "failed" state.

A list of one or more units that are activated when this unit enters the "inactive" state.

Defines how unit configuration is provided for systemd:

asDropinIfExists creates a unit file when no unit file is provided by the package otherwise it creates a drop-in file named overrides.conf.

asDropin creates a drop-in file named overrides.conf. Mainly needed to define instances for systemd template units (e.g. systemd-nspawn@mycontainer.service).

See also systemd.unit(5).

If the specified units are stopped or restarted, then this unit is stopped or restarted as well.

Each attribute in this set specifies an option in the [Path] section of the unit. See systemd.path(5) for details.

An arbitrary list of items such as derivations. If any item in the list changes between reconfigurations, the service will be reloaded. If anything but a reload trigger changes in the unit file, the unit will be restarted instead.

Units that require (i.e. depend on and need to go down with) this unit. As discussed in the wantedBy option description this also creates .requires symlinks automatically.

Start the specified units when this unit is started, and stop this unit when the specified units are stopped or fail.

Similar to requires. However if the units listed are not started, they will not be started and the transaction will fail.

An arbitrary list of items such as derivations. If any item in the list changes between reconfigurations, the service will be restarted.

Configure unit start rate limiting. Units which are started more than startLimitBurst times within an interval time interval are not permitted to start any more.

Configure unit start rate limiting. Units which are started more than startLimitBurst times within an interval time interval are not permitted to start any more.

Each attribute in this set specifies an option in the [Unit] section of the unit. See systemd.unit(5) for details.

Keep this unit running as long as the listed units are running. This is a continuously enforced version of wantedBy.

Keeps the specified running while this unit is running. A continuous version of wants.

Units that want (i.e. depend on) this unit. The default method for starting a unit by default at boot time is to set this option to ["multi-user.target"] for system services. Likewise for user units (systemd.user.<name>.*) set it to ["default.target"] to make a unit start by default when the user <name> logs on.

This option creates a .wants symlink in the given target that exists statelessly without the need for running systemctl enable. The [Install] section described in systemd.unit(5) however is not supported because it is a stateful process that does not fit well into the NixOS design.

Start the specified units when this unit is started.

Definition of systemd per-user service units.

If set to false, this unit will be a symlink to /dev/null. This is primarily useful to prevent specific template instances (e.g. serial-getty@ttyS0) from being started. Note that enable=true does not make a unit start by default at boot; if you want that, see wantedBy.

Whether to append a minimal default PATH environment variable to the service, containing common system utilities.

Enable running shellcheck on the generated scripts for this unit.

When enabled, scripts generated by the unit will be checked with shellcheck and any errors or warnings will cause the build to fail.

This affects all scripts that have been created through the script, reload, preStart, postStart, preStop and postStop options for systemd services. This does not affect command lines passed directly to ExecStart, ExecReload, ExecStartPre, ExecStartPost, ExecStop or ExecStopPost.

If the specified units are started at the same time as this unit, delay this unit until they have started.

Aliases of that unit.

If the specified units are started at the same time as this unit, delay them until this unit has started.

Like ‘requires’, but in addition, if the specified units unexpectedly disappear, this unit will be stopped as well.

If the specified units are started, then this unit is stopped and vice versa.

Description of this unit used in systemd messages and progress indicators.

A list of URIs referencing documentation for this unit or its configuration.

Environment variables passed to the service's processes.

The name of this systemd unit, including its extension. This can be used to refer to this unit from other systemd units.

If set, a changed unit is never assumed to be socket-activated on configuration switch, even if it might have associated socket units. Instead, the unit will be restarted (or stopped/started) as if it had no associated sockets.

A list of one or more units that are activated when this unit enters the "failed" state.

A list of one or more units that are activated when this unit enters the "inactive" state.

Defines how unit configuration is provided for systemd:

asDropinIfExists creates a unit file when no unit file is provided by the package otherwise it creates a drop-in file named overrides.conf.

asDropin creates a drop-in file named overrides.conf. Mainly needed to define instances for systemd template units (e.g. systemd-nspawn@mycontainer.service).

See also systemd.unit(5).

If the specified units are stopped or restarted, then this unit is stopped or restarted as well.

Packages added to the service's PATH environment variable. Both the bin and sbin subdirectories of each package are added.

Shell commands executed after the service's main process is started.

Shell commands executed after the service's main process has exited.

Shell commands executed before the service's main process is started.

Shell commands executed to stop the service.

Shell commands executed when the service's main process is reloaded.

Whether the service should be reloaded during a NixOS configuration switch if its definition has changed. If enabled, the value of restartIfChanged is ignored.

This option should not be used anymore in favor of reloadTriggers which allows more granular control of when a service is reloaded and when a service is restarted.

An arbitrary list of items such as derivations. If any item in the list changes between reconfigurations, the service will be reloaded. If anything but a reload trigger changes in the unit file, the unit will be restarted instead.

Units that require (i.e. depend on and need to go down with) this unit. As discussed in the wantedBy option description this also creates .requires symlinks automatically.

Start the specified units when this unit is started, and stop this unit when the specified units are stopped or fail.

Similar to requires. However if the units listed are not started, they will not be started and the transaction will fail.

Whether the service should be restarted during a NixOS configuration switch if its definition has changed.

An arbitrary list of items such as derivations. If any item in the list changes between reconfigurations, the service will be restarted.

Shell commands executed as the service's main process.

Arguments passed to the main process script. Can contain specifiers (% placeholders expanded by systemd, see systemd.unit(5)).

Each attribute in this set specifies an option in the [Service] section of the unit. See systemd.service(5) for details.

Automatically start this unit at the given date/time, which must be in the format described in systemd.time(7). This is equivalent to adding a corresponding timer unit with OnCalendar set to the value given here.

Configure unit start rate limiting. Units which are started more than startLimitBurst times within an interval time interval are not permitted to start any more.

Configure unit start rate limiting. Units which are started more than startLimitBurst times within an interval time interval are not permitted to start any more.

If set, a changed unit is restarted by calling systemctl stop in the old configuration, then systemctl start in the new one. Otherwise, it is restarted in a single step using systemctl restart in the new configuration. The latter is less correct because it runs the ExecStop commands from the new configuration.

Each attribute in this set specifies an option in the [Unit] section of the unit. See systemd.unit(5) for details.

Keep this unit running as long as the listed units are running. This is a continuously enforced version of wantedBy.

Keeps the specified running while this unit is running. A continuous version of wants.

Units that want (i.e. depend on) this unit. The default method for starting a unit by default at boot time is to set this option to ["multi-user.target"] for system services. Likewise for user units (systemd.user.<name>.*) set it to ["default.target"] to make a unit start by default when the user <name> logs on.

This option creates a .wants symlink in the given target that exists statelessly without the need for running systemctl enable. The [Install] section described in systemd.unit(5) however is not supported because it is a stateful process that does not fit well into the NixOS design.

Start the specified units when this unit is started.

Definition of systemd per-user slice units.