nix-config docs

Options Atlas

Scan the system, pin the details, trace every declaration.

0options
Total options
267
Top-level groups
6
GitHub issues
Report a problem
  • libattribute set of (attribute set)This option allows modules to define helper functions, constants, etc.nixos/modules/misc/lib.nix
  • michal
    • assets
      • enablebooleanWhether to enable assets (wallpapers).assets
    • audio
      • enablebooleanWhether to enable audio subsystem (PipeWire + utilities).modules/audio.nix
      • guiToolsbooleanInstall GUI audio tools (pavucontrol, qpwgraph, helvum)modules/audio.nix
    • browsers
      • chromeunknown
      • firefoxunknown
      • zenunknown
    • dev
      • enablebooleanWhether to enable development tools.modules/dev
    • environment
    • graphical
    • impurity
    • monitorslist of (submodule)List of monitor configurationsmodules/gui-packages/monitors.nix
      • *
    • network
      • cloudflare-warp
    • programs
      • ags
      • alacrittyunknown
      • bitwarden
      • borg
      • docker
      • ghosttyunknown
      • godot
      • kde-connect
      • obs-studio
      • ollama
      • podman
      • remote-desktop
      • steam
      • tailscale
      • unity
      • ventoy
      • walker
      • waybar
    • services
      • adguardhome
      • battery
      • home-assistant
      • homepage
      • n8n
      • proxy
    • sshKeys
      • personal
      • work
    • themeattribute set of stringKeyed colors. Assume #RRGGBB. Names like primary, surface.modules/theme
    • wifi
  • programsattribute set of anythingStub programs namespace for docs generation.
  • sops
    • age
      • generateKeybooleanWhether or not to generate the age key. If this option is set to false, the key must already be present at the specified location.modules/sops
      • keyFilenull or path not in the Nix storePath to age key file used for sops decryption.modules/sops
      • pluginslist of packageList of plugins to use for sops decryption.modules/sops
      • sshKeyPathslist of absolute pathPaths to ssh keys added as age keys during sops description.modules/sops
    • defaultSopsFileabsolute pathDefault sops file used for all secrets.modules/sops
    • defaultSopsFormatstringDefault sops format used for all secrets.modules/sops
    • defaultSopsKeynull or stringDefault key used to lookup in all secrets. This option is ignored if format is binary. "" means whole file.modules/sops
    • environmentattribute set of (string or absolute path)Environment variables to set before calling sops-install-secrets. The values are placed in single quotes and not escaped any further to allow usage of command substitutions for more flexibility. To properly quote strings with quotes use lib.escapeShellArg. This will be evaluated twice when using secrets that use neededForUsers but in a subshell each time so the environment variables don't collide.modules/sops
    • gnupg
      • homenull or stringPath to gnupg database directory containing the key for decrypting the sops file.modules/sops
      • packagepackageThe gnupg package to use for sops operations.modules/sops
      • sshKeyPathslist of absolute pathPath to ssh keys added as GPG keys during sops description. This option must be explicitly unset if <literal>config.sops.gnupg.home</literal> is set.modules/sops
    • keepGenerationsunsigned integer, meaning >=0Number of secrets generations to keep. Setting this to 0 disables pruning.modules/sops
    • loglist of (one of "keyImport", "secretChanges")What to logmodules/sops
    • packagepackagesops-install-secrets package to use.modules/sops
    • secretsattribute set of (submodule)Path where the latest secrets are mounted to.modules/sops
      • <name>
    • templatesattribute set of (submodule)Templates for secret filesmodules/sops/templates
      • <name>
    • useSystemdActivationbooleanUse a systemd unit to install secrets, instead of deploying them using an activation script. This option is automatically enabled when systemd-sysusers or userborn are used to manage users and groups. It can also be useful to specify additional dependencies to be satisfied before secrets are installed, such as required mountpoints for SOPS key files.modules/sops
    • useTmpfsbooleanUse tmpfs in place of ramfs for secrets storage. *WARNING* On Linux kernels earlier than 6.4, enabling this option has the potential to write secrets to disk unencrypted if the tmpfs volume is written to swap. Do not use unless absolutely necessary. When using a swap file or device, consider enabling swap encryption by setting the `randomEncryption.enable` option ``` swapDevices = [{ device = "/dev/sdXY"; randomEncryption.enable = true; }]; ```modules/sops
    • validateSopsFilesbooleanCheck all sops files at evaluation time. This requires sops files to be added to the nix store.modules/sops
    • validationPackagepackagesops-install-secrets package to use when validating configuration. Defaults to sops.package if building natively, and a native version of sops-install-secrets if cross compiling.modules/sops
  • stylix
    • autoEnablebooleanWhether to enable targets by default. When this is `false`, all targets are disabled unless explicitly enabled. When this is `true`, most targets are enabled by default. A small number remain off by default, because they require further manual setup, or they are only applicable in specific circumstances which cannot be detected automatically.stylix/target.nix
    • base16Schemeabsolute path or strings concatenated with "\n" or (attribute set)A scheme following the base16 standard. This can be a path to a file, a string of YAML, or an attribute set.stylix/palette.nix
    • cursornull or (submodule)Attributes defining the systemwide cursor. Set either all or none of these attributes.stylix/cursor.nix
    • enablebooleanWhether to enable Stylix. When this is `false`, all theming is disabled and all other options are ignored.stylix/target.nix
    • enableReleaseChecksbooleanWhether to check that the Stylix release matches the releases of NixOS, Home Manager, and nix-darwin. Checks are only performed if the component in question is used. If this option is enabled and a mismatch is detected, a warning will be printed when the user configuration is being built.stylix/release.nix
    • fonts
      • emoji
      • monospace
      • packageslist of packageA list of all the font packages that will be installed.stylix/fonts.nix
      • sansSerif
      • serif
      • sizes
    • homeManagerIntegration
      • autoImportbooleanWhether to import Stylix automatically for every Home Manager user. This only works if you are using `home-manager.users.«name»` within your NixOS configuration, rather than running Home Manager independently.stylix/home-manager-integration.nix
      • followSystembooleanWhen this option is `true`, Home Manager configurations will follow the NixOS configuration by default, rather than using the standard default settings. This only applies to Home Manager configurations managed by [`stylix.homeManagerIntegration.autoImport`](#stylixhomemanagerintegrationautoimport).stylix/home-manager-integration.nix
    • icons
    • imagenull or (path in the Nix store or absolute path convertible to it)Wallpaper image. This is set as the background of your desktop environment, if possible, and used to generate a colour scheme if you don't set one manually.stylix/palette.nix
    • imageScalingModeone of "stretch", "fill", "fit", "center", "tile"Scaling mode for the wallpaper image. `stretch` : Stretch the image to cover the screen. `fill` : Scale the image to fill the screen, potentially cropping it. `fit` : Scale the image to fit the screen without being cropped. `center` : Center the image without resizing it. `tile` : Tile the image to cover the screen.stylix/palette.nix
    • opacity
      • applicationsfloating point numberThe opacity of the windows of applications, the amount of applications supported is currently limitedstylix/opacity.nix
      • desktopfloating point numberThe opacity of the windows of bars/widgets, the amount of applications supported is currently limitedstylix/opacity.nix
      • popupsfloating point numberThe opacity of the windows of notifications/popups, the amount of applications supported is currently limitedstylix/opacity.nix
      • terminalfloating point numberThe opacity of the windows of terminals, this works across all terminals supported by stylixstylix/opacity.nix
    • overlays
    • overrideattribute setAn override that will be applied to stylix.base16Scheme when generating config.lib.stylix.colors. Takes anything that a scheme generated by base16nix can take as argument to override.stylix/palette.nix
    • polarityone of "either", "light", "dark"Use this option to force a light or dark theme. By default we will select whichever is ranked better by the genetic algorithm. This aims to get good contrast between the foreground and background, as well as some variety in the highlight colours.stylix/palette.nix
    • targets
      • chromium
      • console
      • feh
      • fish
      • font-packages
      • fontconfig
      • glance
      • gnome-text-editor
      • gnome
      • grub
      • gtk
      • gtksourceview
      • kmscon
      • lightdm
      • limine
      • nixos-icons
      • nixvim
      • nvf
      • plymouth
      • qt
      • regreet
      • spicetify
Active option

Pick something on the left

Click any option name to spotlight its details, defaults, and declaration trail.