Sockets

`systemd.sockets.<name>.after`

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

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.aliases`

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.before`

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

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.bindsTo`

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

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.conflicts`

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

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.description`

Description of this unit used in systemd messages and progress indicators. Type: (optionally newline-terminated) single-line string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.documentation`

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

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.enable`

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.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.listenDatagrams`

For each item in this list, a ListenDatagram option in the [Socket] section will be created.

Type: list of string

Default

[ ]

Example

["0.0.0.0:993""/run/my-socket"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.listenStreams`

For each item in this list, a ListenStream option in the [Socket] section will be created.

Type: list of string

Default

[ ]

Example

["0.0.0.0:993""/run/my-socket"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.name`

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

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.onFailure`

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

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.onSuccess`

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

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.overrideStrategy`

Defines how unit configuration is provided for systemd:

asDropinIfExists creates a unit file when no unit file is provided by the package otherwise a drop-in file name 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).

Default

"asDropinIfExists"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.partOf`

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

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.reloadTriggers`

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.

Type: list of (systemd option)

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.requiredBy`

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.

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.requires`

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

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.requisite`

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

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.restartTriggers`

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

Type: list of unspecified value

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.socketConfig`

Each attribute in this set specifies an option in the [Socket] section of the unit. See {manpage}systemd.socket(5) for details.

Type: attribute set of (systemd option)

Default

{ }

Example

{ListenStream = "/run/my-socket";}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.startLimitBurst`

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.

Type: signed integer

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.startLimitIntervalSec`

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.

Type: signed integer

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.unitConfig`

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

Type: attribute set of (systemd option)

Default

{ }

Example

{RequiresMountsFor = "/data";}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.upheldBy`

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

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.upholds`

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

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.wantedBy`

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 {manpage}systemd.unit(5) however is not supported because it is a stateful process that does not fit well into the NixOS design.

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix

`systemd.sockets.<name>.wants`

Start the specified units when this unit is started.

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/system/boot/systemd.nix