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

programs.distrobox.enable

Whether to enable distrobox.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.distrobox.enableSystemdUnit

Whatever to enable a Systemd Unit that automatically rebuilds your containers when changes are detected.

Type: boolean

Default:

"config.programs.distrobox.containers != { } && config.programs.distrobox.package != null"

Example:

false

Declared by:

programs.distrobox.package

The distrobox package to use.

Type: null or package

Default:

pkgs.distrobox

Declared by:

programs.distrobox.containers

A set of containers and all its respective configurations. Each option can be either a bool, string or a list of strings. If passed a list, the option will be repeated for each element. See common-debian in the example config. All the available options for the containers can be found in the distrobox-assemble documentation at https://github.com/89luca89/distrobox/blob/main/docs/usage/distrobox-assemble.md.

Type: attribute set 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:

{ }

Example:

{
  common-debian = {
    additional_packages = "git";
    entry = true;
    image = "debian:13";
    init_hooks = [
      "ln -sf /usr/bin/distrobox-host-exec /usr/local/bin/docker"
      "ln -sf /usr/bin/distrobox-host-exec /usr/local/bin/docker-compose"
    ];
  };
  office = {
    additional_packages = "libreoffice onlyoffice";
    clone = "common-debian";
    entry = true;
  };
  python-project = {
    additional_packages = "python3 git";
    image = "fedora:40";
    init_hooks = "pip3 install numpy pandas torch torchvision";
  };
  random-things = {
    clone = "common-debian";
    entry = false;
  };
}

Declared by:

programs.distrobox.settings

Configuration settings for Distrobox. All the available options can be found here: https://github.com/89luca89/distrobox?tab=readme-ov-file#configure-distrobox

Type: attribute set of (INI atom (null, bool, int, float or string) or a list of them for duplicate keys)

Default:

{ }

Example:

{
  container_additional_volumes = "/example:/example1 /example2:/example3:ro";
  container_always_pull = "1";
  container_generate_entry = 0;
  container_image_default = "registry.opensuse.org/opensuse/toolbox:latest";
  container_init_hook = "~/.local/distrobox/a_custom_default_init_hook.sh";
  container_manager = "docker";
  container_manager_additional_flags = "--env-file /path/to/file --custom-flag";
  container_name_default = "test-name-1";
  container_pre_init_hook = "~/a_custom_default_pre_init_hook.sh";
  container_user_custom_home = "$HOME/.local/share/container-home-test";
  non_interactive = "1";
  skip_workdir = "0";
}

Declared by: