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

NixOS Options

liuxu.nixos.bluetooth.enable

Liuxu: Whether to enable the bluetooth support. Currently enables bluez and enables blueman when GUI enabled.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.nixos.brightness.enable

Liuxu: Whether to enable the brightness control support. Currently enables brightnessctl.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.nixos.cloudflare-ddns

Alias of services.cloudflare-ddns.

Type: submodule

Declared by:

liuxu.nixos.cloudflared

Alias of services.cloudflared.

Type: submodule

Declared by:

liuxu.nixos.fingerprint.enable

Liuxu: Whether to enable the fingerprint reader support.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.nixos.flatpak.enable

Liuxu: Whether to enable the Flatpak support.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.nixos.hermes.enable

Alias of services.hermes-agent.enable.

Type: boolean

Declared by:

liuxu.nixos.hermes.allowNixAccess

Liuxu: Whether to allow hermes to access nix daemon, just allow to access, not trusted users.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.nixos.hermes.environmentFiles

Alias of services.hermes-agent.environmentFiles.

Type: list of string

Default:

[ ]

Declared by:

liuxu.nixos.hermes.settings

Alias of services.hermes-agent.settings.

Type: Hermes YAML config (attrset), merged deeply via lib.recursiveUpdate.

Declared by:

liuxu.nixos.laptop.enable

Liuxu: Whether to enable the laptop support. Currently enables UPower that handles battery usage, but lid events are handled by loginctl.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.nixos.measured-boot.enable

Liuxu: Whether to enable measured-boot. See: https://nix-community.github.io/lanzaboote/explanation/measured-boot.html And: https://nix-community.github.io/lanzaboote/how-to-guides/enable-measured-boot.html

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.nixos.network.enable

Liuxu: Whether to enable network support. Currently enables NetworkManager and firewalld.

Type: boolean

Default:

true

Example:

false

Declared by:

liuxu.nixos.network.mihoyo.enable

Liuxu: Whether to enable Mihoyo. Network should be enable first. Genshin, Impact! (x

Type: boolean

Default:

true

Example:

false

Declared by:

liuxu.nixos.network.mihoyo.providerUrlFiles

Liuxu: Providers for Mihoyo.

Type: attribute set of absolute path

Default:

{ }

Declared by:

liuxu.nixos.network.mihoyo.settings.defaults.urlTest.lazy

Liuxu: Default URL test lazyness setting for mihoyo.

Type: boolean

Default:

true

Example:

false

Declared by:

liuxu.nixos.network.mihoyo.settings.defaults.urlTest.url

Liuxu: Default URL test URL for mihoyo.

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

Default:

"https://cp.cloudflare.com"

Example:

"https://www.gstatic.com/generate_204"

Declared by:

liuxu.nixos.pin.enable

Liuxu: Whether to enable the Windows-Like PIN code support, which uses an alter simple password for local auth, currently for tty-login, dm-login and polkit(run0 and etc.).

Type: boolean

Default:

true

Example:

false

Declared by:

liuxu.nixos.podman.enable

Liuxu: Whether to enable Podman, a container management tool, drop-in replacement of docker.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.nixos.qbittorrent.enable

Liuxu: Whether to enable the qBittorrent service, uses qBittorrent Enhanced Edition, and will also enables Peer Ban Helper.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.nixos.samba.enable

Liuxu: Whether to enable samba, file sharing server.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.nixos.samba.passwordFiles

Liuxu: Password files of Samba user.

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

Default:

{ }

Example:

{
  lialh4 = {
    _type = "literalMD";
    text = "config.age.secretV2.samba.passwordFile";
  };
}

Declared by:

liuxu.nixos.samba.shares

Liuxu: Shares of Samba.

Type: attribute set of (submodule)

Default:

{ }

Example:

{
  data = {
    path = "/mnt/data/lialh4";
    user = "lialh4";
  };
}

Declared by:

liuxu.nixos.samba.shares.<name>.group

Liuxu: Group of share.

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

Example:

"users"

Declared by:

liuxu.nixos.samba.shares.<name>.path

Liuxu: Path of share.

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

Example:

"/mnt/data/lialh4"

Declared by:

liuxu.nixos.samba.shares.<name>.readOnly

Liuxu: Is share read-only?

Type: boolean

Default:

true

Example:

false

Declared by:

liuxu.nixos.samba.shares.<name>.user

Liuxu: User of share.

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

Example:

"lialh4"

Declared by:

liuxu.nixos.secureboot.enable

Liuxu: Whether to enable the secure boot support. Currently enables lanzaboote.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.nixos.tlp.enable

Liuxu: Whether to enable the TLP, a better power management suit, replacing power-profiles-daemon. Default enable when laptop enabled.

Type: boolean

Default:

false

Example:

false

Declared by:

liuxu.nixos.tlp.disks

Liuxu: Disks managed TLP. Can be obtained using ls /dev/disks/by-id

Type: list of string

Default:

[ ]

Example:

[
  "NVME_123456789012"
  "SATA_210987654321"
]

Declared by:

liuxu.nixos.user-support.gui.display-manager.enable

Liuxu: Whether to enable Display Manager. Won’t be actually enabled if no user has GUI enabled.

Type: boolean

Default:

false

Example:

false

Declared by:

liuxu.nixos.user-support.gui.intel-graphics.enable

Liuxu: Whether to enable the Intel Graphics support. Currently enables VAAPI and QSV drivers for Intel graphics cards. Won’t be actually enabled when no user has GUI enabled.

Type: boolean

Default:

false

Example:

false

Declared by:

liuxu.nixos.user-support.gui.plymouth.enable

Liuxu: Whether to enable the Plymouth, which is boot animation. Default enable when enables GUI, but can be enabled seperately.

Type: boolean

Default:

false

Example:

false

Declared by:

liuxu.nixos.virtualbox.enable

Liuxu: Whether to enable Virtualbox, an easy to use virtual machines manager.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.nixos.windows-guest.enable

Liuxu: Whether to include a Windows guest configuration, by virt-manager, qemu, kvm, with SR-IOV.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.system.better-shell.enable

Liuxu: Whether to enable the better shell. Currently enables fish, set it to default shell for all users, enables starship, enables its shell integration for all shells, enables zoxide, enables its shell integration (z command) for fish and bash, enables bat, eza, and set fish and bash aliases: cat –> bat ls –> eza

Type: boolean

Default:

true

Example:

false

Declared by:

liuxu.system.helix.enable

Liuxu: Whether to enable helix, a modern cli text editor.

Type: boolean

Default:

true

Example:

false

Declared by:

liuxu.system.version-when-installed

Liuxu: Reflects NixOS version when system get installed. Do not change it after install unless needed!

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

Default:

"25.11"

Example:

"26.05"

Declared by:

Home Options

liuxu.home.gui.agl.enable

Liuxu (Home): Whether to enable the agl.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.home.gui.hyprland.enable

Liuxu (Home): Whether to enable the Hyprland GUI.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.home.gui.keybinds.execr

Liuxu (Home): Keybinds that exec a cmd, apply to both Hyprland and Niri.

Type: list of (submodule)

Default:

[ ]

Example:

[
  {
    cmd = [
      "noctalia"
      "msg"
      "panel-toggle"
      "launcher"
    ];
    key = "R";
    mod = "Mod";
    opt = {
      lock = false;
      repeat = false;
    };
  }
]

Declared by:

liuxu.home.gui.keybinds.execr.*.cmd

Liuxu (Home): Keybind’s cmd to exec, must not be empty, can be a single str if there’s no args.

Type: (list of string) or string convertible to it

Default:

[ ]

Example:

[
  "noctalia"
  "msg"
  "panel-toggle"
  "launcher"
]

Declared by:

liuxu.home.gui.keybinds.execr.*.key

Liuxu (Home): Keybind’s key, must not be empty.

Type: string

Example:

"R"

Declared by:

liuxu.home.gui.keybinds.execr.*.mod

Liuxu (Home): Keybind’s modkey, can be a single string or a list of string.

Type: (list of string) or string convertible to it

Default:

[ ]

Example:

"Mod"

Declared by:

liuxu.home.gui.keybinds.execr.*.opt.lock

Liuxu (Home): Whether or not the keybind is effective in lockscreen.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.home.gui.keybinds.execr.*.opt.repeat

Liuxu (Home): Whether or not the keybind will do effect repeatly when long-pressed.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.home.gui.niri.enable

Liuxu (Home): Whether to enable the Niri GUI.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.home.gui.niri.keybinds

Liuxu (Home): keybinds for niri, KDL snippit in nix-kdl expression.

Type: list of anything

Default:

[ ]

Example:

[
  <function>
]

Declared by:

liuxu.home.gui.niri.settings

Liuxu (Home): Niri settings in kdl.

Type: strings concatenated with “\n”

Default:

""

Example:

''
  input {
      disable-power-key-handling
  }''

Declared by:

liuxu.home.gui.zen.enable

Liuxu (Home): Whether to enable the Zen browser.

Type: boolean

Default:

false

Example:

false

Declared by:

liuxu.home.internal.intransience.dirs.*.method

This option has no description.

Type: one of “bind”, “symlink”

Default:

"bind"

Declared by:

liuxu.home.internal.intransience.dirs.*.path

This option has no description.

Type: string

Declared by:

liuxu.home.internal.intransience.files.*.method

This option has no description.

Type: one of “bind”, “symlink”

Default:

"bind"

Declared by:

liuxu.home.internal.intransience.files.*.path

This option has no description.

Type: string

Declared by:

liuxu.home.opencode.enable

Liuxu (Home): Whether to enable opencode, a coding agent.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.home.sdk.enable

Liuxu (Home): Whether to enable the SDKs.

Type: boolean

Default:

false

Example:

true

Declared by:

liuxu.home.sdk.elixir.enable

Liuxu (Home): Whether to enable the Elixir SDK.

Type: boolean

Default:

false

Example:

true

Declared by: