Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

defaults

Default options applied to all nodes.

Type: submodule

Default: { }

Declared by:

defaults.build.toplevel

Build this node’s configuration into a NixOS system package.

Alias to config.system.build.toplevel.

Type: package (read only)

Declared by:

defaults.build.vm

Build this node’s configuration into a VM testing package.

Alias to config.system.build.vm.

Type: package (read only)

Declared by:

defaults.nixpkgs

The nixpkgs version to use when building this node.

By default, if not explicitly set, it uses the same version than the Noxa flake itself.

Type: absolute path

Default: "<nixpkgs>"

Declared by:

defaults.reachable.allowHostConfiguration

Allow the host to configure its own reachable addresses. If set to false, values can only be set on the Noxa module level.

Type: boolean

Default: false

Declared by:

defaults.reachable.internet

List of external IP addresses this host is reachable at via using a public IP address.

Type: list of (IPv4 address or IPv6 address)

Default: [ ]

Declared by:

defaults.reachable.wireguardNetwork

List of IP addresses this host is reachable at via WireGuard (specified via name).

Type: attribute set of list of (IPv4 address or IPv6 address)

Default: { }

Declared by:

defaults.specialArgs

Special arguments passed to the host modules.

Type: attribute set of anything

Default: { }

Declared by:

nodeNames

A list of node names managed by Noxa. Due to the architecture of Noxa, noxa modules might unwillingly create new nodes, this list contains the name of all nodes that are currently managed by Noxa. Noxa modules can check this list to see if a node was created by themselves.

  The user must set this to the listOf all nodes they want to manage, otherwise if you
  don't care, set this to `attrNames config.nodes`.

Type: list of string

Default: [ ]

Declared by:

nodes

A set of nixos hosts managed by Noxa.

Type: attribute set of (submodule)

Default: { }

Declared by:

nodes.<name>.build.toplevel

Build this node’s configuration into a NixOS system package.

Alias to config.system.build.toplevel.

Type: package (read only)

Declared by:

nodes.<name>.build.vm

Build this node’s configuration into a VM testing package.

Alias to config.system.build.vm.

Type: package (read only)

Declared by:

nodes.<name>.nixpkgs

The nixpkgs version to use when building this node.

By default, if not explicitly set, it uses the same version than the Noxa flake itself.

Type: absolute path

Default: "<nixpkgs>"

Declared by:

nodes.<name>.reachable.allowHostConfiguration

Allow the host to configure its own reachable addresses. If set to false, values can only be set on the Noxa module level.

Type: boolean

Default: false

Declared by:

nodes.<name>.reachable.internet

List of external IP addresses this host is reachable at via using a public IP address.

Type: list of (IPv4 address or IPv6 address)

Default: [ ]

Declared by:

nodes.<name>.reachable.wireguardNetwork

List of IP addresses this host is reachable at via WireGuard (specified via name).

Type: attribute set of list of (IPv4 address or IPv6 address)

Default: { }

Declared by:

nodes.<name>.specialArgs

Special arguments passed to the host modules.

Type: attribute set of anything

Default: { }

Declared by: