nix-darwin Options List

Option List

_module.args

Description

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.

Type

lazy attribute set of raw value

Declared by

<lib/modules.nix>

basement.presets.server.enable

Description

Whether to enable automatic login and other settings targeted at servers.

Type

boolean

Default

False

Example

True

Declared by

<darwin-modules/presets/server.nix>

basement.services.gitlab-runner.configFile

Description

Configuration file for gitlab-runner. This file is generated by running gitlab-runner register.

Type

path

Default

/Users/user/.gitlab-runner/runner.toml

Declared by

<darwin-modules/services/gitlab-runner.nix>

basement.services.gitlab-runner.dataDir

Description

The working directory for the Gitlab runner.

Type

string

Default

/var/lib/gitlab-runner

Declared by

<darwin-modules/services/gitlab-runner.nix>

basement.services.gitlab-runner.enable

Description

Whether to enable Gitlab Runner.

Type

boolean

Default

False

Example

True

Declared by

<darwin-modules/services/gitlab-runner.nix>

basement.services.gitlab-runner.logFile

Description

The path of the log file for Gitlab runner service.

Type

path

Default

/var/log/gitlab-runner.log

Declared by

<darwin-modules/services/gitlab-runner.nix>

basement.virtualization.linuxvm

Description

Starts a VM inside a launchctl service.

Type

submodule

Default

{}

Declared by

<darwin-modules/virtualization/linux-vm.nix>

basement.virtualization.linuxvm.configuration

Description

nixosConfiguration (of system aarch64) that has nix-basement.presets.darwinvm.enable = true

basement.virtualization.linuxvm.cores

Description

cores of the vm

Type

signed integer

Default

6

Declared by

<darwin-modules/virtualization/linux-vm.nix>

basement.virtualization.linuxvm.dataDir

Description

Where the linux vm’s nix store resides

Type

string

Default

/var/lib/linuxvm

Declared by

<darwin-modules/virtualization/linux-vm.nix>

basement.virtualization.linuxvm.enable

Description

Whether to enable Enables a Linux VM.

Type

boolean

Default

False

Example

True

Declared by

<darwin-modules/virtualization/linux-vm.nix>

basement.virtualization.linuxvm.logFile

Description

The path of the log file for the linuxvm service.

Type

path

Default

/var/log/linuxvm.log

Declared by

<darwin-modules/virtualization/linux-vm.nix>

basement.virtualization.linuxvm.portForwards

Description

syntax: tcp/udp:hostip:hostport-guestip:guestport hostip/guestip can be omitted.

Type

list of string

Default

['tcp::5555-:22']

Declared by

<darwin-modules/virtualization/linux-vm.nix>

basement.virtualization.linuxvm.ram

Description

ram of the vm (in MB)

Type

signed integer

Default

4096

Declared by

<darwin-modules/virtualization/linux-vm.nix>

basement.virtualization.linuxvm.rwStoreSize

Description

Size of the vm’s nix store

Type

string

Default

50G

Declared by

<darwin-modules/virtualization/linux-vm.nix>

basement.virtualization.linuxvm.sharePath

Description

Path to share to the VM if the path contains a folder named ssh, contents are copied to /etc/ssh on the VM

Type

path

Default

/Users/user/vmshare

Declared by

<darwin-modules/virtualization/linux-vm.nix>