Skip to content

NixOS Module Options#

generated with nix-options-doc

options.huntarr.enable#

Huntarr media management service

Type: boolean

Default: false

Example: true

options.huntarr.openFirewall#

Open firewall for Huntarr

Type: lib.types.bool

Default: false

options.huntarr.port#

Port for Huntarr web interface

Type: lib.types.port

Default: 9705

options.tsunaminoai.apple.clock24h#

Use 24-hour clock

Type: boolean

Default: false

Example: true

options.tsunaminoai.apple.remapCapsLockToEscape#

Remap Caps Lock to Escape

Type: boolean

Default: false

Example: true

options.tsunaminoai.borg.enable#

Enable borg backups

Type: boolean

Default: false

Example: true

options.tsunaminoai.borg.enableCron#

Enable cron job for borgwarehouse

Type: boolean

Default: false

Example: true

options.tsunaminoai.borg.hostname#

Repo key for voile.

Type: str

options.tsunaminoai.borg.repo#

Repo key for voile.

Type: str

options.tsunaminoai.core.domain#

Domain to use with hostnames throughout the flake

Type: lib.types.str

Default: "gensokyo"

options.tsunaminoai.desktop.appIds#

List of desktop applications to install

Type: lib.types.listOf lib.types.str

Default: defautApplications

options.tsunaminoai.desktop.enable#

Enable desktop environment configuration

Type: boolean

Default: false

Example: true

options.tsunaminoai.desktop.enableVNC#

Enable VNC server

Type: boolean

Default: false

Example: true

options.tsunaminoai.desktop.razer.enable#

Enables Razer product support

Type: boolean

Default: false

Example: true

options.tsunaminoai.desktop.windowManager#

The window manager to use.

Type: types.enum ["sway" "plasma"]

Default: "plasma"

options.tsunaminoai.flatpak.autoUpdate#

Enable autoupdates

Type: bool

Default: true

options.tsunaminoai.flatpak.enable#

Enable flatpak support

Type: bool

Default: false

options.tsunaminoai.flatpak.extraApps#

List of Flatpak apps to install system-wide

Type: listOf str

Default: []

Example: ["org.mozilla.firefox" "org.libreoffice.LibreOffice"]

options.tsunaminoai.flatpak.withRecommended#

Enable recommended Apps

Type: boolean

Default: false

Example: true

options.tsunaminoai.fonts.enable#

Enable font configuration

Type: bool

Default: false

options.tsunaminoai.homer.domain#

Domain to use at the end of the hostName (currently unused)

Type: types.nullOr types.str

Default: null

options.tsunaminoai.homer.enable#

Expose a Homer dashboard on this host

Type: boolean

Default: false

Example: true

options.tsunaminoai.homer.extraOptions#

Extra top level Homer options See Homer Documentation

Type: types.attrs

Default: defaultConfig

options.tsunaminoai.homer.hostName#

Virtual host served by Nginx for the dashboard.

Type: types.str

Default: "localhost"

Declarative list of dashboard tiles (Homer links).

Type: types.listOf linkOption

Default: []

options.tsunaminoai.homer.openFirewall#

Whether to automatically open the chosen port in networking.firewall.allowedTCPPorts. Disable if you expose Homer only behind a reverse proxy or VPN.

Type: types.bool

Default: true

options.tsunaminoai.homer.port#

TCP port Nginx listens on for the dashboard.

Type: types.port

Default: 8080

options.tsunaminoai.homer.services#

Declarive list of dashboard services See Homer Documentation

Type: types.listOf types.attrs

Default: []

options.tsunaminoai.media.acquisition.appDataDir#

Directory to store application data

Type: types.str

Default: "/mnt/voile/Inaba/Yunohost/yunohost.app"

options.tsunaminoai.media.acquisition.enable#

enables media pipeline

Type: boolean

Default: false

Example: true

options.tsunaminoai.media.acquisition.group#

Group to use for acuisition services

Type: types.str

Default: media-user.group

options.tsunaminoai.media.acquisition.mediaDir#

Directory to store and serve media data

Type: types.str

Default: "/var/lib/media"

options.tsunaminoai.media.acquisition.user#

User to use for acquisition services

Type: types.str

Default: media-user.username

options.tsunaminoai.media.server.audio#

Enable audio and music services

Type: boolean

Default: false

Example: true

options.tsunaminoai.media.server.books#

Enable eBook services

Type: boolean

Default: false

Example: true

options.tsunaminoai.media.server.enable-portal#

Enable portal for media services

Type: boolean

Default: false

Example: true

options.tsunaminoai.media.server.tdarr.cpuWorkers#

Number of CPU workers to use for transcoding and health checks

Type: lib.types.int

Default: 1

options.tsunaminoai.media.server.tdarr.enable#

Enable tdarr transcoding services

Type: boolean

Default: false

Example: true

options.tsunaminoai.media.server.tdarr.gpuWorkers#

Number of GPU workers to use for transcoding and health checks

Type: lib.types.int

Default: 0

options.tsunaminoai.media.server.tdarr.isServer#

Enable server node (as opposed to a worker node)

Type: boolean

Default: false

Example: true

options.tsunaminoai.media.server.video#

Enable video services

Type: boolean

Default: false

Example: true

options.tsunaminoai.news.autoReload#

Enable auto reload

Type: boolean

Default: false

Example: true

options.tsunaminoai.news.enable#

Enable newsboat

Type: boolean

Default: false

Example: true

options.tsunaminoai.news.reloadTime#

Time in minutes to reload feeds

Type: lib.types.int

Default: 15

options.tsunaminoai.news.urls#

List of feeds to follow

Type:

lib.types.listOf (lib.types.submodule {
  options = {
    url = lib.mkOption {
      type = lib.types.str;
      description = "URL of the feed";
    };
    tags = lib.mkOption {
      type = lib.types.listOf lib.types.str;
      default = [];
      description = "Tags to add to the feed";
    };
    title = lib.mkOption {
      type = lib.types.str;
      description = "Title of the feed";
    };
  };
})

Default: []

options.tsunaminoai.nix._internal.allBuilders#

Type: listOf anything

Default: allBuilders

options.tsunaminoai.nix._internal.binaryCaches#

Type:

listOf (submodule {
  options = {
    url = lib.mkOption {type = str;};
    host = lib.mkOption {type = str;};
    pubkey = lib.mkOption {type = str;};
  };
})

Default: binaryCaches

options.tsunaminoai.nix.allowUnfree#

Enable unfree packages

Type: boolean

Default: false

Example: true

options.tsunaminoai.nix.allowed-users#

Users allowed to access the nix cache

Type: listOf str

Default: ["root" "builder" "@nixbld" "@wheel" "nix-serve"]

options.tsunaminoai.nix.builds#

Nix builder options

Type:

submodule {
  options = {
    enable = lib.mkEnableOption "Set this host as a nix builder";
    speedFactor = lib.mkOption {
      description = "Speed factor for the builder";
      type = int;
      default = 1;
    };
    extraBuildSystems = lib.mkOption {
      description = "Extra systems this host can build";
      type = listOf str;
      default = [];
    };
  };
}

options.tsunaminoai.nix.dev#

Enable nix development tools

Type: boolean

Default: false

Example: true

options.tsunaminoai.nix.docs#

Enable documentation building

Type: lib.types.bool

Default: true

options.tsunaminoai.nix.enabledBuilders#

Attrset of hosts with builds.enable = true

Type: attrsOf anything

Default: {}

options.tsunaminoai.nix.isCache#

Set this host as a nix cache

Type: boolean

Default: false

Example: true

options.tsunaminoai.nix.isDeployNode#

Set this host as the deploy node. This installs the deployment key for root

Type: boolean

Default: false

Example: true

options.tsunaminoai.nvidia.enable#

Enable nvidia cards

Type: boolean

Default: false

Example: true

options.tsunaminoai.radio.allowedUsers#

List of users to allow on SDR

Type: listOf str

Default: []

options.tsunaminoai.radio.enable#

Enable SDR radios

Type: bool

Default: false

options.tsunaminoai.razer-mouse.enable#

Razer mouse desktop switcher

Type: boolean

Default: false

Example: true

options.tsunaminoai.razer-mouse.package#

The package to use for mouse button remapping

Type: types.enum ["karabiner-elements"]

Default: "karabiner-elements"

options.tsunaminoai.rdp.defaultWindowManager#

The default window manager to use for RDP sessions

Type: types.str

Default: "${pkgs.icewm}/bin/icewm"

options.tsunaminoai.rdp.enable#

RDP support

Type: boolean

Default: false

Example: true

options.tsunaminoai.rdp.openFirewall#

Whether to open the firewall for RDP

Type: types.bool

Default: true

options.tsunaminoai.samba.enable#

enables samba connectivity with Voile

Type: boolean

Default: false

Example: true

options.tsunaminoai.security.gpg.agentTimeout#

The amount of time to wait before continuing with shell init

Type: int

Default: 5

options.tsunaminoai.security.gpg.enable#

Enable GPG

Type: boolean

Default: false

Example: true

options.tsunaminoai.security.openssh.disable#

Disable SSH

Type: boolean

Default: false

Example: true

options.tsunaminoai.servarr.enable#

enables media aquisition

Type: boolean

Default: false

Example: true

options.tsunaminoai.spotify.enable#

Enable spotify daemon

Type: boolean

Default: false

Example: true

options.tsunaminoai.tailscale.authKeyFile#

The path to the sops-encrypted file containing the Tailscale auth key

Type: types.str

Default: config.sops.secrets."tailscale/auth-key".path

options.tsunaminoai.tailscale.enable#

Tailscale autoconnect

Type: boolean

Default: false

Example: true

options.tsunaminoai.tailscale.extraSetFlags#

Extra flags to pass to ‘tailscale set

Type: types.listOf types.str

Default: []

options.tsunaminoai.tailscale.extraUpFlags#

Extra flags to pass to ‘tailscale up

Type: types.listOf types.str

Default: []

options.tsunaminoai.tailscale.useExit#

Use the exit nodes

Type: boolean

Default: false

Example: true

options.tsunaminoai.users.media.enable#

Enable media user

Type: boolean

Default: false

Example: true

options.tsunaminoai.users.media.gid#

GID for media user

Type: lib.types.int

Default: 100001

options.tsunaminoai.users.media.group#

group name for media user

Type: lib.types.str

Default: "nix-media-sops"

options.tsunaminoai.users.media.homeDir#

Path for media’s home dir. Will not be created.

Type: lib.types.path

Default: "/mnt/voile/Inaba/Yunohost/"

options.tsunaminoai.users.media.uid#

UID for media user

Type: lib.types.int

Default: 100021

options.tsunaminoai.users.media.username#

user name for media user

Type: lib.types.str

Default: "nix-media-sops"

options.tsunaminoai.virtualization.enable#

Enable virtualization

Type: boolean

Default: false

Example: true


Generated with nix-options-doc