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

xyz.adtya.recipes.boot.default

Enable the default boot config

Type: boolean

Default:

true

Declared by:

xyz.adtya.recipes.boot.plymouth.enable

Enable Plymouth

Type: boolean

Default: config.xyz.adtya.recipes.presets.desktop

Declared by:

xyz.adtya.recipes.boot.plymouth.theme

One of the themes from here

Type: string

Default:

"hexagon_dots"

Declared by:

xyz.adtya.recipes.core.admin.enable

Make the primary non-root user the admin

Type: boolean

Default:

true

Declared by:

xyz.adtya.recipes.core.admin.needs-password

Ask for password when doing stuff as admin

Type: boolean

Default:

true

Declared by:

xyz.adtya.recipes.core.nix.auto-gc

Enable Automatic Garbage collection of the Nix store

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.core.nix.auto-optimise

Enable Automatic optimisation of the Nix store

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.core.nix.use-nh

Use NH for nixos-rebuild

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.core.sops.enable

Enable sops.nix for secret management

Type: boolean

Default:

false

Example:

true

Declared by:

xyz.adtya.recipes.core.sops.secrets-file

Path to a file containing Tailscale Auth key.

Type: null or absolute path

Default:

null

Example:

"./secrets.yaml"

Declared by:

xyz.adtya.recipes.core.users.primary.allowed-ssh-keys

List of ssh public keys that can log-in as the primary user

Type: list of string

Default:

[ ]

Example:

[
  "ssh-ed25519 blah blah"
]

Declared by:

xyz.adtya.recipes.core.users.primary.email

User’s email. (used with git and friends)

Type: string

Example:

"John@example.org"

Declared by:

xyz.adtya.recipes.core.users.primary.extra-groups

Extra groups the user should be added to

Type: list of string

Default:

[
  "wheel"
]

Declared by:

xyz.adtya.recipes.core.users.primary.group

User’s primary group

Type: string (read only)

Default: config.users.users.${config.xyz.adtya.recipes.core.users.primary.name}.group

Declared by:

xyz.adtya.recipes.core.users.primary.home

Path to the user’s home directory

Type: absolute path (read only)

Default: config.users.users.${config.xyz.adtya.recipes.core.users.primary.name}.home

Declared by:

xyz.adtya.recipes.core.users.primary.long-name

Longer version of the user’s name

Type: string

Example:

"John Doe"

Declared by:

xyz.adtya.recipes.core.users.primary.name

user name for the non-root primarty user

Type: string

Example:

"john"

Declared by:

xyz.adtya.recipes.core.users.primary.password-hash-file

Path to file containing the user’s password hash

Type: string

Example:

"/persist/secrets/password-hash"

Declared by:

xyz.adtya.recipes.core.users.root-password-hash-file

Path to file containing passsword hash for root user

Type: string

Example:

"/persist/secrets/root-password-hash"

Declared by:

xyz.adtya.recipes.desktop.addons.auth-agent.enable

Enable Polikit Authentication Agent

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.desktop.addons.dunst.enable

Enable Dunst Notification Daemon

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.desktop.addons.hypridle.enable

Enable Hypridle

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.desktop.addons.hypridle.backlight.display

Name of LED device for display backlight, if present (eg. intel_backlight)

Type: null or string

Default:

null

Declared by:

xyz.adtya.recipes.desktop.addons.hypridle.backlight.keyboard

Name of LED device for keyboard backlight, if present (eg. dell::kbd_backlight)

Type: null or string

Default:

null

Declared by:

xyz.adtya.recipes.desktop.addons.hypridle.timeouts.lock

Number of seconds of idling before the screen is locked

Type: signed integer

Default:

300

Declared by:

xyz.adtya.recipes.desktop.addons.hypridle.timeouts.screen-off

Number of seconds of idling before the screen is turned off

Type: signed integer

Default:

420

Declared by:

xyz.adtya.recipes.desktop.addons.hypridle.timeouts.suspend

Number of seconds of idling before going to sleep

Type: signed integer

Default:

600

Declared by:

xyz.adtya.recipes.desktop.addons.hyprlock.enable

Enable Hyprlock

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.desktop.addons.rofi.enable

Enable Rofi

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.desktop.addons.wallpapers.enable

Enable Managing wallpapers with AWWW

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.desktop.addons.waybar.enable

Enable Waybar

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.desktop.addons.waybar.package

Waybar package

Type: package

Default:

<derivation waybar-0.15.0>

Declared by:

xyz.adtya.recipes.desktop.addons.waybar.laptop-mode

Enable laptop-relevant modules

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.desktop.dm.flavour

Display manager of choice

Type: one of “cosmic”, “gdm”, “none”

Default:

"none"

Declared by:

xyz.adtya.recipes.desktop.gnome.enable

Enable GNOME

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.desktop.hyprland.enable

Enable Hyprland

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.desktop.hyprland.backlight-device

the name of the display backlight device, if present (eg. intel_backlight)

Type: null or string

Default:

null

Declared by:

xyz.adtya.recipes.desktop.hyprland.extraConfig

Additional hyprland configuration that will be added to the default config

Type: string

Default:

""

Declared by:

xyz.adtya.recipes.desktop.hyprland.hdr

Enable HDR

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.desktop.hyprland.laptop-mode

Enable laptop-relevant features in hyprland and friends

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.desktop.hyprland.vrr

Enable VRR

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.hostinfo.hostname

A name for the host

Type: string

Default:

null

Declared by:

xyz.adtya.recipes.hostinfo.local-ip

Local IP of the host (optional. might be used by other modules)

Type: null or string

Default:

null

Example:

"192.168.1.1"

Declared by:

xyz.adtya.recipes.hostinfo.public-ip

Public IP of the host (optional. might be used by other modules)

Type: null or string

Default:

null

Example:

"123.123.123.123"

Declared by:

xyz.adtya.recipes.hostinfo.tailscale-ip

Tailscale IP of the host (optional. might be used by other modules)

Type: null or string

Default:

null

Example:

"100.101.102.103"

Declared by:

xyz.adtya.recipes.misc.bluetooth.enable

Enable Bluetooth

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.misc.devtools.enable

Enable some dev tools

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.misc.devtools.git.user-email

Email of git user

Type: string

Default: config.xyz.adtya.recipes.core.users.primary.email

Declared by:

xyz.adtya.recipes.misc.devtools.git.user-name

Name of git user

Type: string

Default: config.xyz.adtya.recipes.core.users.primary.long-name

Declared by:

xyz.adtya.recipes.misc.gaming.enable

Enable gaming stuff

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.misc.gaming.lutris

Install Lutris

Type: boolean

Default:

true

Declared by:

xyz.adtya.recipes.networking.enable

Enable networking

Type: boolean

Default:

true

Declared by:

xyz.adtya.recipes.networking.preset.desktop

Enable the desktop preset for networking

Type: boolean

Default: config.xyz.adtya.recipes.presets.desktop

Declared by:

xyz.adtya.recipes.networking.preset.server

Enable the server preset for networking

Type: boolean

Default: config.xyz.adtya.recipes.presets.server

Declared by:

xyz.adtya.recipes.networking.wireless

Enable WiFi

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.presets.desktop

Enable the desktop preset

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.presets.desktop-minimal

Use a minimal version of the desktop preset

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.presets.server

Enable the server preset

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.programs.firefox.enable

Enable Firefox

Type: boolean

Default: config.xyz.adtya.recipes.presets.desktop

Declared by:

xyz.adtya.recipes.programs.fonts.enable

Setup fonts

Type: boolean

Default: config.xyz.adtya.recipes.presets.desktop

Declared by:

xyz.adtya.recipes.programs.ghostty.enable

Enable Ghostty

Type: boolean

Default: config.xyz.adtya.recipes.presets.desktop

Declared by:

xyz.adtya.recipes.programs.ghostty.package

Ghostty package

Type: package

Default:

<derivation ghostty-1.3.1>

Declared by:

xyz.adtya.recipes.programs.mpv.enable

Enable MPV

Type: boolean

Default: config.xyz.adtya.recipes.presets.desktop

Declared by:

xyz.adtya.recipes.programs.mpv.package

MPV package

Type: package

Default:

<derivation mpv-with-scripts-0.41.0>

Declared by:

xyz.adtya.recipes.programs.obs.enable

Enable OBS

Type: boolean

Default:

false

Example:

true

Declared by:

xyz.adtya.recipes.programs.starship.enable

Enable Starship

Type: boolean

Default:

true

Example:

true

Declared by:

xyz.adtya.recipes.programs.zsh.enable

Enable ZSH

Type: boolean

Default:

true

Example:

true

Declared by:

xyz.adtya.recipes.services.caddy.enable

Enable Caddy

Type: boolean

Default: config.xyz.adtya.recipes.presets.server

Declared by:

xyz.adtya.recipes.services.caddy.email

Email used with ACME

Type: string

Default: config.xyz.adtya.recipes.core.users.primary.email

Declared by:

xyz.adtya.recipes.services.caddy.env-file

Path to a file containing environment variables for the service

Type: null or string

Default:

"/persist/secrets/caddy/env"

Declared by:

xyz.adtya.recipes.services.dbus.enable

Enable DBus

Type: boolean

Default: config.xyz.adtya.recipes.presets.desktop

Declared by:

xyz.adtya.recipes.services.easyeffects.enable

Enable EasyEffects

Type: boolean

Default: config.xyz.adtya.recipes.presets.desktop

Declared by:

xyz.adtya.recipes.services.geoclue.enable

Enable Geoclue

Type: boolean

Default: config.xyz.adtya.recipes.presets.desktop

Declared by:

xyz.adtya.recipes.services.pipewire.enable

Enable Pipewire

Type: boolean

Default: config.xyz.adtya.recipes.presets.desktop

Declared by:

xyz.adtya.recipes.services.ssh.enable

Enable SSH server

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.services.tailscale.enable

Enable Tailscale

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.services.tailscale.auth-file

Path to a file containing Tailscale Auth key

Type: null or string

Default:

"/persist/secrets/tailscale/key"

Declared by:

xyz.adtya.recipes.services.tailscale.tailnet-name

The Tailnet DNS name from https://login.tailscale.com/admin/dns

Type: null or string

Default:

null

Example:

"tail123456.ts.net"

Declared by:

xyz.adtya.recipes.virtualisation.containers.enable

Enable containers with podman

Type: boolean

Default:

false

Declared by:

xyz.adtya.recipes.virtualisation.vms.enable

Enable VMs with libvirt

Type: boolean

Default:

false

Declared by: