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

mariner.cid

VSOCK context ID

Type: integer between 3 and 254 (both inclusive)

Declared by:

mariner.distrobox.enable

Whether to enable distrobox integration.

Type: boolean

Default:

false

Example:

true

Declared by:

mariner.distrobox.autoEnter

Automatically enter distrobox on interactive login

Type: null or string

Default:

"ubuntu"

Declared by:

mariner.distrobox.manifest

Generates distrobox assemble manifest.ini, each attribute name is a [section] for a box. Freeform Option: you may add any key that assemble manifest supports. For the full list see: distrobox-assemble manifest reference.

Type: attribute set of (open submodule of section of an INI file (attrs of INI atom (null, bool, int, float or string) or a list of them for duplicate keys))

Default:

{
  ubuntu = {
    image = "ubuntu:24.04";
  };
}

Declared by:

mariner.distrobox.manifest.<name>.additional_packages

Extra packages to install in the box

Type: list of string

Default:

[ ]

Example:

[
  "git"
  "curl"
  "vim"
]

Declared by:

mariner.distrobox.manifest.<name>.entry

Generate desktop entry. Must be false on headless distrobox

Type: boolean

Default:

false

Declared by:

mariner.distrobox.manifest.<name>.hostname

distrobox host name

Type: string

Default:

"‹name›"

Declared by:

mariner.distrobox.manifest.<name>.image

Which image should the distrobox container use

Type: string

Declared by:

mariner.distrobox.manifest.<name>.init

Run systemd init as PID 1 inside distrobox

Type: boolean

Default:

true

Declared by:

mariner.distrobox.replace

Whether to recreate boxes. always on every boot, never only manually with distrobox assemble create --replace or onChange when the manifest file changes

Type: one of “onChange”, “never”, “always”

Default:

"onChange"

Declared by:

mariner.docker.enable

Whether to enable Docker integration.

Type: boolean

Default:

false

Example:

true

Declared by:

mariner.graphics.enable

Whether to enable Graphical desktop apps support.

Type: boolean

Default:

false

Example:

true

Declared by:

mariner.network.enable

Whether to enable guest LAN interface.

Type: boolean

Default:

true

Declared by:

mariner.network.address

Static IPv4 address assigned to the LAN interface.

Type: string

Default:

"Derived from `mariner.cid`"

Declared by:

mariner.network.dns

DNS Address defaults to FallbackDNS. You should set it to network.gateway if host.network.exposeDNS is enabled.

Type: null or string

Default:

null

Declared by:

mariner.network.gateway

Host static IPv4 address on the bridge.

Type: string

Default:

"10.0.0.1"

Declared by:

mariner.network.mac

MAC address for the LAN interface.

Type: string

Default:

"Derived from `mariner.cid`"

Declared by:

mariner.ssh.authorizedKeys

A list of SSH authorized public keys for vm user and root

Type: list of (optionally newline-terminated) single-line string

Default:

[ ]

Declared by:

mariner.storage.dockerSizeMiB

Size of the docker volume in MiB. Stores Docker containers, images and volumes. Only created when mariner.docker.enable is set.

Type: null or (positive integer, meaning >0)

Default:

null

Declared by:

mariner.storage.nixStoreSizeMiB

Size of the writable Nix store overlay in MiB. A writable overlay on the read-only host nix store, caches nix-shell and flake outputs built inside the VM.

Type: null or (positive integer, meaning >0)

Default:

null

Declared by:

mariner.storage.persistSizeMiB

Size of the /persist volume in MiB. Holds the user’s $HOME and anything written under /persist in the VM.

Type: null or (positive integer, meaning >0)

Default:

32768

Declared by:

mariner.storage.readOnlyStoreShare

Sets the protocol for sharing the host machine /nix/store as a read-only share. setting it to null disables it. Check the microvm.hypervisor supported protocols before setting this option.

virtiofs performs better than 9p and requires microvm-virtiofsd@<name>.service to run on the host besides the VM which is automatically started as a dependency of microvm@<name>.service.

Type: null or one of “virtiofs”, “9p”

Default:

null

Declared by:

mariner.storage.waydroidSizeMiB

Size of the waydroid volume in MiB. Holds the Android system/vendor images and Waydroid configurations.

Type: null or (positive integer, meaning >0)

Default:

null

Declared by:

mariner.username

VM user account

Type: string

Default:

"vm"

Declared by:

mariner.waydroid.enable

Whether to enable waydroid integration.

Type: boolean

Default:

false

Example:

true

Declared by:

mariner.waydroid.systemImage

Set Android system image variant

Type: one of “VANILLA”, “GAPPS”, “FOSS”

Default:

"VANILLA"

Declared by: