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

local.cache.enable

Whether to enable cache module.

Type: boolean

Default:

false

Example:

true

local.cache.publicKey

Public key for cache verification

Type: string

Default:

"main:CqlQUu3twINKw6EvYnbk="

Example:

"cache:AbCdEf1234567890+GhIjKlMnOpQrStUvWxYz=="

local.cache.serverAddress

Attic binary cache server URL (automatically uses host from local.network-hosts module)

Type: string

Default:

"http://onix.local:8080/main"

Example:

"http://cache.example.com:8080/nixos"

local.cache.watch

Whether to enable enable systemd service to watch cache.

Type: boolean

Default:

false

Example:

true

local.caelestia.colorScheme

Color scheme name for Caelestia (e.g., ‘gruvbox’, ‘catppuccin’). If null, uses dynamic wallpaper colors.

Type: null or string

Default:

null

Example:

"gruvbox"

local.caelestia-shell.enable

Whether to enable Caelestia shell application.

Type: boolean

Default:

false

Example:

true

local.caelestia-shell.idleMinutes

Minutes of idle

Type: signed integer

Default:

120

local.fish.enable

Enable fish config if it is the system shell.

Type: boolean

Default:

false

local.fonts.enable

Whether to enable Nerd Fonts collection including Fira Code, Noto fonts, and emoji support.

Type: boolean

Default:

false

Example:

true

local.hyprland.enable

Whether to enable Functional Hyprland setup…

Type: boolean

Default:

false

Example:

true

local.hyprlauncher.enable

Whether to enable Hyprlauncher, the native Hyprland application launcher.

Type: boolean

Default:

false

Example:

true

local.hyprpaper.enable

Whether to enable Hyprpaper, the native Hyprland wallpaper daemon.

Type: boolean

Default:

false

Example:

true

local.hyprpaper.wallpapers

List of wallpaper paths to preload for Hyprpaper

Type: list of absolute path

Default:

[ ]

Example:

[ ~/.wallpaper ]

local.kdeconnect.enable

Whether to enable enable kdeconnect.

Type: boolean

Default:

false

Example:

true

local.kitty.enable

Whether to enable Kitty terminal emulator with custom configuration.

Type: boolean

Default:

false

Example:

true

local.mako.enable

Whether to enable Mako notification daemon for Wayland.

Type: boolean

Default:

false

Example:

true

local.mpd.enable

Whether to enable MPD (Music Player Daemon) with ncmpcpp client.

Type: boolean

Default:

false

Example:

true

local.mpd.path

Path to the music directory for MPD to serve

Type: string

Default:

"/media/Music"

Example:

"/home/user/Music"

local.nixvim.enable

Enable nixvim configuration

Type: boolean

Default:

false

local.nixvim.rust

Enable Rust language support

Type: boolean

Default:

false

local.nixvim.smartUndo

Enable persistent undo with smart directory management

Type: boolean

Default:

true

local.ranger.enable

Whether to enable Ranger terminal-based file manager with devicons support.

Type: boolean

Default:

false

Example:

true

local.secrets.enable

Whether to enable Use secrets.

Type: boolean

Default:

false

Example:

true

local.secrets.keys

List sops keys to automatically map to $HOME/.secrets/

Type: list of string

Default:

[ ]

Example:

[
  "github/token"
  "api/openai"
  "passwords/vpn"
]

local.secrets.sopsFile

Path to the encrypted yaml file

Type: absolute path

Default:

/nix/store/shwnn10jy3f95zhilzlb0gcx0jxp44vz-source/secrets/secrets.yaml

Example:

../secrets/user-secrets.yaml

local.ssh.enable

Whether to enable configure ssh for user.

Type: boolean

Default:

false

Example:

true

local.ssh.hosts

Mapping of SSH host aliases to hostnames or IP addresses (automatically uses hosts from local.network-hosts module)

Type: attribute set of string

Default:

{
  Jade = "jade.local";
  Onix = "onix.local";
  Ruby = "ruby.local";
  Sapphire = "sapphire.local";
}

Example:

{
  Ruby = "ruby.local";
  Sapphire = "sapphire.local";
}

local.ssh.masterKeyPath

Path to the SSH master private key file

Type: string

Default:

"~/.ssh/id_ed25519"

Example:

"~/.ssh/id_rsa"

local.starship.enable

Whether to enable Starship prompt configuration.

Type: boolean

Default:

false

Example:

true

local.stylix.enable

Whether to enable Stylix automatic theming system based on wallpaper colors.

Type: boolean

Default:

false

Example:

true

local.superfile.enable

Whether to enable Superfile terminal-based file manager with style.

Type: boolean

Default:

false

Example:

true

local.variables.enable

Enable system environment variables for common tools and applications

Type: boolean

Default:

true

local.variables.browser

Default web browser

Type: string

Default:

"firefox"

Example:

"chromium"

local.variables.editor

Default terminal text editor

Type: string

Default:

"nvim"

Example:

"vim"

local.variables.fileManager

Default terminal file manager

Type: string

Default:

"ranger"

Example:

"lf"

local.variables.guiEditor

Default GUI text editor

Type: string

Default:

"neovide"

Example:

"code"

local.variables.guiFileManager

Default GUI file manager

Type: string

Default:

"nautilus"

Example:

"nautilus"

local.variables.launcher

Default application launcher command

Type: string

Default:

"rofi -show drun"

Example:

"wofi --show drun"

local.variables.statusBar

Default status bar or panel application

Type: string

Default:

"hyprpanel"

Example:

"waybar"

local.variables.terminal

Default terminal emulator

Type: string

Default:

"kitty"

Example:

"alacritty"

local.variables.wallpaper

Default wallpaper daemon or manager

Type: string

Default:

"hyprpaper"

Example:

"swaybg"

local.waybar.enable

Whether to enable Waybar status bar for Wayland compositors.

Type: boolean

Default:

false

Example:

true

local.yazi.enable

Whether to enable enable yazi.

Type: boolean

Default:

false

Example:

true