orangc's Flake Documentation

modules.core.users.home-manager.stateVersion Link copied!

Type: string

The state version of home-manager to use for all automatically declared users on this machine

Default: "26.05"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/core/users.nix

modules.desktop.compositors.hyprland.enable Link copied!

Type: boolean

Whether to enable Enable hyprland.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/desktop/compositors/hyprland.nix

modules.desktop.display-managers.sddm.enable Link copied!

Type: boolean

Whether to enable Enable SDDM.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/desktop/display-managers/sddm.nix

modules.desktop.display-managers.sddm.theme Link copied!

Type: string

The SDDM theme to use

Default: "sddm-astronaut-theme"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/desktop/display-managers/sddm.nix

Type: string

An example option

Default: "example"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/programs/syncthing.nix

modules.security.restic.enable Link copied!

Type: boolean

Whether to enable Enable restic backups.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/security/restic.nix

modules.security.restic.keepLast Link copied!

Type: signed integer

Number of snapshots (of backups) to keep

Default: 5

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/security/restic.nix

modules.security.restic.paths Link copied!

Type: list of string

Paths to files/folders to backup

Default: [ ]

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/security/restic.nix

modules.security.restic.repository Link copied!

Type: string

Location of the restic repository to backup to

Default: "/mnt/backup"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/security/restic.nix

modules.security.sops.enable Link copied!

Type: boolean

Whether to enable Enable sops-nix secret management.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/security/sops.nix

modules.security.sops.secrets Link copied!

Type: attribute set of (submodule)

Alias of sops.secrets.

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/security/sops.nix

modules.security.sops.secrets.<name>.format Link copied!

Type: one of "yaml", "json", "binary", "dotenv", "ini"

File format used to decrypt the sops secret. Binary files are written to the target file as is.

Default: "yaml"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.gid Link copied!

Type: null or signed integer

GID of the file, only applied when group is null. The GID will be applied even if the corresponding group doesn't exist.

Default: 0

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.group Link copied!

Type: null or string

Group of the file. Can only be set if gid is 0.

Default: {option}`config.users.users.${owner}.group`

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.key Link copied!

Type: string

Key used to lookup in the sops file. No tested data structures are supported right now. This option is ignored if format is binary. "" means whole file.

Default: "‹name›"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.mode Link copied!

Type: string

Permissions mode of the in octal.

Default: "0400"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.name Link copied!

Type: string

Name of the file used in /run/secrets

Default: "‹name›"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.neededForUsers Link copied!

Type: boolean

Enabling this option causes the secret to be decrypted before users and groups are created. This can be used to retrieve user's passwords from sops-nix. Setting this option moves the secret to /run/secrets-for-users and disallows setting owner and group to anything else than root.

Default: false

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.owner Link copied!

Type: null or string

User of the file. Can only be set if uid is 0.

Default: null

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.path Link copied!

Type: string

Path where secrets are symlinked to. If the default is kept no symlink is created.

Default: "/run/secrets-for-users/$name when neededForUsers is set, /run/secrets/$name when otherwise."

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.reloadUnits Link copied!

Type: list of string

Names of units that should be reloaded when this secret changes. This works the same way as <xref linkend="opt-systemd.services.name.reloadTriggers" />.

Default: [ ]

Example:

[
  "sshd.service"
]

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.restartUnits Link copied!

Type: list of string

Names of units that should be restarted when this secret changes. This works the same way as <xref linkend="opt-systemd.services.name.restartTriggers" />.

Default: [ ]

Example:

[
  "sshd.service"
]

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.sopsFile Link copied!

Type: absolute path

Sops file the secret is loaded from.

Default: ${config.sops.defaultSopsFile}

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.sopsFileHash Link copied!

read-only

Type: string

Hash of the sops file, useful in <xref linkend="opt-systemd.services.name.restartTriggers" />.

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sops.secrets.<name>.uid Link copied!

Type: null or signed integer

UID of the file, only applied when owner is null. The UID will be applied even if the corresponding user doesn't exist.

Default: 0

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

modules.security.sudo-rs Link copied!

Type: submodule

Alias of security.sudo-rs.

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/security/sudo-rs.nix

modules.services.databases.couchdb.enable Link copied!

Type: boolean

Whether to enable CouchDB Server.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/databases/couchdb.nix

modules.services.databases.postgresql.databases Link copied!

Type: list of string

Names of database to ensure exist in PostgreSQL.

Default: [ ]

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/databases/postgresql.nix

modules.services.databases.postgresql.enable Link copied!

Type: boolean

Whether to enable Enable postgresql.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/databases/postgresql.nix

modules.services.databases.postgresql.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port for postgresql to be hosted at

Default: 5432

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/databases/postgresql.nix

modules.services.databases.postgresql.users Link copied!

Type: list of string

Names of users to ensure exist in PostgreSQL.

Default: [ ]

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/databases/postgresql.nix

Type: string

The icon for Copyparty to be displayed in the Glance dashboard.

Default: "sh:copyparty"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/copyparty.nix

modules.services.files.copyparty.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Copyparty at files.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/copyparty.nix

modules.services.files.copyparty.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Copyparty"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/copyparty.nix

modules.services.files.copyparty.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Copyparty goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/copyparty.nix

modules.services.files.copyparty.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Copyparty is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/copyparty.nix

modules.services.files.copyparty.subdomain Link copied!

Type: string

The domain at which Copyparty is hosted at.

Default: "files"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/copyparty.nix

Type: string

The icon for Cryptpad to be displayed in the Glance dashboard.

Default: "sh:cryptpad"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/cryptpad.nix

modules.services.files.cryptpad.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Cryptpad at pad.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/cryptpad.nix

modules.services.files.cryptpad.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Cryptpad"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/cryptpad.nix

modules.services.files.cryptpad.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Cryptpad goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/cryptpad.nix

modules.services.files.cryptpad.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Cryptpad is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/cryptpad.nix

modules.services.files.cryptpad.subdomain Link copied!

Type: string

The domain at which Cryptpad is hosted at.

Default: "pad"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/cryptpad.nix

Type: string

The icon for Microbin to be displayed in the Glance dashboard.

Default: "sh:microbin"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/microbin.nix

modules.services.files.microbin.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Microbin at bin.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/microbin.nix

modules.services.files.microbin.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Microbin"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/microbin.nix

modules.services.files.microbin.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Microbin goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/microbin.nix

modules.services.files.microbin.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Microbin is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/microbin.nix

modules.services.files.microbin.subdomain Link copied!

Type: string

The domain at which Microbin is hosted at.

Default: "bin"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/microbin.nix

Type: string

The icon for Wastebin to be displayed in the Glance dashboard.

Default: "sh:wastebin"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/wastebin.nix

modules.services.files.wastebin.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Wastebin at bin.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/wastebin.nix

modules.services.files.wastebin.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Wastebin"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/wastebin.nix

modules.services.files.wastebin.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Wastebin goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/wastebin.nix

modules.services.files.wastebin.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Wastebin is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/wastebin.nix

modules.services.files.wastebin.subdomain Link copied!

Type: string

The domain at which Wastebin is hosted at.

Default: "bin"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/wastebin.nix

Type: string

The icon for Zipline to be displayed in the Glance dashboard.

Default: "https://cdn.jsdelivr.net/gh/selfhst/icons/png/zipline.png"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/zipline.nix

modules.services.files.zipline.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Zipline at zip.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/files/zipline.nix

modules.services.gaming.minecraft.juniper-s10.gamerules Link copied!

Type: attribute set

Server gamerules

Default:

{
  commandBlockOutput = false;
  commandModificationBlockLimit = 1000;
  keepInventory = true;
}

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/season-10.nix

modules.services.gaming.minecraft.juniper-s10.maxRAM Link copied!

Type: signed integer

Maximum amount of RAM for Juniper to use in gigabytes

Default: 8

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/season-10.nix

modules.services.gaming.minecraft.juniper-s10.minRAM Link copied!

Type: signed integer

Minimum amount of RAM for Juniper to use in gigabytes

Default: 4

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/season-10.nix

modules.services.gaming.minecraft.juniper-s10.motd Link copied!

Type: string

The message displayed in the server list of the client

Default: "Powered by NixOS!"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/season-10.nix

modules.services.gaming.minecraft.juniper-s10.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port for Juniper to be hosted at

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/season-10.nix

modules.services.gaming.minecraft.juniper-s11.automatic-backups.enable Link copied!

Type: boolean

Whether to enable Automatically backup and prune the server.

Default: false

Example: true

Declared in:

/nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/utilities/automatic-backups.nix

modules.services.gaming.minecraft.juniper-s11.automatic-backups.frequency Link copied!

Type: string

The frequency of which to perform backups and prunes

Default: "daily"

Declared in:

/nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/utilities/automatic-backups.nix

modules.services.gaming.minecraft.juniper-s11.enable Link copied!

Type: boolean

Whether to enable Enable Juniper SMP server.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/season-11.nix

modules.services.gaming.minecraft.juniper-s11.gamerules Link copied!

Type: attribute set

Server gamerules

Default:

{
  commandBlockOutput = false;
  commandModificationBlockLimit = 1000;
  keepInventory = true;
}

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/season-11.nix

modules.services.gaming.minecraft.juniper-s11.maxRAM Link copied!

Type: signed integer

Maximum amount of RAM for Juniper to use in gigabytes

Default: 8

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/season-11.nix

modules.services.gaming.minecraft.juniper-s11.minRAM Link copied!

Type: signed integer

Minimum amount of RAM for Juniper to use in gigabytes

Default: 4

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/season-11.nix

modules.services.gaming.minecraft.juniper-s11.motd Link copied!

Type: string

The message displayed in the server list of the client

Default: "Powered by NixOS!"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/season-11.nix

modules.services.gaming.minecraft.juniper-s11.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port for Juniper to be hosted at

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/gaming/minecraft/servers/juniper/season-11.nix

modules.services.infrastructure.caddy.enable Link copied!

Type: boolean

Whether to enable Enable Caddy.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/infrastructure/caddy.nix

modules.services.infrastructure.caddy.virtualHosts Link copied!

Type: attribute set of (open submodule of (attribute set))

Collect virtual host entries from other modules

Default: { }

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/infrastructure/caddy.nix

modules.services.infrastructure.cloudflared.enable Link copied!

Type: boolean

Whether to enable Enable Cloudflared.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/infrastructure/cloudflared.nix

modules.services.infrastructure.cloudflared.ingress Link copied!

Type: attribute set of string

Collect ingress entries from other modules

Default: { }

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/infrastructure/cloudflared.nix

modules.services.infrastructure.duckdns.enable Link copied!

Type: boolean

Whether to enable Enable duckdns.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/infrastructure/duckdns.nix

modules.services.infrastructure.tailscale.enable Link copied!

Type: boolean

Whether to enable Enable tailscale.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/infrastructure/tailscale.nix

modules.services.infrastructure.tailscale.name Link copied!

Type: string

This option has no description.

Default: "Tailscale"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/infrastructure/tailscale.nix

modules.services.infrastructure.technitium.enable Link copied!

Type: boolean

Whether to enable Enable technitium.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/infrastructure/technitium.nix

Type: string

The icon for Immich to be displayed in the Glance dashboard.

Default: "sh:immich"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/immich.nix

modules.services.media.immich.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Immich at media.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/immich.nix

modules.services.media.immich.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Immich"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/immich.nix

modules.services.media.immich.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Immich goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/immich.nix

modules.services.media.immich.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Immich is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/immich.nix

modules.services.media.immich.subdomain Link copied!

Type: string

The domain at which Immich is hosted at.

Default: "media"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/immich.nix

Type: string

The icon for Jellyfin to be displayed in the Glance dashboard.

Default: "sh:jellyfin"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/jellyfin.nix

modules.services.media.jellyfin.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Jellyfin at jf.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/jellyfin.nix

modules.services.media.jellyfin.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Jellyfin"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/jellyfin.nix

modules.services.media.jellyfin.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Jellyfin goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/jellyfin.nix

modules.services.media.jellyfin.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Jellyfin is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/jellyfin.nix

modules.services.media.jellyfin.subdomain Link copied!

Type: string

The domain at which Jellyfin is hosted at.

Default: "jf"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/jellyfin.nix

Type: string

The icon for Kavita to be displayed in the Glance dashboard.

Default: "sh:kavita"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/kavita.nix

modules.services.media.kavita.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Kavita at read.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/kavita.nix

modules.services.media.kavita.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Kavita"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/kavita.nix

modules.services.media.kavita.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Kavita goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/kavita.nix

modules.services.media.kavita.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Kavita is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/kavita.nix

modules.services.media.kavita.subdomain Link copied!

Type: string

The domain at which Kavita is hosted at.

Default: "read"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/kavita.nix

Type: string

The icon for Linkwarden to be displayed in the Glance dashboard.

Default: "sh:linkwarden"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/linkwarden.nix

modules.services.media.linkwarden.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Linkwarden at links.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/linkwarden.nix

modules.services.media.linkwarden.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Linkwarden"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/linkwarden.nix

modules.services.media.linkwarden.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Linkwarden goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/linkwarden.nix

modules.services.media.linkwarden.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Linkwarden is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/linkwarden.nix

modules.services.media.linkwarden.subdomain Link copied!

Type: string

The domain at which Linkwarden is hosted at.

Default: "links"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/linkwarden.nix

modules.services.media.nixflix.enable Link copied!

Type: boolean

Whether to enable Enable nixflix.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

modules.services.media.nixflix.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port 'range' to use. Services in nixflix will use a port starting from here and adding +1

Default: 4520

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

Type: string

The icon for Matrix Synapse to be displayed in the Glance dashboard.

Default: "auto-invert sh:matrix"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/matrix-synapse.nix

modules.services.misc.matrix-synapse.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Matrix Synapse at matrix.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/matrix-synapse.nix

modules.services.misc.matrix-synapse.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Matrix Synapse"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/matrix-synapse.nix

modules.services.misc.matrix-synapse.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Matrix Synapse goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/matrix-synapse.nix

modules.services.misc.matrix-synapse.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Matrix Synapse is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/matrix-synapse.nix

modules.services.misc.matrix-synapse.serverName Link copied!

Type: string

Matrix server name (used in MXIDs)

Default: "orangc.net"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/matrix-synapse.nix

modules.services.misc.matrix-synapse.subdomain Link copied!

Type: string

The domain at which Matrix Synapse is hosted at.

Default: "matrix"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/matrix-synapse.nix

Type: string

The icon for Miniflux to be displayed in the Glance dashboard.

Default: "auto-invert sh:miniflux"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/miniflux.nix

modules.services.misc.miniflux.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Miniflux at feed.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/miniflux.nix

modules.services.misc.miniflux.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Miniflux"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/miniflux.nix

modules.services.misc.miniflux.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Miniflux goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/miniflux.nix

modules.services.misc.miniflux.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Miniflux is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/miniflux.nix

modules.services.misc.miniflux.subdomain Link copied!

Type: string

The domain at which Miniflux is hosted at.

Default: "feed"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/miniflux.nix

Type: string

The icon for Moodle to be displayed in the Glance dashboard.

Default: "sh:moodle"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/moodle.nix

modules.services.misc.moodle.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Moodle at Moodle.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/moodle.nix

modules.services.misc.moodle.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Moodle"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/moodle.nix

modules.services.misc.moodle.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Moodle goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/moodle.nix

modules.services.misc.moodle.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Moodle is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/moodle.nix

modules.services.misc.moodle.subdomain Link copied!

Type: string

The domain at which Moodle is hosted at.

Default: "moodle"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/moodle.nix

modules.services.misc.takina.enable Link copied!

Type: boolean

Whether to enable Takina Discord bot.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/takina.nix

Type: string

The icon for Vaultwarden to be displayed in the Glance dashboard.

Default: "auto-invert sh:vaultwarden"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/vaultwarden.nix

modules.services.misc.vaultwarden.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Vaultwarden at vault.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/vaultwarden.nix

modules.services.misc.vaultwarden.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Vaultwarden"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/vaultwarden.nix

modules.services.misc.vaultwarden.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Vaultwarden goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/vaultwarden.nix

modules.services.misc.vaultwarden.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Vaultwarden is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/vaultwarden.nix

modules.services.misc.vaultwarden.subdomain Link copied!

Type: string

The domain at which Vaultwarden is hosted at.

Default: "vault"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/vaultwarden.nix

Type: string

The icon for ChangeDetection to be displayed in the Glance dashboard.

Default: "sh:changedetection"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/changedetection.nix

modules.services.monitoring.changedetection.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for ChangeDetection at detect.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/changedetection.nix

modules.services.monitoring.changedetection.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "ChangeDetection"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/changedetection.nix

modules.services.monitoring.changedetection.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this ChangeDetection goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/changedetection.nix

modules.services.monitoring.changedetection.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which ChangeDetection is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/changedetection.nix

modules.services.monitoring.changedetection.subdomain Link copied!

Type: string

The domain at which ChangeDetection is hosted at.

Default: "detect"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/changedetection.nix

Type: string

The icon for Glance to be displayed in the Glance dashboard.

Default: "sh:glance"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/glance.nix

modules.services.monitoring.glance.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Glance at Glance.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/glance.nix

modules.services.monitoring.glance.monitoredSites Link copied!

Type: list of (attribute set)

Collect services definitions from different modules

Default: [ ]

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/glance.nix

modules.services.monitoring.glance.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Glance"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/glance.nix

modules.services.monitoring.glance.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Glance goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/glance.nix

modules.services.monitoring.glance.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Glance is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/glance.nix

modules.services.monitoring.glance.subdomain Link copied!

Type: string

The domain at which Glance is hosted at.

Default: "glance"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/glance.nix

Type: string

The icon for Grafana to be displayed in the Glance dashboard.

Default: "sh:grafana"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/grafana.nix

modules.services.monitoring.grafana.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Grafana at Grafana.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/grafana.nix

modules.services.monitoring.grafana.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Grafana"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/grafana.nix

modules.services.monitoring.grafana.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Grafana goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/grafana.nix

modules.services.monitoring.grafana.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Grafana is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/grafana.nix

modules.services.monitoring.grafana.subdomain Link copied!

Type: string

The domain at which Grafana is hosted at.

Default: "grafana"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/grafana.nix

modules.services.monitoring.ntfy.acl Link copied!

Type: list of string

Access control rules for individual topics.

Default: [ ]

Example:

[
  "user:topic:perm"
  "orangc:food:write"
  "reimu:touhou:read"
  "cirno:frogs:read-write"
]

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/ntfy/default.nix

Type: string

This option has no description.

Default: "services"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/ntfy/scripts/services.nix

modules.services.monitoring.ntfy.subdomain Link copied!

Type: string

The domain at which Ntfy is hosted at.

Default: "ntfy"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/ntfy/default.nix

Type: string

The icon for Scrutiny to be displayed in the Glance dashboard.

Default: "auto-invert sh:scrutiny"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/scrutiny.nix

modules.services.monitoring.scrutiny.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Scrutiny at Scrutiny.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/scrutiny.nix

modules.services.monitoring.scrutiny.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Scrutiny"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/scrutiny.nix

modules.services.monitoring.scrutiny.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Scrutiny goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/scrutiny.nix

modules.services.monitoring.scrutiny.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Scrutiny is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/scrutiny.nix

modules.services.monitoring.scrutiny.subdomain Link copied!

Type: string

The domain at which Scrutiny is hosted at.

Default: "scrutiny"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/scrutiny.nix

Type: string

The icon for Speedtest Tracker to be displayed in the Glance dashboard.

Default: "sh:speedtest-tracker"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/speedtest.nix

modules.services.monitoring.speedtest.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Speedtest Tracker at speedtest.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/speedtest.nix

modules.services.monitoring.speedtest.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Speedtest Tracker"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/speedtest.nix

modules.services.monitoring.speedtest.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Speedtest Tracker goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/speedtest.nix

modules.services.monitoring.speedtest.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Speedtest Tracker is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/speedtest.nix

modules.services.monitoring.speedtest.subdomain Link copied!

Type: string

The domain at which Speedtest Tracker is hosted at.

Default: "speedtest"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/speedtest.nix

Type: string

The icon for Umami to be displayed in the Glance dashboard.

Default: "auto-invert sh:umami"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/umami.nix

modules.services.monitoring.umami.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Umami at Umami.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/umami.nix

modules.services.monitoring.umami.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Umami"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/umami.nix

modules.services.monitoring.umami.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Umami goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/umami.nix

modules.services.monitoring.umami.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Umami is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/umami.nix

modules.services.monitoring.umami.subdomain Link copied!

Type: string

The domain at which Umami is hosted at.

Default: "umami"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/umami.nix

Type: string

The icon for WakAPI to be displayed in the Glance dashboard.

Default: "sh:wakapi"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/wakapi.nix

modules.services.monitoring.wakapi.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for WakAPI at waka.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/wakapi.nix

modules.services.monitoring.wakapi.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "WakAPI"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/wakapi.nix

modules.services.monitoring.wakapi.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this WakAPI goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/wakapi.nix

modules.services.monitoring.wakapi.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which WakAPI is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/wakapi.nix

modules.services.monitoring.wakapi.subdomain Link copied!

Type: string

The domain at which WakAPI is hosted at.

Default: "waka"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/monitoring/wakapi.nix

Type: string

The icon for Davis to be displayed in the Glance dashboard.

Default: "di:davis"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/davis.nix

modules.services.productivity.davis.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Davis at cal.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/davis.nix

modules.services.productivity.davis.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Davis"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/davis.nix

modules.services.productivity.davis.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Davis goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/davis.nix

modules.services.productivity.davis.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Davis is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/davis.nix

modules.services.productivity.davis.subdomain Link copied!

Type: string

The domain at which Davis is hosted at.

Default: "cal"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/davis.nix

Type: string

The domain at which Forgejo is hosted at.

Default: "git"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/forgejo/default.nix

Type: string

The icon for Ollama to be displayed in the Glance dashboard.

Default: "sh:ollama"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/ollama.nix

modules.services.productivity.ollama.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Ollama at ai.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/ollama.nix

modules.services.productivity.ollama.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Ollama"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/ollama.nix

modules.services.productivity.ollama.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Ollama goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/ollama.nix

modules.services.productivity.ollama.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Ollama is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/ollama.nix

modules.services.productivity.ollama.subdomain Link copied!

Type: string

The domain at which Ollama is hosted at.

Default: "ai"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/ollama.nix

Type: string

The icon for Vikunja to be displayed in the Glance dashboard.

Default: "sh:vikunja"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/vikunja.nix

modules.services.productivity.vikunja.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Vikunja at tasks.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/vikunja.nix

modules.services.productivity.vikunja.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Vikunja"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/vikunja.nix

modules.services.productivity.vikunja.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Vikunja goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/vikunja.nix

modules.services.productivity.vikunja.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Vikunja is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/vikunja.nix

modules.services.productivity.vikunja.subdomain Link copied!

Type: string

The domain at which Vikunja is hosted at.

Default: "tasks"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/vikunja.nix

Type: string

The icon for VSCode Server to be displayed in the Glance dashboard.

Default: "si:vscodium"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/vscode.nix

modules.services.productivity.vscode.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for VSCode Server at code.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/vscode.nix

modules.services.productivity.vscode.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "VSCode Server"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/vscode.nix

modules.services.productivity.vscode.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this VSCode Server goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/vscode.nix

modules.services.productivity.vscode.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which VSCode Server is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/vscode.nix

modules.services.productivity.vscode.subdomain Link copied!

Type: string

The domain at which VSCode Server is hosted at.

Default: "code"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/productivity/vscode.nix

Type: string

The icon for ConvertX to be displayed in the Glance dashboard.

Default: "https://cdn.jsdelivr.net/gh/selfhst/icons/png/convertx.png"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/convertx.nix

modules.services.tools.convertx.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for ConvertX at convert.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/convertx.nix

modules.services.tools.convertx.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "ConvertX"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/convertx.nix

modules.services.tools.convertx.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this ConvertX goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/convertx.nix

modules.services.tools.convertx.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which ConvertX is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/convertx.nix

modules.services.tools.convertx.subdomain Link copied!

Type: string

The domain at which ConvertX is hosted at.

Default: "convert"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/convertx.nix

Type: string

The icon for IT-Tools to be displayed in the Glance dashboard.

Default: "sh:it-tools"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/it-tools.nix

modules.services.tools.it-tools.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for IT-Tools at tools.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/it-tools.nix

modules.services.tools.it-tools.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "IT-Tools"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/it-tools.nix

modules.services.tools.it-tools.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this IT-Tools goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/it-tools.nix

modules.services.tools.it-tools.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which IT-Tools is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/it-tools.nix

modules.services.tools.it-tools.subdomain Link copied!

Type: string

The domain at which IT-Tools is hosted at.

Default: "tools"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/it-tools.nix

Type: string

The icon for LibreTranslate to be displayed in the Glance dashboard.

Default: "sh:libretranslate"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/libretranslate.nix

modules.services.tools.libretranslate.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for LibreTranslate at translate.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/libretranslate.nix

modules.services.tools.libretranslate.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "LibreTranslate"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/libretranslate.nix

modules.services.tools.libretranslate.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this LibreTranslate goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/libretranslate.nix

modules.services.tools.libretranslate.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which LibreTranslate is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/libretranslate.nix

modules.services.tools.libretranslate.subdomain Link copied!

Type: string

The domain at which LibreTranslate is hosted at.

Default: "translate"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/libretranslate.nix

Type: string

The icon for SearXNG to be displayed in the Glance dashboard.

Default: "sh:searxng"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/searxng.nix

modules.services.tools.searxng.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for SearXNG at search.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/searxng.nix

modules.services.tools.searxng.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "SearXNG"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/searxng.nix

modules.services.tools.searxng.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this SearXNG goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/searxng.nix

modules.services.tools.searxng.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which SearXNG is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/searxng.nix

modules.services.tools.searxng.subdomain Link copied!

Type: string

The domain at which SearXNG is hosted at.

Default: "search"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/tools/searxng.nix

Type: string

The icon for Webpagc to be displayed in the Glance dashboard.

Default: "https://orangc.net/leaf.png"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/main/default.nix

modules.services.webpages.main.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Webpagc at .cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/main/default.nix

modules.services.webpages.main.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Webpagc"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/main/default.nix

modules.services.webpages.main.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Webpagc goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/main/default.nix

modules.services.webpages.main.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Webpagc is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/main/default.nix

modules.services.webpages.main.redirects Link copied!

Type: list of (submodule)

This option has no description.

Default: [ ]

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/main/default.nix

modules.services.webpages.main.redirects.*.code Link copied!

Type: signed integer

This option has no description.

Default: 301

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/main/default.nix

modules.services.webpages.main.redirects.*.sources Link copied!

Type: list of string

This option has no description.

Default: [ ]

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/main/default.nix

modules.services.webpages.main.redirects.*.target Link copied!

Type: string

This option has no description.

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/main/default.nix

modules.services.webpages.main.subdomain Link copied!

Type: string

The domain at which Webpagc is hosted at.

Default: ""

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/main/default.nix

Type: string

The icon for Flake Documentation to be displayed in the Glance dashboard.

Default: "sh:nixos"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/ndg.nix

modules.services.webpages.ndg.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Flake Documentation at flake.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/ndg.nix

modules.services.webpages.ndg.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Flake Documentation"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/ndg.nix

modules.services.webpages.ndg.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Flake Documentation goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/ndg.nix

modules.services.webpages.ndg.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Flake Documentation is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/ndg.nix

modules.services.webpages.ndg.subdomain Link copied!

Type: string

The domain at which Flake Documentation is hosted at.

Default: "flake"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/ndg.nix

Type: string

The icon for Blog to be displayed in the Glance dashboard.

Default: "https://notes.orangc.net/leaf.png"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/notes.nix

modules.services.webpages.notes.internalTailscaleDomain.enable Link copied!

Type: boolean

Whether to enable an internal tailnet domain for Blog at notes.cormorant-emperor.ts.net.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/notes.nix

modules.services.webpages.notes.name Link copied!

Type: string

Set the name of the service with correct capitalisation if necessary for other modules such as modules.glance to access.

Default: "Blog"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/notes.nix

modules.services.webpages.notes.ntfyChecking.enable Link copied!

Type: boolean

Whether to enable Ntfy sending notifications when this Blog goes down.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/notes.nix

modules.services.webpages.notes.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port at which Blog is hosted at.

Default: 8800

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/notes.nix

modules.services.webpages.notes.subdomain Link copied!

Type: string

The domain at which Blog is hosted at.

Default: "notes"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/webpages/notes.nix

Type: string

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.deluge Link copied!

Type: open submodule of attribute set of anything

Deluge download client definition for Starr services.

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.deluge.categories Link copied!

Type: string

Host of the download client.

Default: "127.0.0.1"

Example: "example.com"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.deluge.implementationName Link copied!

read-only

Type: string

Type of download client to configure (matches schema implementationName).

Default: "Deluge"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.deluge.name Link copied!

Type: string

User-defined name for the download client instance.

Default: "Deluge"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.deluge.password Link copied!

Type: string or (submodule)

Password for the download client.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.deluge.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port of the download client.

Default: 8112

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.deluge.urlBase Link copied!

Type: string

Adds a prefix to the deluge json url, see http://[host]:[port]/[urlBase]/json

Default: ""

Example: "deluge"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.enable Link copied!

Type: boolean

Whether to enable Downloadarr.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.extraClients Link copied!

Type: list of attribute set of anything

For more clients or if you have more than one instance of a specific client. Follows the same schema general schema as the other options. implementationName is a required field.

A list of implementation names can be acquired with:

curl -s -H "X-Api-Key: $(sudo cat </path/to/prowlarr/api_key>)" "http://127.0.0.1:9696/api/v1/downloadclient/schema" | jq '.[].implementationName'

You can run the following command to get the field names for a particular implementationName:

curl -s -H "X-Api-Key: $(sudo cat </path/to/prowlarr/apiKey>)" "http://127.0.0.1:9696/api/v1/downloadclient/schema" | jq '.[] | select(.implementationName=="<clientName>") | .fields'

Default:

[
  "qbittorrent.service"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.qbittorrent.enable Link copied!

Type: boolean

Whether or not this download client is enabled.

Default: config.nixflix.torrentClients.qbittorrent.enable

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.qbittorrent.host Link copied!

Type: string

Host of the download client.

Default: config.nixflix.torrentClients.qbittorrent.connectionAddress

Example: "example.com"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.qbittorrent.implementationName Link copied!

read-only

Type: string

Type of download client to configure (matches schema implementationName).

Default: "qBittorrent"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.qbittorrent.name Link copied!

Type: string

User-defined name for the download client instance.

Default: "qBittorrent"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.qbittorrent.password Link copied!

Type: null or string or (submodule)

Password for the download client.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: config.nixflix.torrentClients.qbittorrent.password

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.qbittorrent.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port of the download client.

Default: config.services.qbittorrent.webuiPort

Example: 8080

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.qbittorrent.urlBase Link copied!

Type: string

Adds a prefix to the qBittorrent url, such as http://[host]:[port]/[urlBase].

Default: ""

Example: "qbittorrent"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.qbittorrent.username Link copied!

Type: null or string or (submodule)

Username key for the download client.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Host of the download client.

Default: "127.0.0.1"

Example: "example.com"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.implementationName Link copied!

read-only

Type: string

Type of download client to configure (matches schema implementationName).

Default: "rTorrent"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.name Link copied!

Type: string

User-defined name for the download client instance.

Default: "rTorrent"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.password Link copied!

Type: string or (submodule)

Password for the download client.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port of the download client. This competes with SABnzbd.

Default: 8080

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.urlBase Link copied!

Type: string

Path to the XMLRPC endpoint, see http(s)://[host]:[port]/[urlPath]. This is usually RPC2 or [path to ruTorrent]/plugins/rpc/rpc.php when using ruTorrent.

Default: "RPC2"

Example: "rtorrent/RPC2"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.username Link copied!

Type: string or (submodule)

Username key for the download client.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd Link copied!

Type: open submodule of attribute set of anything

SABnzbd download client definition for Starr services.

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd.apiKey Link copied!

Type: null or string or (submodule)

API key for the download client.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

The categories to use for the Sonarr Anime instance

Default: "sonarr-anime"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd.dependencies Link copied!

Type: list of string

systemd services that this integration depends on

Default:

[
  "sabnzbd-categories.service"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd.enable Link copied!

Type: boolean

Whether or not this download client is enabled.

Default: config.nixflix.usenetClients.sabnzbd.enable

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd.host Link copied!

Type: string

Host of the download client.

Default: config.nixflix.usenetClients.sabnzbd.connectionAddress

Example: "example.com"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd.implementationName Link copied!

read-only

Type: string

Type of download client to configure (matches schema implementationName).

Default: "SABnzbd"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd.name Link copied!

Type: string

User-defined name for the download client instance.

Default: "SABnzbd"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port of the download client.

Default: config.nixflix.usenetClients.sabnzbd.settings.misc.port

Example: 8080

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd.urlBase Link copied!

Type: string

Adds a prefix to the SABnzbd url, such as http://[host]:[port]/[urlBase].

Default:

if config.nixflix.usenetClients.sabnzbd.settings.misc.url_base == "" then
  ""
else
  lib.removePrefix "/" config.nixflix.usenetClients.sabnzbd.settings.misc.url_base;

Default: "127.0.0.1"

Example: "example.com"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.transmission.implementationName Link copied!

read-only

Type: string

Type of download client to configure (matches schema implementationName).

Default: "Transmission"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.transmission.name Link copied!

Type: string

User-defined name for the download client instance.

Default: "Transmission"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.transmission.password Link copied!

Type: string or (submodule)

Password for the download client.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.transmission.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port of the download client.

Default: 9091

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.transmission.urlBase Link copied!

Type: string

Adds a prefix to the Transmission rpc url, eg http://[host]:[port]/[urlBase]/rpc

Default: "/transmission/"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadarr.transmission.username Link copied!

Type: string or (submodule)

Username key for the download client.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/downloadarr/options.nix

nixflix.downloadsDir Link copied!

Type: absolute path

The location of the downloads directory for download clients.

!!! warning

All parent directories must have execute permissions for everyone.

!!! warning

Setting this to any path, where the subpath is not owned by root, will fail! For example:

```nix
mediaDir = /home/user/data
```

Is not supported, because `/home/user` is owned by `user`.

Default: "/data/downloads"

Example: "/data/downloads"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.enable Link copied!

Type: boolean

Whether to enable Nixflix.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.flaresolverr.enable Link copied!

Type: boolean

Whether or not to enable FlareSolverr for Prowlarr.

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/flaresolverr.nix

nixflix.flaresolverr.port Link copied!

Type: signed integer or floating point number

Port for FlareSolverr to listen on.

Default: 8191

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/flaresolverr.nix

nixflix.globals Link copied!

Type: attribute set

Global values to be used by nixflix services

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/globals.nix

nixflix.jellyfin.apiKey Link copied!

Type: string or (submodule)

API key to inject into Jellyfin's database. Used by nixflix management services to authenticate to Jellyfin.

Can be created with the following:

openssl rand -hex 16

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/options.nix

nixflix.jellyfin.branding.customCss Link copied!

Type: strings concatenated with "\n"

Custom CSS to be injected into the web client.

Default:

if config.nixflix.theme.enable
then ''@import url("https://theme-park.dev/css/base/jellyfin/$${config.nixflix.theme.name}.css");''
else "";

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/branding/options.nix

nixflix.jellyfin.branding.loginDisclaimer Link copied!

Type: strings concatenated with "\n"

Sets the text shown during login underneath the form.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/branding/options.nix

nixflix.jellyfin.branding.splashscreenEnabled Link copied!

Type: boolean

Enables a splashscreen to be shown during loading.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/branding/options.nix

nixflix.jellyfin.branding.splashscreenLocation Link copied!

Type: absolute path or string

Location of the splashscreen image. Custom images should be in a 16x9 aspect ratio at a minimum size of 1920x1080.

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/branding/options.nix

nixflix.jellyfin.cacheDir Link copied!

Type: absolute path

Directory containing the jellyfin server cache, passed with --cachedir see #cache-directory

Default: "/var/cache/jellyfin"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/options.nix

nixflix.jellyfin.configDir Link copied!

Type: absolute path

Directory containing the server configuration files, passed with --configdir see configuration-directory

Default: "${config.nixflix.stateDir}/jellyfin/config"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/options.nix

nixflix.jellyfin.connectionAddress Link copied!

read-only

Type: string

Address for connecting to this service.

Default: "127.0.0.1"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/network/options.nix

nixflix.jellyfin.dataDir Link copied!

Type: absolute path

Directory containing the Jellyfin data files

Default: "${config.nixflix.stateDir}/jellyfin"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/options.nix

nixflix.jellyfin.enable Link copied!

Type: boolean

Whether to enable Jellyfin media server

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/options.nix

nixflix.jellyfin.encoding.allowAv1Encoding Link copied!

Type: boolean

Whether AV1 encoding is enabled

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.allowHevcEncoding Link copied!

Type: boolean

Whether HEVC encoding is enabled

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.allowOnDemandMetadataBasedKeyframeExtractionForExtensions Link copied!

Type: list of string

imma be real i have no idea what this option is. Just leave it as the default

Default:

[
  "mkv"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.deinterlaceDoubleRate Link copied!

Type: boolean

Whether to enable This setting uses the field rate when deinterlacing, often referred to as bob deinterlacing, which doubles the frame rate of the video to provide full motion like what you would see when viewing interlaced video on a TV. .

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.deinterlaceMethod Link copied!

Type: one of "yadif", "bwdif"

Select the deinterlacing method to use when software transcoding interlaced content. When hardware acceleration supporting hardware deinterlacing is enabled the hardware deinterlacer will be used instead of this setting.

Default: "yadif"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

Type: boolean

Whether to enable Delete old segments after they have been downloaded by the client. This prevents having to store the entire transcoded file on disk. Turn this off if you experience playback issues. .

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

Type: string

The path to the FFmpeg application file or folder containing FFmpeg.

Default: "$${pkgs.jellyfin-ffmpeg}/bin/ffmpeg"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.encoderPreset Link copied!

Type: one of "auto", "placebo", "veryslow", "slower", "slow", "medium", "fast", "faster", "veryfast", "superfast", "ultrafast"

Pick a faster value to improve performance, or a slower value to improve quality.

Default: "auto"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.encodingThreadCount Link copied!

Type: signed integer

Amount of threads used for encoding.

Set to -1 for automatic and 0 for max.

Default: -1

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.fallbackFontPath Link copied!

Type: string

Path to fallback font file for subtitle burning

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.h264Crf Link copied!

Type: signed integer

The 'Constant Rate Factor' (CRF) is the default quality setting for the x264 and x265 software encoders. You can set the values between 0 and 51, where lower values would result in better quality (at the expense of higher file sizes). Sane values are between 18 and 28.

Hardware encoders do not use these settings.

Default: 23

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.h265Crf Link copied!

Type: signed integer

The 'Constant Rate Factor' (CRF) is the default quality setting for the x264 and x265 software encoders. You can set the values between 0 and 51, where lower values would result in better quality (at the expense of higher file sizes). Sane values are between 18 and 28.

Hardware encoders do not use these settings.

Default: 28

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.hardwareAccelerationType Link copied!

Type: one of "none", "qsv", "amf", "nvenc", "vaapi", "rkmpp", "videotoolbox", "v4l2m2m"

Whether or not to use hardware acceleration for transcoding.

If you misconfigure this your streams will not work!. More info: https://jellyfin.org/docs/general/administration/hardware-acceleration/

Default: "none"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.hardwareDecodingCodecs Link copied!

Type: list of (one of "h264", "hevc", "mpeg2video", "vc1", "vp8", "vp9", "av1")

List of codec types to enable hardware decoding for. Should only include codecs your hardware has support for.

Consult https://jellyfin.org/docs/general/administration/hardware-acceleration/ for more info.

Default:

[
  "h264"
  "hevc"
  "mpeg2video"
  "vc1"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.maxMuxingQueueSize Link copied!

Type: signed integer

Maximum number of packets that can be buffered while waiting for all streams to initialize. Try to increase it if you still meet "Too many packets buffered for output stream" error in FFmpeg logs.

The recommended value is 2048.

Default: 2048

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.preferSystemNativeHwDecoder Link copied!

Type: boolean

Prefer system native hardware decoder over FFmpeg implementations.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.qsvDevice Link copied!

Type: string

Specify the device for Intel QSV on a multi-GPU system. On Linux, this is the render node, e.g., /dev/dri/renderD128. Leave blank unless you know what you are doing.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.segmentKeepSeconds Link copied!

Type: signed integer

Time in seconds for which segments should be kept after they are downloaded by the client. Only works if segment deletion is enabled.

Default: 720

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.throttleDelaySeconds Link copied!

Type: signed integer

Time in seconds after which the transcoder will be throttled. Must be large enough for the client to maintain a healthy buffer. Only works if throttling is enabled.

Default: 180

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.tonemappingAlgorithm Link copied!

Type: one of "none", "bt2390", "clip", "linear", "gamma", "reinhard", "hable", "mobius"

Tone mapping can be fine-tuned. If you are not familiar with these options, just keep the default.

Default: "bt2390"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.tonemappingDesat Link copied!

Type: signed integer or floating point number

Apply desaturation for highlights that exceed this level of brightness. The higher the parameter, the more color information will be preserved. This setting helps prevent unnaturally blown-out colors for super-highlights, by (smoothly) turning into white instead. This makes images feel more natural, at the cost of reducing information about out-of-range colors.

The recommended and default values are 0 and 0.5.

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.tonemappingMode Link copied!

Type: one of "auto", "max", "rgb", "lum", "itp"

Select the tone mapping mode. If you experience blown out highlights try switching to the RGB mode.

Default: "auto"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.tonemappingParam Link copied!

Type: signed integer or floating point number

Tune the tone mapping algorithm. The recommended and default values are 0.

Recommended to leave unchanged

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.tonemappingPeak Link copied!

Type: signed integer or floating point number

Override signal/nominal/reference peak with this value. Useful when the embedded peak information in display metadata is not reliable or when tone mapping from a lower range to a higher range.

The recommended and default values are 100 and 0.

Default: 100

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.tonemappingRange Link copied!

Type: one of "auto", "tv", "pc"

Select the output color range. Auto is the same as the input range.

Default: "auto"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.transcodingTempPath Link copied!

Type: string

Path for temporary transcoded files when streaming

Default: "${config.nixflix.jellyfin.cacheDir}/transcodes"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.vaapiDevice Link copied!

Type: string

This is the render node that is used for hardware acceleration. Only used if HardwareAccelerationType is set to vaapi.

Default: "/dev/dri/renderD128"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.vppTonemappingBrightness Link copied!

Type: signed integer or floating point number

Apply brightness gain in VPP tone mapping.

The recommended and default values are 16 and 0.

Default: 16

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.encoding.vppTonemappingContrast Link copied!

Type: signed integer or floating point number

Apply contrast gain in VPP tone mapping.

Both recommended and default values are 1.

Default: 1

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/encoding/options.nix

nixflix.jellyfin.group Link copied!

Type: string

Group under which the service runs

Default: config.nixflix.globals.libraryOwner.group

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/options.nix

nixflix.jellyfin.libraries Link copied!

Type: attribute set of (null or (submodule))

Jellyfin media libraries to manage declaratively.

By default, libraries are automatically created for enabled Arr services:

Shows: Created when Sonarr is enabled
Movies: Created when Radarr is enabled
Music: Created when Lidarr is enabled
Anime: Created when either Sonarr anime or Radarr anime is enabled

Default libraries can be removed with the following:

nixflix.jellyfin.libraries.Movies = lib.mkForce {};

Default: { }

Example:

{
  "Family Photos" = {
    collectionType = "homevideos";
    enablePhotos = true;
    paths = [
      "/mnt/photos"
    ];
  };
  Movies = {
    collectionType = "movies";
    enableRealtimeMonitor = true;
    metadataCountryCode = "US";
    paths = [
      "/mnt/movies"
    ];
    preferredMetadataLanguage = "en";
  };
  Shows = {
    collectionType = "tvshows";
    paths = [
      "/mnt/tv"
    ];
    seasonZeroDisplayName = "Specials";
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.allowEmbeddedSubtitles Link copied!

Type: one of "AllowAll", "AllowText", "AllowImage", "AllowNone"

Control which types of embedded subtitles to allow:

AllowAll: Allow all embedded subtitles
AllowText: Allow only text-based embedded subtitles
AllowImage: Allow only image-based embedded subtitles
AllowNone: Don't allow any embedded subtitles

Default: "AllowAll"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.automaticRefreshIntervalDays Link copied!

Type: signed integer

Days between automatic metadata refreshes (0 to disable)

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.automaticallyAddToCollection Link copied!

Type: boolean

Automatically add items to collections based on metadata

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.collectionType Link copied!

Type: one of "movies", "tvshows", "music", "musicvideos", "homevideos", "boxsets", "books", "mixed"

The type of media library.

movies: Movie library
tvshows: TV Shows library
music: Music library
musicvideos: Music Videos library
homevideos: Home Videos (and Photos) library
boxsets: Box Sets library
books: Books library
mixed: Mixed Movies and TV Shows library

Default: null

Example: "US"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.metadataSavers Link copied!

Type: list of string

List of metadata savers to enable

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.paths Link copied!

Type: list of string

List of media folder paths for this library

Default: [ ]

Example:

[
  "/mnt/movies"
  "/media/films"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.preferNonstandardArtistsTag Link copied!

Type: boolean

Prefer non-standard artist tags in music files

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.preferredMetadataLanguage Link copied!

Type: null or string

Preferred language for metadata (e.g., 'en', 'fr', 'de')

Default: null

Example: "en"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.requirePerfectSubtitleMatch Link copied!

Type: boolean

Type: list of string

Languages to download subtitles for

Default: [ ]

Example:

[
  "eng"
  "fra"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.subtitleFetcherOrder Link copied!

Type: list of string

Order in which to use subtitle fetchers

Default:

lib.optional config.nixflix.jellyfin.plugins."Open Subtitles".enable "Open Subtitles"
++ lib.optional config.nixflix.jellyfin.plugins."subbuzz".enable "subbuzz";

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.typeOptions Link copied!

Type: list of (submodule)

Content type-specific metadata and image fetcher configuration

Default: [ ]

Example:

[
  {
    imageFetchers = [
      "TheMovieDb"
    ];
    metadataFetchers = [
      "TheMovieDb"
      "The Open Movie Database"
    ];
    type = "Movie";
  }
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.typeOptions.*.imageFetcherOrder Link copied!

Type: list of string

Order in which to use image fetchers

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.typeOptions.*.imageFetchers Link copied!

Type: list of string

List of image fetchers to enable for this type

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.typeOptions.*.imageOptions Link copied!

Type: list of (submodule)

Image download options for this type

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.typeOptions..imageOptions..limit Link copied!

Type: signed integer

Maximum number of images of this type (0 for unlimited)

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.typeOptions..imageOptions..minWidth Link copied!

Type: signed integer

Minimum width for images of this type

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.typeOptions..imageOptions..type Link copied!

Type:

one of "Primary", "Art", "Backdrop", "Banner", "Logo", "Thumb", "Disc", "Box", "Screenshot", "Menu", "Chapter", "BoxRear", "Profile"

The image type

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.typeOptions.*.metadataFetcherOrder Link copied!

Type: list of string

Order in which to use metadata fetchers

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.typeOptions.*.metadataFetchers Link copied!

Type: list of string

List of metadata fetchers to enable for this type

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.typeOptions.*.type Link copied!

Type: string

The content type (e.g., 'Movie', 'Series', 'Season', 'Episode', 'MusicAlbum', 'MusicArtist', 'Audio')

Example: "Movie"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.libraries.<name>.useCustomTagDelimiters Link copied!

Type: boolean

Use custom tag delimiters for parsing metadata

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/libaries/options.nix

nixflix.jellyfin.logDir Link copied!

Type: absolute path

Directory where the Jellyfin logs will be stored, passed with --logdir see #log-directory

Default: "${config.nixflix.stateDir}/jellyfin/log"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/options.nix

nixflix.jellyfin.network.autoDiscovery Link copied!

Type: boolean

Enable auto-discovery

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/network/options.nix

nixflix.jellyfin.network.baseUrl Link copied!

Type: string

Base URL for Jellyfin (URL prefix) http://localhost:8096/<baseUrl>

Default: ""

Example: "jellyfin"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/network/options.nix

nixflix.jellyfin.network.certificatePassword Link copied!

Type: string or (submodule)

Certificate password.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

List of IP addresses or hostnames of known proxies used when connecting to your Jellyfin instance. This is required to make proper use of 'X-Forwarded-For' headers.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/network/options.nix

nixflix.jellyfin.network.localNetworkAddresses Link copied!

Type: list of string

Override the local IP address for the HTTP server. If left empty, the server will bind to all available addresses.

Default:

if (config.nixflix.reverseProxy.enable && !config.nixflix.jellyfin.vpn.enable)
then [ "127.0.0.1" ]
else [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/network/options.nix

nixflix.jellyfin.network.virtualInterfaceNames Link copied!

Type: list of string

List of virtual interface names

Default:

[
  "veth"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/network/options.nix

nixflix.jellyfin.openFirewall Link copied!

Type: boolean

Open ports in the firewall for Jellyfin. TCP ports 8096 and 8920, UDP ports 1900 and 7359.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/network/options.nix

nixflix.jellyfin.package Link copied!

Type: package

Jellyfin package to use

Default: pkgs.jellyfin

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/options.nix

nixflix.jellyfin.plugins Link copied!

Type: open submodule of attribute set of (submodule)

Jellyfin plugins to manage declaratively.

Each key is the plugin name exactly as it appears in the Jellyfin repository manifest (e.g. "Anime", "Bookshelf", "Trakt"). Plugin names must be unique across all configured plugin repositories.

Plugins are installed from package. This can either be a normal Nix derivation, or a repository lookup created with nixflix.lib.jellyfinPlugins.fromRepo.

Plugin changes (installs, removals, version updates) cause Jellyfin to restart automatically. Plan plugin changes for maintenance windows to avoid interrupting active streams.

Default: { }

Example:

{
  "Bookshelf" = {
    package = nixflix.lib.jellyfinPlugins.fromRepo {
      version = "13.0.0.0";
      hash = "sha256-16jaQRh1rIFE27nSSEWNF7UjVsPJDaRf24Ews0BZGas=";
    };
    config = {
      # Plain string (visible in Nix store)
      ComicVineApiKey = "my-api-key";
      # Or as a secret (read from file at activation time)
      # ComicVineApiKey._secret = "/run/secrets/comic-vine-api-key";
    };
  };

  "Intro Skipper" = {
    package = myJellyfinPlugin;
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Open Subtitles" Link copied!

Type: submodule

This option has no description.

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Open Subtitles".apiName Link copied!

Type: string

The plugin's Name as reported by the Jellyfin /Plugins API. Defaults to the attribute name. Set this when the plugin's self-reported API name differs from its manifest name (e.g. the SSO-Auth plugin is listed in the manifest as "SSO Authentication" but reports itself via the API as "SSO-Auth").

Can be found when running the following while the plugin is installed:

curl -s -H "Authorization: MediaBrowser Token=$(sudo cat /run/jellyfin/auth-token)" \
                     http://127.0.0.1:8096/Plugins | jq '.[].Name'

Default: "‹name›"

Example: "SSO-Auth"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Open Subtitles".config Link copied!

Type: submodule

Open Subtitles plugin configuration payload as posted to the Jellyfin API. You can utilize this plugin by editing a library and modifying the options for subtitle downloads.

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Open Subtitles".config.Password Link copied!

Type: string or (submodule)

Password for OpenSubtitles.com

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Open Subtitles".config.Username Link copied!

Type: string

Username from OpenSubtitles.com

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Open Subtitles".enable Link copied!

Type: boolean

Whether this plugin should be installed. When false, the plugin is treated as absent: if it was previously installed by nixflix it will be uninstalled on the next nixos-rebuild. This is equivalent to removing the attribute entirely from nixflix.jellyfin.plugins.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Open Subtitles".package Link copied!

Type: null or package or (submodule)

Nix package containing the unpacked Jellyfin plugin files to copy into Jellyfin's plugin directory.

For repository-managed plugins, use nixflix.lib.jellyfinPlugins.fromRepo { version = ...; hash = ...; } to resolve a deterministic package from the pinned plugin manifests.

Default:

{
  hash = "sha256-b6sgmgBlvhUAhFuq0p/EjB3604NGBkpS4NP33n1hfKc=";
  repository = null;
  version = "24.0.0.0";
}

Example:

nixflix.lib.jellyfinPlugins.fromRepo {
  version = "13.0.0.0";
  hash = "sha256-16jaQRh1rIFE27nSSEWNF7UjVsPJDaRf24Ews0BZGas=";
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Subtitle Extract" Link copied!

Type: submodule

This option has no description.

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".apiName Link copied!

Type: string

The plugin's Name as reported by the Jellyfin /Plugins API. Defaults to the attribute name. Set this when the plugin's self-reported API name differs from its manifest name (e.g. the SSO-Auth plugin is listed in the manifest as "SSO Authentication" but reports itself via the API as "SSO-Auth").

Can be found when running the following while the plugin is installed:

curl -s -H "Authorization: MediaBrowser Token=$(sudo cat /run/jellyfin/auth-token)" \
                     http://127.0.0.1:8096/Plugins | jq '.[].Name'

Default: "‹name›"

Example: "SSO-Auth"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".config Link copied!

Type: submodule

Plugin to automatically extract embedded subtitles.

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".config.AllSubtitleCodecs Link copied!

Type: list of (submodule)

Full list of all supported subtitle codecs with their display names. Only works when IsAdvancedMode = true;.

Default:

[
  {
    Text = "ASS (Advanced SSA) subtitle (.ass & .ssa files - often found on anime)";
    Value = "ass";
  }
  {
    Text = "DVD subtitles";
    Value = "DVDSUB";
  }
  {
    Text = "SubRip subtitle (.srt files - most common type of subtitles)";
    Value = "subrip";
  }
  {
    Text = "HDMV Presentation Graphic Stream subtitles (often found on Blu-ray)";
    Value = "PGSSUB";
  }
  {
    Text = "DVB subtitles";
    Value = "DVBSUB";
  }
  {
    Text = "EIA-608 closed captions";
    Value = "eia_608";
  }
  {
    Text = "JACOsub subtitle";
    Value = "jacosub";
  }
  {
    Text = "MicroDVD subtitle";
    Value = "microdvd";
  }
  {
    Text = "MOV text";
    Value = "mov_text";
  }
  {
    Text = "MPL2 subtitle";
    Value = "mpl2";
  }
  {
    Text = "PJS (Phoenix Japanimation Society) subtitle";
    Value = "pjs";
  }
  {
    Text = "RealText subtitle";
    Value = "realtext";
  }
  {
    Text = "SAMI subtitle";
    Value = "sami";
  }
  {
    Text = "Spruce subtitle format";
    Value = "stl";
  }
  {
    Text = "SubViewer subtitle";
    Value = "subviewer";
  }
  {
    Text = "SubViewer v1 subtitle";
    Value = "subviewer1";
  }
  {
    Text = "raw UTF-8 text";
    Value = "text";
  }
  {
    Text = "VPlayer subtitle";
    Value = "vplayer";
  }
  {
    Text = "WebVTT subtitle";
    Value = "webvtt";
  }
  {
    Text = "XSUB";
    Value = "xsub";
  }
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".config.AllSubtitleCodecs.*.Text Link copied!

Type: string

Human-readable display name and description of the subtitle format.

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subtitleExtract.nix

Type: list of string

Limit subtitle extraction to media with all subtitle streams matching the selected codecs. Only works when IsAdvancedMode = true;.

Default:

[
  "ass"
  "DVDSUB"
  "subrip"
  "PGSSUB"
  "DVBSUB"
  "eia_608"
  "jacosub"
  "microdvd"
  "mov_text"
  "mpl2"
  "pjs"
  "realtext"
  "sami"
  "stl"
  "subviewer"
  "subviewer1"
  "text"
  "vplayer"
  "webvtt"
  "xsub"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".config.SelectedSubtitlesLibraries Link copied!

Type: list of string

List of libraries from which subtitles will be extracted.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".enable Link copied!

Type: boolean

Whether this plugin should be installed. When false, the plugin is treated as absent: if it was previously installed by nixflix it will be uninstalled on the next nixos-rebuild. This is equivalent to removing the attribute entirely from nixflix.jellyfin.plugins.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".package Link copied!

Type: null or package or (submodule)

Nix package containing the unpacked Jellyfin plugin files to copy into Jellyfin's plugin directory.

For repository-managed plugins, use nixflix.lib.jellyfinPlugins.fromRepo { version = ...; hash = ...; } to resolve a deterministic package from the pinned plugin manifests.

Default:

{
  hash = "sha256-vnSYKFf0L6Bk6jOegxs/Rk+2n5oEAQpxTbLqxNpYh2o=";
  repository = null;
  version = "7.0.0.0";
}

Example:

nixflix.lib.jellyfinPlugins.fromRepo {
  version = "13.0.0.0";
  hash = "sha256-16jaQRh1rIFE27nSSEWNF7UjVsPJDaRf24Ews0BZGas=";
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins.<name>.apiName Link copied!

Type: string

The plugin's Name as reported by the Jellyfin /Plugins API. Defaults to the attribute name. Set this when the plugin's self-reported API name differs from its manifest name (e.g. the SSO-Auth plugin is listed in the manifest as "SSO Authentication" but reports itself via the API as "SSO-Auth").

Can be found when running the following while the plugin is installed:

curl -s -H "Authorization: MediaBrowser Token=$(sudo cat /run/jellyfin/auth-token)" \
                     http://127.0.0.1:8096/Plugins | jq '.[].Name'

Default: "‹name›"

Example: "SSO-Auth"

Declared in: nixflix.jellyfin.plugins..apiName

nixflix.jellyfin.plugins.<name>.config Link copied!

Type: attribute set of anything

Plugin configuration payload as seen in the Jellyfin UI/API. All attributes under this option are POSTed to /Plugins/<id>/Configuration.

Default: { }

Example:

{
  ComicVineApiKey._secret = "/run/secrets/comic-vine-api-key";
}

Declared in: nixflix.jellyfin.plugins..config

nixflix.jellyfin.plugins.<name>.enable Link copied!

Type: boolean

Whether this plugin should be installed. When false, the plugin is treated as absent: if it was previously installed by nixflix it will be uninstalled on the next nixos-rebuild. This is equivalent to removing the attribute entirely from nixflix.jellyfin.plugins.

Default: true

Declared in: nixflix.jellyfin.plugins..enable

nixflix.jellyfin.plugins.<name>.package Link copied!

Type: null or package or (submodule)

Nix package containing the unpacked Jellyfin plugin files to copy into Jellyfin's plugin directory.

For repository-managed plugins, use nixflix.lib.jellyfinPlugins.fromRepo { version = ...; hash = ...; } to resolve a deterministic package from the pinned plugin manifests.

Default: null

Example:

nixflix.lib.jellyfinPlugins.fromRepo {
  version = "13.0.0.0";
  hash = "sha256-16jaQRh1rIFE27nSSEWNF7UjVsPJDaRf24Ews0BZGas=";
}

Declared in: nixflix.jellyfin.plugins..package

nixflix.jellyfin.plugins.subbuzz Link copied!

Type: submodule

This option has no description.

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.apiName Link copied!

Type: string

The plugin's Name as reported by the Jellyfin /Plugins API. Defaults to the attribute name. Set this when the plugin's self-reported API name differs from its manifest name (e.g. the SSO-Auth plugin is listed in the manifest as "SSO Authentication" but reports itself via the API as "SSO-Auth").

Can be found when running the following while the plugin is installed:

curl -s -H "Authorization: MediaBrowser Token=$(sudo cat /run/jellyfin/auth-token)" \
                     http://127.0.0.1:8096/Plugins | jq '.[].Name'

Default: "‹name›"

Example: "SSO-Auth"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.config Link copied!

Type: submodule

SubBuzz plugin configuration payload as posted to the Jellyfin API.

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.config.Cache Link copied!

Type: submodule

Settings controlling subtitle and search result caching behaviour.

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.config.Cache.BasePath Link copied!

Type: string

Specify a custom location for the cache files. Leave blank to use the default.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.config.Cache.Search Link copied!

Type: boolean

Save results from search requests and reuse them for a specified period of time.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.config.Cache.SearchLifeInMinutes Link copied!

Type:

(one of 1440, 60, 10080, 720, 2880, 120, 20160, 4320, 30240, 5760, 240, 40320, 480, 0) or (one of "1 day", "1 hour", "1 week", "12 hours", "2 days", "2 hours", "2 weeks", "3 days", "3 weeks", "4 days", "4 hours", "4 weeks", "8 hours", "Use cache only in case of error") convertible to it

Send search requests to the providers again only after the selected period expires.

Default: "4 hours"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.config.Cache.SubLifeInMinutes Link copied!

Type:

(one of 1440, 60, 10080, 720, 2880, 120, 20160, 4320, 30240, 43200, 240, 86400, 480, 129600, 1000001, 0) or (one of "1 day", "1 hour", "1 week", "12 hours", "2 days", "2 hours", "2 weeks", "3 days", "3 weeks", "30 days", "4 hours", "60 days", "8 hours", "90 days", "Always", "Use cache only in case of error") convertible to it

Minimum score a subtitle must achieve to be downloaded.

Default: 50

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.config.OpenSubApiKey Link copied!

Type: string or (submodule)

API Key for the OpenSubtitles service.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.config.OpenSubPassword Link copied!

Type: string or (submodule)

Password for authenticating with OpenSubtitles.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.config.OpenSubToken Link copied!

Type: string or (submodule)

Session token for the OpenSubtitles service. Can be found on the OpenSubtitles.com profile page.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Whether to re-encode downloaded subtitles to UTF-8.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.config.SubSourceApiKey Link copied!

Type: string or (submodule)

Provide your API Key for doing API requests, if left empty provider will be disabled.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.config.SubdlApiKey Link copied!

Type: string or (submodule)

Provide your API Key for doing API requests, if left empty provider will be disabled.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.config.SubtitleInfoWithHtml Link copied!

Type: boolean

Format subtitle information displayed in search dialog using HTML. This may cause display issues in clients that doesn't support HTML. To use this with Jellyfin web interface you need to patch Jellyfin Web Client.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.enable Link copied!

Type: boolean

Whether this plugin should be installed. When false, the plugin is treated as absent: if it was previously installed by nixflix it will be uninstalled on the next nixos-rebuild. This is equivalent to removing the attribute entirely from nixflix.jellyfin.plugins.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.plugins.subbuzz.package Link copied!

Type: null or package or (submodule)

Nix package containing the unpacked Jellyfin plugin files to copy into Jellyfin's plugin directory.

For repository-managed plugins, use nixflix.lib.jellyfinPlugins.fromRepo { version = ...; hash = ...; } to resolve a deterministic package from the pinned plugin manifests.

Default:

{
  hash = "sha256-MtHFChAU2ZAtWROSbqxKW8fle8UeAhUt1jIEvw/VZjs=";
  repository = null;
  version = "1.4.1.0";
}

Example:

nixflix.lib.jellyfinPlugins.fromRepo {
  version = "13.0.0.0";
  hash = "sha256-16jaQRh1rIFE27nSSEWNF7UjVsPJDaRf24Ews0BZGas=";
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/plugins/subbuzz.nix

nixflix.jellyfin.reverseProxy.expose Link copied!

Type: boolean

Whether to expose Jellyfin via the reverse proxy.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/network/options.nix

nixflix.jellyfin.subdomain Link copied!

Type: string

Subdomain prefix for reverse proxy.

Default: "jellyfin"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/network/options.nix

nixflix.jellyfin.system.activityLogRetentionDays Link copied!

Type: null or signed integer

Number of days to retain activity logs. Set to null to never delete.

Default: 30

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.allowClientLogUpload Link copied!

Type: boolean

This option has no description.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.cachePath Link copied!

Type: string

Specify a custom location for server cache files such as images.

Default: "${config.nixflix.jellyfin.cacheDir}"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.cacheSize Link copied!

Type: signed integer

Cache size in MB. Must be at least 3 due to Jellyfin's internal caching implementation. The default of 1800 matches Jellyfin's built-in default.

Default: 1800

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.castReceiverApplications Link copied!

Type: list of (submodule)

This option has no description.

Default:

[
  {
    id = "F007D354";
    name = "Stable";
  }
  {
    id = "6F511C87";
    name = "Unstable";
  }
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.castReceiverApplications.*.id Link copied!

Type: string

Cast receiver application ID

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.castReceiverApplications.*.name Link copied!

Type: string

Display name for the cast receiver

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.chapterImageResolution Link copied!

Type: one of "MatchSource", "P2160", "P1440", "P1080", "P720", "P480", "P360", "P240", "P144"

The resolution of the extracted chapter images. Changing this will have no effect on existing dummy chapters.

Default: "MatchSource"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.codecsUsed Link copied!

Type: list of string

This option has no description.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.contentTypes Link copied!

Type: list of (submodule)

This option has no description.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.contentTypes.*.name Link copied!

Type: string

Content type name

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.contentTypes.*.value Link copied!

Type: string

Content type value

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.corsHosts Link copied!

Type: list of string

This option has no description.

Default:

[
  "*"
]

Type: boolean

Enable legacy authorization mode for backwards compatibility.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.enableMetrics Link copied!

Type: boolean

Type: signed integer

Maximum number of parallel tasks during library scans. Setting this to 0 will choose a limit based on your systems core count.

!!! warning

Setting this number too high may cause issues with network file systems; if you encounter problems lower this number.

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.libraryMonitorDelay Link copied!

Type: signed integer

This option has no description.

Default: 60

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.libraryScanFanoutConcurrency Link copied!

Type: signed integer

Maximum number of parallel tasks during library scans. Setting this to 0 will choose a limit based on your systems core count.

!!! warning

Setting this number too high may cause issues with network file systems; if you encounter problems lower this number.

Default:

[
  {
    itemType = "Movie";
  }
  {
    disabledImageFetchers = [
      "The Open Movie Database"
    ];
    disabledMetadataFetchers = [
      "The Open Movie Database"
    ];
    itemType = "MusicVideo";
  }
  {
    itemType = "Series";
  }
  {
    disabledMetadataFetchers = [
      "TheAudioDB"
    ];
    itemType = "MusicAlbum";
  }
  {
    disabledMetadataFetchers = [
      "TheAudioDB"
    ];
    itemType = "MusicArtist";
  }
  {
    itemType = "BoxSet";
  }
  {
    itemType = "Season";
  }
  {
    itemType = "Episode";
  }
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.metadataOptions.*.disabledImageFetchers Link copied!

Type: list of string

List of image fetchers to disable for this media type

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.metadataOptions.*.disabledMetadataFetchers Link copied!

Type: list of string

List of metadata fetchers to disable for this media type

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.metadataOptions.*.disabledMetadataSavers Link copied!

Type: list of string

List of metadata savers to disable for this media type

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.metadataOptions.*.imageFetcherOrder Link copied!

Type: list of string

Priority order for fetching images from remote sources

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

Type: list of (submodule)

This option has no description.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.pathSubstitutions.*.from Link copied!

Type: string

Path to substitute from

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.pathSubstitutions.*.to Link copied!

Type: string

Path to substitute to

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.pluginRepositories Link copied!

Type: attribute set of (submodule)

Configure which plugin repositories you use. Jellyfin Stable is always present in the set. Adding new plugin repositories will not remove it.

Default:

{
  "Jellyfin Stable" = {
    url = "https://repo.jellyfin.org/files/plugin/manifest.json";
    hash = "1ykrpwya7px7dz4h92994kpqlf5jd429z7r4dckbw13236x5mpbx";
    enabled = true;
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.pluginRepositories.<name>.enabled Link copied!

Type: boolean

Whether to enable this plugin repository

Default: true

Example: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.pluginRepositories.<name>.hash Link copied!

Type: string

Fixed-output hash for the repository manifest. This pins the manifest used to resolve plugin versions to source URLs.

Supports SRI (sha256-Uc6ovnXI3T0WfCqzcnwUZwYCH1tTDYb86pfNlvbOam0=) or nix32 (0vbarvv9dkcpxby8c3akbcgh41k72iy75craghb3vpf8fnzaikji) formats.

Example: "0vbarvv9dkcpxby8c3akbcgh41k72iy75craghb3vpf8fnzaikji"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.pluginRepositories.<name>.url Link copied!

Type: string

URL for the plugin repository manifest

Example: "https://repo.jellyfin.org/files/plugin/manifest.json"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.preferredMetadataLanguage Link copied!

Type: string

Display language of jellyfin.

Default: "en"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.quickConnectAvailable Link copied!

Type: boolean

Whether or not to enable quickconnect

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.remoteClientBitrateLimit Link copied!

Type: signed integer

This option has no description.

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.removeOldPlugins Link copied!

Type: boolean

This option has no description.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.saveMetadataHidden Link copied!

Type: boolean

Whether to enable .

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.serverName Link copied!

Type: string

This name will be used to identify the server and will default to the server's hostname.

Default: "${config.networking.hostName}"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.skipDeserializationForBasicTypes Link copied!

Type: boolean

This option has no description.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.slowResponseThresholdMs Link copied!

Type: signed integer

How slow (in ms) would a response have to be before a warning is shown

Default: 500

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.sortRemoveCharacters Link copied!

Type: list of string

This option has no description.

Default:

[
  ","
  "&"
  "-"
  "{"
  "}"
  "'"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.sortRemoveWords Link copied!

Type: list of string

This option has no description.

Default:

[
  "the"
  "a"
  "an"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.sortReplaceCharacters Link copied!

Type: list of string

This option has no description.

Default:

[
  "."
  "+"
  "%"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

Type: list of signed integer

List of the widths (px) that trickplay images will be generated at. All images should generate proportionally to the source, so a width of 320 on a 16:9 video ends up around 320x180.

Default:

[
  320
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.system.uiCulture Link copied!

Type: string

This option has no description.

Default: "en-US"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/system/options.nix

nixflix.jellyfin.user Link copied!

Type: string

User under which the service runs

Default: "jellyfin"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/options.nix

nixflix.jellyfin.users Link copied!

Type: attribute set of (submodule)

User configuration.

Important: At least one user must have policy.isAdministrator = true. This user will be created during the initial setup wizard and used for subsequent API operations.

Default: { }

Example:

{
  admin = {
    password = {
      _secret = "/run/secrets/jellyfin-admin-password";
    };
    policy = {
      isAdministrator = true;
    };
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration Link copied!

Type: submodule

Configuration for this user

Default: { }

Example:

{
  enableNextEpisodeAutoPlay = true;
  subtitleMode = "Always";
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.audioLanguagePreference Link copied!

Type: null or string

The audio language preference. Defaults to 'Any Language'

Default: null

Example: "eng"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.castReceiverId Link copied!

Type: string

This option has no description.

Default: "F007D354"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.displayCollectionsView Link copied!

Type: boolean

Whether to show the Collections View

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.displayMissingEpisodes Link copied!

Type: boolean

Whether to show missing episodes

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.enableLocalPassword Link copied!

Type: boolean

This option has no description.

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.enableNextEpisodeAutoPlay Link copied!

Type: boolean

Automatically play the next episode

Default: true

Example: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.groupedFolders Link copied!

Type: list of string

This option has no description.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.hidePlayedInLatest Link copied!

Type: boolean

Whether to hide already played titles in the 'Latest' section

Default: true

Example: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.latestItemsExcludes Link copied!

Type: list of string

This option has no description.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.myMediaExcludes Link copied!

Type: list of string

This option has no description.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.orderedViews Link copied!

Type: list of string

This option has no description.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.playDefaultAudioTrack Link copied!

Type: boolean

This option has no description.

Default: true

Example: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.rememberAudioSelections Link copied!

Type: boolean

This option has no description.

Default: true

Example: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.rememberSubtitleSelections Link copied!

Type: boolean

This option has no description.

Default: true

Example: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.subtitleLanguagePreference Link copied!

Type: null or string

The subtitle language preference. Defaults to 'Any Language'

Default: null

Example: "eng"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.configuration.subtitleMode Link copied!

Type: one of "Default", "Always", "OnlyForced", "None", "Smart"

Default: The default subtitle playback mode.
Always: Always show subtitles.
OnlyForced: Only show forced subtitles.
None: Don't show subtitles.
Smart: Only show subtitles when the current audio stream is in a different language.

Default: "Default"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.enableAutoLogin Link copied!

Type: boolean

This option has no description.

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.id Link copied!

Type: null or string

The ID of the user

Default: null

Example: "18B51E25-33FD-46B6-BBF8-DB4DD77D0679"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.lastActivityDate Link copied!

Type: null or string

This option has no description.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.lastLoginDate Link copied!

Type: null or string

This option has no description.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.mutable Link copied!

Type: boolean

Functions like mutableUsers in NixOS users.users."user" If true, the first time the user is created, all configured options are overwritten. Any modifications from the GUI will take priority, and no nix configuration changes will have any effect. If false however, all options are overwritten as specified in the nix configuration, which means any change through the Jellyfin GUI will have no effect after a rebuild.

Note: Passwords are only set during user creation and are never updated declaratively, regardless of the mutable setting. To change a user's password, use the Jellyfin web interface.

Default: true

Example: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.password Link copied!

Type: string or (submodule)

User's password.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy Link copied!

Type: submodule

Policy for this user

Default: { }

Example:

{
  enableContentDeletion = false;
  enableSubtitleManagement = true;
  isAdministrator = true;
  isDisabled = false;
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.accessSchedules Link copied!

Type: list of (submodule)

This option has no description.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.accessSchedules.*.dayOfWeek Link copied!

Type: one of "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Everyday", "Weekday", "Weekend"

This option has no description.

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.accessSchedules.*.endHour Link copied!

Type: integer between 0 and 23 (both inclusive)

This option has no description.

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.accessSchedules.*.startHour Link copied!

Type: integer between 0 and 23 (both inclusive)

This option has no description.

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.allowedTags Link copied!

Type: list of string

This option has no description.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.authenticationProviderId Link copied!

Type: string

Authentication provider ID

Default: "Jellyfin.Server.Implementations.Users.DefaultAuthenticationProvider"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.blockUnratedItems Link copied!

Type:

list of (one of "Movie", "Trailer", "Series", "Music", "Book", "LiveTvChannel", "LiveTvProgram", "ChannelContent", "Other")

Whether the user is hidden

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.loginAttemptsBeforeLockout Link copied!

Type: null or signed integer

The number of login attempts the user can make before they are locked out. 0 for default (3 for normal users, 5 for admins). null for unlimited

Default: 3

Example: 10

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.maxActiveSessions Link copied!

Type: signed integer

The maximum number of active sessions the user can have at once. 0 for unlimited

Default: 0

Example: 5

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.maxParentalRating Link copied!

Type: null or signed integer

This option has no description.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.maxParentalSubRating Link copied!

Type: null or signed integer

This option has no description.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.passwordResetProviderId Link copied!

Type: string

Password reset provider ID

Default: "Jellyfin.Server.Implementations.Users.DefaultPasswordResetProvider"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.remoteClientBitrateLimit Link copied!

Type: signed integer

0 for unlimited

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.users.<name>.policy.syncPlayAccess Link copied!

Type: one of "CreateAndJoinGroups", "JoinGroups", "None"

Whether or not this user has access to SyncPlay

Default: "CreateAndJoinGroups"

Example: "None"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/users/options.nix

nixflix.jellyfin.vpn.enable Link copied!

Type: boolean

Whether to route Jellyfin traffic through the VPN.

When false, Jellyfin bypasses the VPN. When true, Jellyfin is confined to the WireGuard network namespace (requires nixflix.vpn.enable = true).

Default: config.nixflix.vpn.enable

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/jellyfin/network/options.nix

nixflix.lidarr.config.apiKey Link copied!

Type: string or (submodule)

API key for Lidarr. Can be created by running:

openssl rand -hex 16

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.apiVersion Link copied!

Type: string

Current version of the API of the service

Default: "v3"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.delayProfiles Link copied!

Type: list of (submodule)

List of delay profiles to configure via the API /delayprofile endpoint.

Profiles are created/updated in id order. If no profile with id=1 is provided, a default profile will be added automatically.

Default:

[
  {
    enableUsenet = true;
    enableTorrent = true;
    preferredProtocol = "usenet";
    usenetDelay = 0;
    torrentDelay = 0;
    bypassIfHighestQuality = true;
    bypassIfAboveCustomFormatScore = false;
    minimumCustomFormatScore = 0;
    order = 2147483647;
    tags = [];
    id = 1;
  };
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.delayProfiles.*.bypassIfAboveCustomFormatScore Link copied!

Type: boolean

Bypass delay if custom format score is above minimum

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.delayProfiles.*.bypassIfHighestQuality Link copied!

Type: boolean

Bypass delay if release is the highest quality available

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.delayProfiles.*.enableTorrent Link copied!

Type: boolean

Enable Torrent protocol for this profile

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.delayProfiles.*.enableUsenet Link copied!

Type: boolean

Enable Usenet protocol for this profile

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.delayProfiles.*.id Link copied!

Type: signed integer

Unique identifier for the delay profile

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.delayProfiles.*.minimumCustomFormatScore Link copied!

Type: signed integer

Minimum custom format score to bypass delay

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.delayProfiles.*.order Link copied!

Type: signed integer

Order/priority of this delay profile (lower values = higher priority)

Default: 50

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.delayProfiles.*.preferredProtocol Link copied!

Type: one of "usenet", "torrent"

Preferred download protocol when both are available

Default: "usenet"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.delayProfiles.*.tags Link copied!

Type: list of signed integer

List of tag IDs this delay profile applies to (empty = applies to all)

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.delayProfiles.*.torrentDelay Link copied!

Type: signed integer

Delay in minutes before grabbing a Torrent release

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.delayProfiles.*.usenetDelay Link copied!

Type: signed integer

Delay in minutes before grabbing a Usenet release

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig Link copied!

Type: submodule

Host configuration options that will be set via the API /config/host endpoint

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.analyticsEnabled Link copied!

Type: boolean

Enable analytics

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.applicationUrl Link copied!

Type: string

Application URL

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.authenticationMethod Link copied!

Type: one of "none", "basic", "forms", "external"

Authentication method

Default: "forms"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.authenticationRequired Link copied!

Type: one of "enabled", "disabled", "disabledForLocalAddresses"

Authentication requirement level

Default: "enabled"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.backupFolder Link copied!

Type: string

Backup folder name

Default: "Backups"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.backupInterval Link copied!

Type: signed integer

Backup interval in days

Default: 7

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.backupRetention Link copied!

Type: signed integer

Backup retention in days

Default: 28

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.bindAddress Link copied!

Type: string

Address to bind to

Default: "0.0.0.0"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.branch Link copied!

Type: string

Update branch

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.certificateValidation Link copied!

Type: one of "enabled", "disabled", "disabledForLocalAddresses"

Certificate validation

Default: "enabled"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.consoleLogLevel Link copied!

Type: string

Console log level

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.enableSsl Link copied!

Type: boolean

Enable SSL

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.instanceName Link copied!

Type: string

Instance name

Default: "Lidarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.launchBrowser Link copied!

Type: boolean

Launch browser on start (not applicable for NixOS services)

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.logLevel Link copied!

Type: one of "info", "debug", "trace"

Log level

Default: "info"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.logSizeLimit Link copied!

Type: signed integer

Log size limit in MB

Default: 1

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.password Link copied!

Type: null or string or (submodule)

Password for web interface authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port the service listens on

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.proxyBypassFilter Link copied!

Type: string

Proxy bypass filter

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.proxyBypassLocalAddresses Link copied!

Type: boolean

Proxy bypass local addresses

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.proxyEnabled Link copied!

Type: boolean

Enable proxy

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.proxyHostname Link copied!

Type: string

Proxy hostname

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.proxyPassword Link copied!

Type: string or (submodule)

Proxy password

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.proxyPort Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Proxy port

Default: 8080

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.proxyType Link copied!

Type: one of "http", "socks4", "socks5"

Proxy type

Default: "http"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.proxyUsername Link copied!

Type: string or (submodule)

Proxy username

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.sslCertPassword Link copied!

Type: string or (submodule)

SSL certificate password

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.sslCertPath Link copied!

Type: string

SSL certificate path

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.sslPort Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

SSL port

Default: 9898

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.trustCgnatIpAddresses Link copied!

Type: boolean

Trust CGNAT IP addresses

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.updateAutomatically Link copied!

Type: boolean

Update automatically

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.updateMechanism Link copied!

Type: one of "builtIn", "script", "external", "docker"

Update mechanism

Default: "builtIn"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.updateScriptPath Link copied!

Type: string

Update script path

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.urlBase Link copied!

Type: string

URL base path

Default: ""

Example: "/takeMeThere"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.hostConfig.username Link copied!

Type: null or string or (submodule)

Username for web interface authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.autoUnmonitorPreviouslyDownloadedTracks Link copied!

Type: boolean

Automatically unmonitor tracks after they have been downloaded.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.chmodFolder Link copied!

Type: string

Octal permissions to apply to media folders.

Default: "755"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.chownGroup Link copied!

Type: string

Group name or gid to apply to media folders.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.copyUsingHardlinks Link copied!

Type: boolean

Use hardlinks instead of copying when importing from torrents still being seeded.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.createEmptyArtistFolders Link copied!

Type: boolean

Create missing artist folders during disk scan.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.deleteEmptyFolders Link copied!

Type: boolean

Delete empty folders during disk scan and when media files are deleted.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.downloadPropersAndRepacks Link copied!

Type: one of "preferAndUpgrade", "doNotUpgrade", "doNotPrefer"

How to handle proper and repack releases.

Default: "preferAndUpgrade"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.enableMediaInfo Link copied!

Type: boolean

Scan video files for media info such as resolution, runtime, and codec.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.extraFileExtensions Link copied!

Type: string

Comma-separated list of extra file extensions to import.

Default: "srt"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.fileDate Link copied!

Type: one of "none", "albumReleaseDate"

Set the file date on imported media files.

Default: "none"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.importExtraFiles Link copied!

Type: boolean

Import matching extra files alongside media files.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.minimumFreeSpaceWhenImporting Link copied!

Type: signed integer

Minimum free space in MB to leave on the disk when importing.

Default: 100

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.recycleBin Link copied!

Type: string

Path to the recycle bin directory.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.recycleBinCleanupDays Link copied!

Type: signed integer

Number of days before items in the recycle bin are permanently deleted.

Default: 7

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.rescanAfterRefresh Link copied!

Type: one of "always", "afterManual", "never"

When to rescan the media folder after refreshing media information.

Default: "always"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.scriptImportPath Link copied!

Type: string

Path to the custom import script.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.setPermissionsLinux Link copied!

Type: boolean

Set chmod and chown on imported files and media folders.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.skipFreeSpaceCheckWhenImporting Link copied!

Type: boolean

Skip the free space check when importing media files.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.mediaManagement.useScriptImport Link copied!

Type: boolean

Use a custom script for importing instead of the built-in import.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.config.rootFolders Link copied!

Type: list of (attribute set)

List of root folders to create via the API /rootfolder endpoint. Each folder is an attribute set that will be converted to JSON and sent to the API.

For Sonarr/Radarr, a simple path is sufficient: {path = "/path/to/folder";}

For Lidarr, additional fields are required like defaultQualityProfileId, etc.

Default: map (mediaDir: {path = mediaDir;}) nixflix.lidarr.mediaDirs

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.connectionAddress Link copied!

read-only

Type: string

Address for connecting to this service.

Default: "127.0.0.1"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.dataDir Link copied!

Type: absolute path

Directory containing Seerr data and configuration

Default: "${config.nixflix.stateDir}/${serviceName}"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.enable Link copied!

Type: boolean

Whether to enable Lidarr.

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.group Link copied!

Type: string

Group under which the service runs

Default: "lidarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.mediaDirs Link copied!

Type: list of absolute path

List of media directories to create and manage

Default: [config.nixflix.mediaDir + "/<media-type>"]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.openFirewall Link copied!

Type: boolean

Open ports in the firewall for the Radarr web interface.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.package Link copied!

Type: package

The lidarr package to use.

Default: pkgs.lidarr

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.reverseProxy.expose Link copied!

Type: boolean

Whether to expose this service via the reverse proxy.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.settings Link copied!

Type: open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Attribute set of arbitrary config options. Please consult the documentation at the wiki.

!!! warning

This configuration is stored in the world-readable Nix store!
Don't put secrets here!

Default:

{
  auth = {
    required = "Enabled";
    method = "Forms";
  };
  server = {
    inherit (config.nixflix.lidarr.config.hostConfig) port urlBase;
  };
} // optionalAttrs config.nixflix.postgres.enable {
  log.dbEnabled = true;
  postgres = {
    user = config.nixflix.lidarr.user;
    host = "/run/postgresql";
    port = config.services.postgresql.settings.port;
    mainDb = config.nixflix.lidarr.user;
    logDb = "${config.nixflix.lidarr.user}-logs";
  };
}

Example:

{
  update.mechanism = "internal";
  server = {
    urlbase = "localhost";
    port = 8989;
    bindaddress = "*";
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.settings.app.instanceName Link copied!

Type: string

Name of the instance

Default: "Lidarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.settings.log.analyticsEnabled Link copied!

Type: boolean

Send Anonymous Usage Data

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.settings.server.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port Number

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.settings.update.automatically Link copied!

Type: boolean

Automatically download and install updates.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.settings.update.mechanism Link copied!

Type: null or one of "external", "builtIn", "script"

which update mechanism to use

Default: "external"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.subdomain Link copied!

Type: string

Subdomain prefix for reverse proxy. Service accessible at <subdomain>.<domain>.

Default: "lidarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.user Link copied!

Type: string

User under which the service runs

Default: "lidarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.lidarr.vpn.enable Link copied!

Type: boolean

Whether to route Lidarr traffic through the VPN.

When false (default), Lidarr bypasses the VPN to prevent Cloudflare and image provider blocks. When true, Lidarr routes through the VPN (requires nixflix.vpn.enable = true).

TRaSH Guides recommend leaving this false.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/lidarr.nix

nixflix.mediaDir Link copied!

Type: absolute path

The location of the media directory for the services.

!!! warning

All parent directories must have execute permissions for everyone.

!!! warning

Setting this to any path, where the subpath is not owned by root, will fail! For example:

```nix
mediaDir = /home/user/data
```

Is not supported, because `/home/user` is owned by `user`.

Default: "/data/media"

Example: "/data/media"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.mediaUsers Link copied!

Type: list of string

Extra users to add to the media group.

Default: [ ]

Example:

[
  "user"
]

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.nginx.addHostsEntries Link copied!

Type: boolean

Whether to add networking.hosts entries mapping service subdomains to 127.0.0.1.

Enable if you don't have a separate DNS setup.

Default: false

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.nginx.domain Link copied!

Type: string

Base domain for subdomain-based reverse proxy routing. Each service is accessible at <subdomain>.<domain>.

Default: "nixflix"

Example: "internal"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.nginx.enable Link copied!

Type: boolean

Whether to enable nginx reverse proxy for all services

Default: false

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.nginx.enableACME Link copied!

Type: boolean

Whether to enable useACMEHost in virtual hosts. Uses nixflix.nginx.domain as ACME host.

You have to configure security.acme.certs.$${nixflix.nginx.domain} in order to use this.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.nginx.forceSSL Link copied!

Type: boolean

Whether to force SSL.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.postgres.enable Link copied!

Type: boolean

Whether or not to enable postgresql for the entire stack.

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/postgres.nix

nixflix.prowlarr.config.apiKey Link copied!

Type: string or (submodule)

API key for Prowlarr. Can be created by running:

openssl rand -hex 16

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.apiVersion Link copied!

Type: string

Current version of the API of the service

Default: "v3"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.applications Link copied!

Type: list of (open submodule of attribute set of anything)

List of applications to configure in Prowlarr. Any additional attributes beyond name, implementationName, and apiKey will be applied as field values to the application schema.

Default:

# Automatically configured for enabled arr services (Sonarr, Radarr, Lidarr)
# Each enabled service gets an application entry with computed baseUrl and prowlarrUrl
# based on nginx configuration

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/applications.nix

nixflix.prowlarr.config.applications.*.apiKey Link copied!

Type: string or (submodule)

Path to file containing the API key for the application

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/applications.nix

nixflix.prowlarr.config.applications.*.implementationName Link copied!

Type: one of "LazyLibrarian", "Lidarr", "Mylar", "Readarr", "Radarr", "Sonarr", "Whisparr"

Type of application to configure (matches schema implementationName)

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/applications.nix

nixflix.prowlarr.config.applications.*.name Link copied!

Type: string

User-defined name for the application instance

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/applications.nix

nixflix.prowlarr.config.hostConfig Link copied!

Type: submodule

Host configuration options that will be set via the API /config/host endpoint

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.analyticsEnabled Link copied!

Type: boolean

Enable analytics

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.applicationUrl Link copied!

Type: string

Application URL

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.authenticationMethod Link copied!

Type: one of "none", "basic", "forms", "external"

Authentication method

Default: "forms"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.authenticationRequired Link copied!

Type: one of "enabled", "disabled", "disabledForLocalAddresses"

Authentication requirement level

Default: "enabled"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.backupFolder Link copied!

Type: string

Backup folder name

Default: "Backups"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.backupInterval Link copied!

Type: signed integer

Backup interval in days

Default: 7

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.backupRetention Link copied!

Type: signed integer

Backup retention in days

Default: 28

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.bindAddress Link copied!

Type: string

Address to bind to

Default: "0.0.0.0"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.branch Link copied!

Type: string

Update branch

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.certificateValidation Link copied!

Type: one of "enabled", "disabled", "disabledForLocalAddresses"

Certificate validation

Default: "enabled"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.consoleLogLevel Link copied!

Type: string

Console log level

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.enableSsl Link copied!

Type: boolean

Enable SSL

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.instanceName Link copied!

Type: string

Instance name

Default: "Prowlarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.launchBrowser Link copied!

Type: boolean

Launch browser on start (not applicable for NixOS services)

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.logLevel Link copied!

Type: one of "info", "debug", "trace"

Log level

Default: "info"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.logSizeLimit Link copied!

Type: signed integer

Log size limit in MB

Default: 1

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.password Link copied!

Type: null or string or (submodule)

Password for web interface authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port the service listens on

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.proxyBypassFilter Link copied!

Type: string

Proxy bypass filter

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.proxyBypassLocalAddresses Link copied!

Type: boolean

Proxy bypass local addresses

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.proxyEnabled Link copied!

Type: boolean

Enable proxy

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.proxyHostname Link copied!

Type: string

Proxy hostname

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.proxyPassword Link copied!

Type: string or (submodule)

Proxy password

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.proxyPort Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Proxy port

Default: 8080

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.proxyType Link copied!

Type: one of "http", "socks4", "socks5"

Proxy type

Default: "http"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.proxyUsername Link copied!

Type: string or (submodule)

Proxy username

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.sslCertPassword Link copied!

Type: string or (submodule)

SSL certificate password

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.sslCertPath Link copied!

Type: string

SSL certificate path

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.sslPort Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

SSL port

Default: 9898

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.trustCgnatIpAddresses Link copied!

Type: boolean

Trust CGNAT IP addresses

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.updateAutomatically Link copied!

Type: boolean

Update automatically

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.updateMechanism Link copied!

Type: one of "builtIn", "script", "external", "docker"

Update mechanism

Default: "builtIn"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.updateScriptPath Link copied!

Type: string

Update script path

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.urlBase Link copied!

Type: string

URL base path

Default: ""

Example: "/takeMeThere"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.hostConfig.username Link copied!

Type: null or string or (submodule)

Username for web interface authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.config.indexerProxies Link copied!

Type: list of (open submodule of attribute set of anything)

List of indexer proxies to configure in Prowlarr.

Any additional attributes beyond name, username, and password will be applied as field values to the indexer schema.

FlareSolverr is automatically configured with a flaresolverr tag when nixflix.flaresolverr.enable is true;

You can run the following command to get the field names for a particular indexer:

curl -s -H "X-Api-Key: $(sudo cat </path/to/prowlarr/apiKey>)" "http://127.0.0.1:9696/prowlarr/api/v1/indexerProxy/schema" | jq '.[] | select(.name=="<indexerName>") | .fields'

Or if you have nginx disabled or config.nixflix.prowlarr.config.hostConfig.urlBase is not configured

curl -s -H "X-Api-Key: $(sudo cat </path/to/prowlarr/apiKey>)" "http://127.0.0.1:9696/api/v1/indexerProxy/schema" | jq '.[] | select(.name=="<indexerName>") | .fields'

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexerProxies.nix

nixflix.prowlarr.config.indexerProxies.*.name Link copied!

Type: string

Name of the Prowlarr indexer proxy Schema

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexerProxies.nix

nixflix.prowlarr.config.indexerProxies.*.password Link copied!

Type: null or string or (submodule)

Password for the indexer proxy.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexerProxies.nix

nixflix.prowlarr.config.indexerProxies.*.tags Link copied!

Type: list of string

Applies to indexers with at least one matching tag

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexerProxies.nix

nixflix.prowlarr.config.indexerProxies.*.username Link copied!

Type: null or string or (submodule)

Username for the indexer proxy.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexerProxies.nix

nixflix.prowlarr.config.indexers Link copied!

Type: list of (open submodule of attribute set of anything)

List of indexers to configure in Prowlarr. Prowlarr supports many indexers in addition to any indexer that uses the Newznab/Torznab standard using 'Generic Newznab' (for usenet) or 'Generic Torznab' (for torrents).

Any additional attributes beyond name, apiKey, apikey, username, password, passkey, and appProfileId will be applied as field values to the indexer schema.

The apiKey or apikey value is automatically applied to whichever field name the indexer schema uses — some schemas use apiKey (camelCase) and others use apikey (all-lowercase).

You can run the following command to get the field names for a particular indexer:

curl -s -H "X-Api-Key: $(sudo cat </path/to/prowlarr/apiKey>)" "http://127.0.0.1:9696/api/v1/indexer/schema" | jq '.[] | select(.name=="<indexerName>") | .fields'

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.apiKey Link copied!

Type: null or string or (submodule)

API key for the indexer. Applied to schema fields named apikey or apiKey.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.apikey Link copied!

Type: null or string or (submodule)

API key for the indexer (lowercase variant). Applied to schema fields named apikey or apiKey.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.appProfileId Link copied!

Type: signed integer

Application profile ID for the indexer (default: 1).

Default: 1

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.name Link copied!

Type: string

Name of the Prowlarr Indexer Schema

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.passkey Link copied!

Type: null or string or (submodule)

Passkey for the indexer.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.password Link copied!

Type: null or string or (submodule)

Password for the indexer.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.tags Link copied!

Type: list of string

Use tags to specify Indexer Proxies or which apps the indexer is synced to.

Tags should be used with caution, they can have unintended effects. An indexer with a tag will only sync to apps with the same tag.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexers.nix

nixflix.prowlarr.config.indexers.*.username Link copied!

Type: null or string or (submodule)

Username for the indexer.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr/indexers.nix

nixflix.prowlarr.connectionAddress Link copied!

read-only

Type: string

Address for connecting to this service.

Default: "127.0.0.1"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.dataDir Link copied!

Type: absolute path

Directory containing Seerr data and configuration

Default: "${config.nixflix.stateDir}/${serviceName}"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.enable Link copied!

Type: boolean

Whether to enable Prowlarr.

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.group Link copied!

Type: string

Group under which the service runs

Default: "prowlarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.openFirewall Link copied!

Type: boolean

Open ports in the firewall for the Radarr web interface.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.package Link copied!

Type: package

The prowlarr package to use.

Default: pkgs.prowlarr

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.reverseProxy.expose Link copied!

Type: boolean

Whether to expose this service via the reverse proxy.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.settings Link copied!

Type: open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Attribute set of arbitrary config options. Please consult the documentation at the wiki.

!!! warning

This configuration is stored in the world-readable Nix store!
Don't put secrets here!

Default:

{
  auth = {
    required = "Enabled";
    method = "Forms";
  };
  server = {
    inherit (config.nixflix.prowlarr.config.hostConfig) port urlBase;
  };
} // optionalAttrs config.nixflix.postgres.enable {
  log.dbEnabled = true;
  postgres = {
    user = config.nixflix.prowlarr.user;
    host = "/run/postgresql";
    port = config.services.postgresql.settings.port;
    mainDb = config.nixflix.prowlarr.user;
    logDb = "${config.nixflix.prowlarr.user}-logs";
  };
}

Example:

{
  update.mechanism = "internal";
  server = {
    urlbase = "localhost";
    port = 8989;
    bindaddress = "*";
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.settings.app.instanceName Link copied!

Type: string

Name of the instance

Default: "Prowlarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.settings.log.analyticsEnabled Link copied!

Type: boolean

Send Anonymous Usage Data

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.settings.server.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port Number

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.settings.update.automatically Link copied!

Type: boolean

Automatically download and install updates.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.settings.update.mechanism Link copied!

Type: null or one of "external", "builtIn", "script"

which update mechanism to use

Default: "external"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.subdomain Link copied!

Type: string

Subdomain prefix for reverse proxy. Service accessible at <subdomain>.<domain>.

Default: "prowlarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.user Link copied!

Type: string

User under which the service runs

Default: "prowlarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.prowlarr.vpn.enable Link copied!

Type: boolean

Whether to route Prowlarr traffic through the VPN.

When false (default), Prowlarr bypasses the VPN to prevent Cloudflare and image provider blocks. When true, Prowlarr routes through the VPN (requires nixflix.vpn.enable = true).

TRaSH Guides recommend leaving this false.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/prowlarr

nixflix.radarr.config.apiKey Link copied!

Type: string or (submodule)

API key for Radarr. Can be created by running:

openssl rand -hex 16

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.apiVersion Link copied!

Type: string

Current version of the API of the service

Default: "v3"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.delayProfiles Link copied!

Type: list of (submodule)

List of delay profiles to configure via the API /delayprofile endpoint.

Profiles are created/updated in id order. If no profile with id=1 is provided, a default profile will be added automatically.

Default:

[
  {
    enableUsenet = true;
    enableTorrent = true;
    preferredProtocol = "usenet";
    usenetDelay = 0;
    torrentDelay = 0;
    bypassIfHighestQuality = true;
    bypassIfAboveCustomFormatScore = false;
    minimumCustomFormatScore = 0;
    order = 2147483647;
    tags = [];
    id = 1;
  };
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.delayProfiles.*.bypassIfAboveCustomFormatScore Link copied!

Type: boolean

Bypass delay if custom format score is above minimum

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.delayProfiles.*.bypassIfHighestQuality Link copied!

Type: boolean

Bypass delay if release is the highest quality available

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.delayProfiles.*.enableTorrent Link copied!

Type: boolean

Enable Torrent protocol for this profile

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.delayProfiles.*.enableUsenet Link copied!

Type: boolean

Enable Usenet protocol for this profile

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.delayProfiles.*.id Link copied!

Type: signed integer

Unique identifier for the delay profile

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.delayProfiles.*.minimumCustomFormatScore Link copied!

Type: signed integer

Minimum custom format score to bypass delay

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.delayProfiles.*.order Link copied!

Type: signed integer

Order/priority of this delay profile (lower values = higher priority)

Default: 50

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.delayProfiles.*.preferredProtocol Link copied!

Type: one of "usenet", "torrent"

Preferred download protocol when both are available

Default: "usenet"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.delayProfiles.*.tags Link copied!

Type: list of signed integer

List of tag IDs this delay profile applies to (empty = applies to all)

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.delayProfiles.*.torrentDelay Link copied!

Type: signed integer

Delay in minutes before grabbing a Torrent release

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.delayProfiles.*.usenetDelay Link copied!

Type: signed integer

Delay in minutes before grabbing a Usenet release

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig Link copied!

Type: submodule

Host configuration options that will be set via the API /config/host endpoint

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.analyticsEnabled Link copied!

Type: boolean

Enable analytics

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.applicationUrl Link copied!

Type: string

Application URL

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.authenticationMethod Link copied!

Type: one of "none", "basic", "forms", "external"

Authentication method

Default: "forms"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.authenticationRequired Link copied!

Type: one of "enabled", "disabled", "disabledForLocalAddresses"

Authentication requirement level

Default: "enabled"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.backupFolder Link copied!

Type: string

Backup folder name

Default: "Backups"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.backupInterval Link copied!

Type: signed integer

Backup interval in days

Default: 7

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.backupRetention Link copied!

Type: signed integer

Backup retention in days

Default: 28

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.bindAddress Link copied!

Type: string

Address to bind to

Default: "0.0.0.0"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.branch Link copied!

Type: string

Update branch

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.certificateValidation Link copied!

Type: one of "enabled", "disabled", "disabledForLocalAddresses"

Certificate validation

Default: "enabled"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.consoleLogLevel Link copied!

Type: string

Console log level

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.enableSsl Link copied!

Type: boolean

Enable SSL

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.instanceName Link copied!

Type: string

Instance name

Default: "Radarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.launchBrowser Link copied!

Type: boolean

Launch browser on start (not applicable for NixOS services)

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.logLevel Link copied!

Type: one of "info", "debug", "trace"

Log level

Default: "info"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.logSizeLimit Link copied!

Type: signed integer

Log size limit in MB

Default: 1

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.password Link copied!

Type: null or string or (submodule)

Password for web interface authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port the service listens on

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.proxyBypassFilter Link copied!

Type: string

Proxy bypass filter

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.proxyBypassLocalAddresses Link copied!

Type: boolean

Proxy bypass local addresses

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.proxyEnabled Link copied!

Type: boolean

Enable proxy

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.proxyHostname Link copied!

Type: string

Proxy hostname

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.proxyPassword Link copied!

Type: string or (submodule)

Proxy password

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.proxyPort Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Proxy port

Default: 8080

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.proxyType Link copied!

Type: one of "http", "socks4", "socks5"

Proxy type

Default: "http"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.proxyUsername Link copied!

Type: string or (submodule)

Proxy username

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.sslCertPassword Link copied!

Type: string or (submodule)

SSL certificate password

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.sslCertPath Link copied!

Type: string

SSL certificate path

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.sslPort Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

SSL port

Default: 9898

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.trustCgnatIpAddresses Link copied!

Type: boolean

Trust CGNAT IP addresses

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.updateAutomatically Link copied!

Type: boolean

Update automatically

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.updateMechanism Link copied!

Type: one of "builtIn", "script", "external", "docker"

Update mechanism

Default: "builtIn"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.updateScriptPath Link copied!

Type: string

Update script path

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.urlBase Link copied!

Type: string

URL base path

Default: ""

Example: "/takeMeThere"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.hostConfig.username Link copied!

Type: null or string or (submodule)

Username for web interface authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.autoUnmonitorPreviouslyDownloadedMovies Link copied!

Type: boolean

Automatically unmonitor movies after they have been downloaded.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.chmodFolder Link copied!

Type: string

Octal permissions to apply to media folders.

Default: "755"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.chownGroup Link copied!

Type: string

Group name or gid to apply to media folders.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.copyUsingHardlinks Link copied!

Type: boolean

Use hardlinks instead of copying when importing from torrents still being seeded.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.createEmptyMovieFolders Link copied!

Type: boolean

Create missing movie folders during disk scan.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.deleteEmptyFolders Link copied!

Type: boolean

Delete empty folders during disk scan and when media files are deleted.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.downloadPropersAndRepacks Link copied!

Type: one of "preferAndUpgrade", "doNotUpgrade", "doNotPrefer"

How to handle proper and repack releases.

Default: "preferAndUpgrade"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.enableMediaInfo Link copied!

Type: boolean

Scan video files for media info such as resolution, runtime, and codec.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.extraFileExtensions Link copied!

Type: string

Comma-separated list of extra file extensions to import.

Default: "srt"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.fileDate Link copied!

Type: one of "none", "cinemas", "physical", "digital"

Set the file date on imported media files.

Default: "none"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.importExtraFiles Link copied!

Type: boolean

Import matching extra files alongside media files.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.minimumFreeSpaceWhenImporting Link copied!

Type: signed integer

Minimum free space in MB to leave on the disk when importing.

Default: 100

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.recycleBin Link copied!

Type: string

Path to the recycle bin directory.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.recycleBinCleanupDays Link copied!

Type: signed integer

Number of days before items in the recycle bin are permanently deleted.

Default: 7

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.rescanAfterRefresh Link copied!

Type: one of "always", "afterManual", "never"

When to rescan the media folder after refreshing media information.

Default: "always"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.scriptImportPath Link copied!

Type: string

Path to the custom import script.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.setPermissionsLinux Link copied!

Type: boolean

Set chmod and chown on imported files and media folders.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.skipFreeSpaceCheckWhenImporting Link copied!

Type: boolean

Skip the free space check when importing media files.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.mediaManagement.useScriptImport Link copied!

Type: boolean

Use a custom script for importing instead of the built-in import.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.config.rootFolders Link copied!

Type: list of (attribute set)

List of root folders to create via the API /rootfolder endpoint. Each folder is an attribute set that will be converted to JSON and sent to the API.

For Sonarr/Radarr, a simple path is sufficient: {path = "/path/to/folder";}

For Lidarr, additional fields are required like defaultQualityProfileId, etc.

Default: map (mediaDir: {path = mediaDir;}) nixflix.radarr.mediaDirs

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.connectionAddress Link copied!

read-only

Type: string

Address for connecting to this service.

Default: "127.0.0.1"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.dataDir Link copied!

Type: absolute path

Directory containing Seerr data and configuration

Default: "${config.nixflix.stateDir}/${serviceName}"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.enable Link copied!

Type: boolean

Whether to enable Radarr.

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.group Link copied!

Type: string

Group under which the service runs

Default: "radarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.mediaDirs Link copied!

Type: list of absolute path

List of media directories to create and manage

Default: [config.nixflix.mediaDir + "/<media-type>"]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.openFirewall Link copied!

Type: boolean

Open ports in the firewall for the Radarr web interface.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.package Link copied!

Type: package

The radarr package to use.

Default: pkgs.radarr

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.reverseProxy.expose Link copied!

Type: boolean

Whether to expose this service via the reverse proxy.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.settings Link copied!

Type: open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Attribute set of arbitrary config options. Please consult the documentation at the wiki.

!!! warning

This configuration is stored in the world-readable Nix store!
Don't put secrets here!

Default:

{
  auth = {
    required = "Enabled";
    method = "Forms";
  };
  server = {
    inherit (config.nixflix.radarr.config.hostConfig) port urlBase;
  };
} // optionalAttrs config.nixflix.postgres.enable {
  log.dbEnabled = true;
  postgres = {
    user = config.nixflix.radarr.user;
    host = "/run/postgresql";
    port = config.services.postgresql.settings.port;
    mainDb = config.nixflix.radarr.user;
    logDb = "${config.nixflix.radarr.user}-logs";
  };
}

Example:

{
  update.mechanism = "internal";
  server = {
    urlbase = "localhost";
    port = 8989;
    bindaddress = "*";
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.settings.app.instanceName Link copied!

Type: string

Name of the instance

Default: "Radarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.settings.log.analyticsEnabled Link copied!

Type: boolean

Send Anonymous Usage Data

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.settings.server.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port Number

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.settings.update.automatically Link copied!

Type: boolean

Automatically download and install updates.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.settings.update.mechanism Link copied!

Type: null or one of "external", "builtIn", "script"

which update mechanism to use

Default: "external"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.subdomain Link copied!

Type: string

Subdomain prefix for reverse proxy. Service accessible at <subdomain>.<domain>.

Default: "radarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.user Link copied!

Type: string

User under which the service runs

Default: "radarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.radarr.vpn.enable Link copied!

Type: boolean

Whether to route Radarr traffic through the VPN.

When false (default), Radarr bypasses the VPN to prevent Cloudflare and image provider blocks. When true, Radarr routes through the VPN (requires nixflix.vpn.enable = true).

TRaSH Guides recommend leaving this false.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/radarr.nix

nixflix.recyclarr.cleanupUnmanagedProfiles.enable Link copied!

Type: boolean

Whether to automatically remove quality profiles from Sonarr and Radarr that are are unmanaged.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr

nixflix.recyclarr.cleanupUnmanagedProfiles.managedProfiles Link copied!

Type: list of string

List of profiles to keep.

This list must be manually maintained if you change the default Recyclarr configuration.

Default:

optional (cfg.radarrQuality == "4K") "[SQP] SQP-1 (2160p)"
++ optional (cfg.radarrQuality == "1080p") "[SQP] SQP-1 (1080p)"
++ optional (cfg.sonarrQuality == "4K") "WEB-2160p (Alternative)"
++ optional (cfg.sonarrQuality == "1080p") "WEB-1080p (Alternative)"
++ optional config.nixflix.sonarr-anime.enable "[Anime] Remux-1080p";

Example:

[
  "My Custom Profile"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr

nixflix.recyclarr.config Link copied!

Type: null or (submodule)

Recyclarr configuration as a structured Nix attribute set. When set, this completely replaces the auto-generated configuration, giving you full control over the Recyclarr setup.

The structure is: { service_type.instance_name = { ... }; }

service_type: sonarr or radarr (only these two keys are allowed)
instance_name: arbitrary name for the instance (e.g., sonarr_main, radarr_4k)

Defaults are sonarr.sonarr, sonarr.sonarr_anime, and radarr.radarr.

Each instance supports guide-backed quality profiles (via trash_id) or user-defined ones (via name), custom formats and custom format groups from TRaSH guides, media naming, media management (e.g. Propers and Repacks handling), and template/file includes.

Config Reference

Default: "Generated from `nixflix.sonarr`, `nixflix.sonarr-anime`, and `nixflix.radarr` settings"

Example:

{
  sonarr.sonarr_main = {
    base_url = "http://127.0.0.1:8989";
    api_key._secret = "/run/credentials/recyclarr.service/sonarr-api_key";
    quality_definition.type = "series";
    quality_profiles = [{
      trash_id = "dfa5eaae7894077ad6449169b6eb03e0"; # WEB-2160p (Alternative)
      reset_unmatched_scores.enabled = true;
    }];
    custom_format_groups.add = [{
      trash_id = "e3f37512790f00d0e89e54fe5e790d1c"; # [Required] Golden Rule UHD
      select = [ "9b64dff695c2115facf1b6ea59c9bd07" ]; # x265 (no HDR/DV)
    }];
  };
  radarr.radarr_main = {
    base_url = "http://127.0.0.1:7878";
    api_key._secret = "/run/credentials/recyclarr.service/radarr-api_key";
    quality_definition.type = "movie";
    media_management.propers_and_repacks = "do_not_prefer";
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr Link copied!

Type: null or (attribute set of (submodule))

Radarr instance configurations

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.api_key Link copied!

Type: string or (submodule)

The API key that Recyclarr should use to synchronize settings to your instance.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.custom_formats.*.trash_ids Link copied!

Type: list of string

Trash IDs of the custom formats to synchronize.

Default: [ ]

Example:

[
  "85c61753df5da1fb2aab6f2a47426b09"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.media_naming Link copied!

Type: null or (submodule)

Type: one of "movie", "anime", "sqp-streaming", "sqp-uhd"

Identifies which quality size settings to parse and upload.

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles Link copied!

Type: list of (submodule)

An array of quality profiles that Recyclarr should create or modify.

Prefer setting trash_id to use a guide-backed profile — qualities, custom formats, scores, and language will be configured automatically from the TRaSH Guides. For user-defined profiles, set name along with qualities and other fields.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles.*.min_format_score Link copied!

Type: null or signed integer

Correlates directly to the 'Minimum Custom Format Score' field in the Quality Profile edit dialog in Radarr/Sonarr.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles.*.min_upgrade_format_score Link copied!

Type: null or signed integer

Correlates directly to the 'Minimum Custom Format Score For Upgrades' field in the Quality Profile edit dialog in Radarr/Sonarr.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles.*.name Link copied!

Type: null or string

The name of the quality profile. For guide-backed profiles (with trash_id), this defaults to the guide's recommended name and may be overridden. For user-defined profiles, this is the profile identity. Either trash_id or name is required.

Default: null

Example: "WEB-2160p"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles.*.qualities Link copied!

Type: null or (list of (submodule))

Ordered list of qualities in the profile (from highest to lowest priority).

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles..qualities..enabled Link copied!

Type: boolean

If true, this quality will be allowed. If false, this quality will be disallowed.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles..qualities..name Link copied!

Type: string

The name of an existing quality. If this is a quality group, this name identifies either an existing quality group or will be used as the name for a newly created group.

Example: "WEB 2160p"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles..qualities..qualities Link copied!

Type: null or (list of string)

A list of one or more existing qualities to bundle into a group. By specifying this list, you implicitly make this item a quality group.

Default: null

Example:

[
  "WEBDL-2160p"
  "WEBRip-2160p"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles.*.trash_id Link copied!

Type: null or string

The trash ID of a TRaSH Guide quality profile definition.

Default: null

Example: "0896c29d74de619df168d23b98104b22"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles.*.upgrade Link copied!

Type: null or (submodule)

Upgrade configuration for the quality profile.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles.*.upgrade.allowed Link copied!

Type: boolean

Directly correlates to the 'Upgrades Allowed' checkbox in the Quality Profile edit dialog in Radarr/Sonarr.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles.*.upgrade.until_quality Link copied!

Type: null or string

The quality name mentioned here must exist in the qualities list or be a valid quality in your profile.

Default: null

Example: "WEB 2160p"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.radarr.<name>.quality_profiles.*.upgrade.until_score Link copied!

Type: null or signed integer

Correlates directly to the 'Upgrade Until Custom Format Score' field in the Quality Profile edit dialog.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr Link copied!

Type: null or (attribute set of (submodule))

Sonarr instance configurations

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.api_key Link copied!

Type: string or (submodule)

The API key that Recyclarr should use to synchronize settings to your instance.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.custom_formats.*.trash_ids Link copied!

Type: list of string

Trash IDs of the custom formats to synchronize.

Default: [ ]

Example:

[
  "85c61753df5da1fb2aab6f2a47426b09"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.media_naming Link copied!

Type: null or (submodule)

Type: null or nonnegative integer or floating point number, meaning >=0, or value "unlimited" (singular enum)

Preferred size in MB per minute of runtime, or "unlimited".

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.quality_definition.type Link copied!

Type: one of "series", "anime"

Identifies which quality size settings to parse and upload.

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.quality_profiles Link copied!

Type: list of (submodule)

An array of quality profiles that Recyclarr should create or modify.

Prefer setting trash_id to use a guide-backed profile — qualities, custom formats, scores, and language will be configured automatically from the TRaSH Guides. For user-defined profiles, set name along with qualities and other fields.

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.quality_profiles.*.min_format_score Link copied!

Type: null or signed integer

Correlates directly to the 'Minimum Custom Format Score' field in the Quality Profile edit dialog in Radarr/Sonarr.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.quality_profiles.*.min_upgrade_format_score Link copied!

Type: null or signed integer

Correlates directly to the 'Minimum Custom Format Score For Upgrades' field in the Quality Profile edit dialog in Radarr/Sonarr.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.quality_profiles.*.name Link copied!

Type: null or string

The name of the quality profile. For guide-backed profiles (with trash_id), this defaults to the guide's recommended name and may be overridden. For user-defined profiles, this is the profile identity. Either trash_id or name is required.

Default: null

Example: "WEB-2160p"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.quality_profiles.*.qualities Link copied!

Type: null or (list of (submodule))

Ordered list of qualities in the profile (from highest to lowest priority).

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.quality_profiles..qualities..enabled Link copied!

Type: boolean

If true, this quality will be allowed. If false, this quality will be disallowed.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.quality_profiles..qualities..name Link copied!

Type: string

The name of an existing quality. If this is a quality group, this name identifies either an existing quality group or will be used as the name for a newly created group.

Example: "WEB 2160p"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.quality_profiles..qualities..qualities Link copied!

Type: null or (list of string)

A list of one or more existing qualities to bundle into a group. By specifying this list, you implicitly make this item a quality group.

Default: null

Example:

[
  "WEBDL-2160p"
  "WEBRip-2160p"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

nixflix.recyclarr.config.sonarr.<name>.quality_profiles.*.trash_id Link copied!

Type: null or string

The trash ID of a TRaSH Guide quality profile definition.

Default: null

Example: "0896c29d74de619df168d23b98104b22"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr/config-option.nix

Type: one of "4K", "1080p"

Allows for easy recyclarr quality profile configuration for the radarr instance.

This option selects profiles that prioritize acquisition over quality. Lower quality hits that meet TRaSH standards will be accepted and grabbed.

4k creates a profile named "[SQP] SQP-1 (2160p)"
1080p creates a profile named "[SQP] SQP-1 (1080p)"

If you want Seerr to use these, you'll have to configure them manually.

Complex configurations can be manually applied using nixflix.recyclarr.config.radarr.radarr. If you do, you need to set nixflix.recyclarr.config.radarr.radarr.quality_profiles = mkForce [];.

Default: "1080p"

Example: "4K"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr

nixflix.recyclarr.sonarrQuality Link copied!

Type: one of "4K", "1080p"

Allows for easy recyclarr quality profile configuration for the sonarr instance. Does not effect Sonarr Anime.

This option selects profiles that prioritize acquisition over quality. Lower quality hits that meet TRaSH standards will be accepted and grabbed.

4k creates a quality profile named "WEB-2160p (Alternative)"
1080p creates a quality profile named "WEB-1080p (Alternative)"

If you want Seerr to use these, you'll have to configure them manually.

Complex configurations can be manually applied using nixflix.recyclarr.config.sonarr.sonarr. If you do, you need to set nixflix.recyclarr.config.sonarr.sonarr.quality_profiles = mkForce [];.

Default: "1080p"

Example: "4K"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr

nixflix.recyclarr.user Link copied!

Type: string

User under which Recyclarr runs.

Default: "recyclarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/recyclarr

nixflix.seerr.apiKey Link copied!

Type: string or (submodule)

API key for Seerr. Can be created with:

uuidgen | base64

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/options.nix

nixflix.seerr.connectionAddress Link copied!

read-only

Type: string

Address for connecting to this service.

Default: "127.0.0.1"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/options.nix

nixflix.seerr.dataDir Link copied!

Type: absolute path

Directory containing Seerr data and configuration

Default: "${nixflix.stateDir}/seerr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/options.nix

nixflix.seerr.enable Link copied!

Type: boolean

Whether to enable Seerr media request manager.

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/options.nix

nixflix.seerr.externalUrlScheme Link copied!

Type: string

Scheme to use for external linking to other services from within Seerr.

Default: "http"

Example: "https"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/options.nix

nixflix.seerr.group Link copied!

Type: string

Group under which the service runs

Default: "seerr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/options.nix

nixflix.seerr.jellyfin.adminPassword Link copied!

Type: string or (submodule)

Jellyfin admin password for Seerr authentication.

Auto-derived from nixflix.jellyfin.users when Jellyfin is enabled locally. Must be set explicitly when using a remote Jellyfin instance.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: password of first admin from nixflix.jellyfin.users, or null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/jellyfin/options.nix

nixflix.seerr.jellyfin.adminUsername Link copied!

Type: null or string

Jellyfin admin username for Seerr authentication.

Auto-derived from nixflix.jellyfin.users when Jellyfin is enabled locally. Must be set explicitly when using a remote Jellyfin instance.

Default: first admin username from nixflix.jellyfin.users, or null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/jellyfin/options.nix

nixflix.seerr.jellyfin.enableAllLibraries Link copied!

Type: boolean

Enable all Jellyfin libraries (fetched from API). Set to false to use libraryFilter.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/jellyfin/options.nix

nixflix.seerr.jellyfin.externalHostname Link copied!

Type: string

This option has no description.

Default:

if config.nixflix.reverseProxy.enable != ""
then "$${config.nixflix.seerr.externalUrlScheme}://$${config.nixflix.jellyfin.subdomain}.$${config.nixflix.reverseProxy.domain}"
else "";

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/jellyfin/options.nix

nixflix.seerr.jellyfin.hostname Link copied!

Type: string

Jellyfin server hostname

Default: config.nixflix.jellyfin.connectionAddress

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/jellyfin/options.nix

nixflix.seerr.jellyfin.libraryFilter Link copied!

Type: submodule

Filter which libraries to enable (only used when enableAllLibraries = false)

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/jellyfin/options.nix

nixflix.seerr.jellyfin.libraryFilter.names Link copied!

Type: list of string

Only enable libraries matching these names (empty = all names)

Default: [ ]

Example:

[
  "Movies"
  "TV Shows"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/jellyfin/options.nix

nixflix.seerr.jellyfin.libraryFilter.types Link copied!

Type: list of (one of "movie", "show")

Only enable libraries of these types (empty = all types)

Default: [ ]

Example:

[
  "movie"
  "show"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/jellyfin/options.nix

nixflix.seerr.jellyfin.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Jellyfin server port

Default: config.nixflix.jellyfin.network.internalHttpPort

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/jellyfin/options.nix

nixflix.seerr.jellyfin.serverType Link copied!

Type: signed integer

Server type (2 = Jellyfin)

Default: 2

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/jellyfin/options.nix

nixflix.seerr.jellyfin.urlBase Link copied!

Type: string

Jellyfin URL base

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/jellyfin/options.nix

nixflix.seerr.jellyfin.useSsl Link copied!

Type: boolean

Use SSL to connect to Jellyfin

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/jellyfin/options.nix

nixflix.seerr.openFirewall Link copied!

Type: boolean

Open port in firewall for Seerr

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/options.nix

nixflix.seerr.package Link copied!

Type: package

The seerr package to use.

Default: pkgs.seerr

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/options.nix

nixflix.seerr.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port on which Seerr listens

Default: 5055

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/options.nix

nixflix.seerr.radarr Link copied!

Type: attribute set of (submodule)

Radarr instances to configure. Automatically configured from config.nixflix.radarr when enabled, otherwise {}.

Default instances can be overridden with lib.mkForce {}.

Default: { }

Example:

{
  Radarr = {
    activeDirectory = "/movies";
    activeProfileName = "HD-1080p";
    apiKey = {
      _secret = "/run/secrets/radarr-apikey";
    };
  };
  "Radarr 4K" = {
    activeDirectory = "/movies-4k";
    activeProfileName = "UHD-2160p";
    apiKey = {
      _secret = "/run/secrets/radarr-4k-apikey";
    };
    is4k = true;
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/radarr/options.nix

nixflix.seerr.radarr.<name>.activeDirectory Link copied!

Type: string

Root folder for movies

Default: head (config.nixflix.radarr.mediaDirs or ["/movies"])

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/radarr/options.nix

nixflix.seerr.radarr.<name>.activeProfileName Link copied!

Type: null or string

Quality profile name. Defaults to first available quality profile in Seerr.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/radarr/options.nix

nixflix.seerr.radarr.<name>.apiKey Link copied!

Type: string or (submodule)

Radarr API key.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/radarr/options.nix

nixflix.seerr.radarr.<name>.baseUrl Link copied!

Type: string

Type: boolean

Whether to expose Seerr via the reverse proxy.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/options.nix

nixflix.seerr.settings.users Link copied!

Type: submodule

Default user settings for Seerr (authentication, permissions, and quotas)

Default:

{
  localLogin = true;
  mediaServerLogin = true;
  newPlexLogin = true;
  defaultPermissions = 32;
  defaultQuotas = {
    movie = { quotaLimit = 0; quotaDays = 7; };
    tv = { quotaLimit = 0; quotaDays = 7; };
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/users/options.nix

nixflix.seerr.settings.users.defaultPermissions Link copied!

Type: signed integer

Default permission flags for newly created users. Common values: 0 (none), 32 (REQUEST - default), 1024 (ADMIN), 160 (Auto-approve non-4k)

Default: 32

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/users/options.nix

nixflix.seerr.settings.users.defaultQuotas Link copied!

Type: submodule

Default request quotas for new users

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/users/options.nix

nixflix.seerr.settings.users.defaultQuotas.movie Link copied!

Type: submodule

This option has no description.

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/users/options.nix

nixflix.seerr.settings.users.defaultQuotas.movie.quotaDays Link copied!

Type: positive integer, meaning >0

Quota period in days

Default: 7

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/users/options.nix

nixflix.seerr.settings.users.defaultQuotas.movie.quotaLimit Link copied!

Type: unsigned integer, meaning >=0

Max movie requests per period (0 = unlimited)

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/users/options.nix

nixflix.seerr.settings.users.defaultQuotas.tv Link copied!

Type: submodule

This option has no description.

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/users/options.nix

nixflix.seerr.settings.users.defaultQuotas.tv.quotaDays Link copied!

Type: positive integer, meaning >0

Quota period in days

Default: 7

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/users/options.nix

nixflix.seerr.settings.users.defaultQuotas.tv.quotaLimit Link copied!

Type: unsigned integer, meaning >=0

Max TV requests per period (0 = unlimited)

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/users/options.nix

nixflix.seerr.settings.users.localLogin Link copied!

Type: boolean

Enable local account authentication independent of Jellyfin/Plex

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/users/options.nix

nixflix.seerr.settings.users.mediaServerLogin Link copied!

Type: boolean

Enable authentication via connected media server (Jellyfin/Plex)

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/users/options.nix

nixflix.seerr.settings.users.newPlexLogin Link copied!

Type: boolean

Allow new Plex users to authenticate and create accounts

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/users/options.nix

nixflix.seerr.sonarr Link copied!

Type: attribute set of (submodule)

Sonarr instances to configure. Automatically configured from config.nixflix.sonarr and config.nixflix.sonarr-anime when enabled, otherwise {}.

Default instances can be overridden with lib.mkForce {}.

Default: { }

Example:

{
  Sonarr = {
    activeDirectory = "/tv";
    activeProfileName = "WEB-1080p";
    port = 8989;
  };
  "Sonarr Anime" = {
    activeDirectory = "/anime";
    activeProfileName = "Remux-1080p - Anime";
    port = 8990;
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/sonarr/options.nix

nixflix.seerr.sonarr.<name>.activeAnimeDirectory Link copied!

Type: string

Root folder for anime

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/sonarr/options.nix

nixflix.seerr.sonarr.<name>.activeAnimeProfileName Link copied!

Type: null or string

Anime quality profile name.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/sonarr/options.nix

nixflix.seerr.sonarr.<name>.activeDirectory Link copied!

Type: string

Root folder for TV shows

Default: head (config.nixflix.sonarr.mediaDirs or ["/tv"])

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/sonarr/options.nix

nixflix.seerr.sonarr.<name>.activeProfileName Link copied!

Type: null or string

Quality profile name. Defaults to first available quality profile in Seerr.

Default: null

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/sonarr/options.nix

nixflix.seerr.sonarr.<name>.animeSeriesType Link copied!

Type: one of "standard", "anime"

Series type for anime content

Default: "standard"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/sonarr/options.nix

nixflix.seerr.sonarr.<name>.apiKey Link copied!

Type: string or (submodule)

Sonarr API key.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/seerr/sonarr/options.nix

nixflix.seerr.sonarr.<name>.baseUrl Link copied!

Type: string

nixflix.serviceDependencies Link copied!

Type: list of string

List of systemd services that nixflix services should wait for before starting. Useful for mounting encrypted drives, starting VPNs, or other prerequisites.

Default: [ ]

Example:

[
  "unlock-raid.service"
  "tailscale.service"
]

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.sonarr-anime.config.apiKey Link copied!

Type: string or (submodule)

API key for Sonarr-anime. Can be created by running:

openssl rand -hex 16

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.apiVersion Link copied!

Type: string

Current version of the API of the service

Default: "v3"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.delayProfiles Link copied!

Type: list of (submodule)

List of delay profiles to configure via the API /delayprofile endpoint.

Profiles are created/updated in id order. If no profile with id=1 is provided, a default profile will be added automatically.

Default:

[
  {
    enableUsenet = true;
    enableTorrent = true;
    preferredProtocol = "usenet";
    usenetDelay = 0;
    torrentDelay = 0;
    bypassIfHighestQuality = true;
    bypassIfAboveCustomFormatScore = false;
    minimumCustomFormatScore = 0;
    order = 2147483647;
    tags = [];
    id = 1;
  };
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.delayProfiles.*.bypassIfAboveCustomFormatScore Link copied!

Type: boolean

Bypass delay if custom format score is above minimum

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.delayProfiles.*.bypassIfHighestQuality Link copied!

Type: boolean

Bypass delay if release is the highest quality available

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.delayProfiles.*.enableTorrent Link copied!

Type: boolean

Enable Torrent protocol for this profile

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.delayProfiles.*.enableUsenet Link copied!

Type: boolean

Enable Usenet protocol for this profile

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.delayProfiles.*.id Link copied!

Type: signed integer

Unique identifier for the delay profile

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.delayProfiles.*.minimumCustomFormatScore Link copied!

Type: signed integer

Minimum custom format score to bypass delay

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.delayProfiles.*.order Link copied!

Type: signed integer

Order/priority of this delay profile (lower values = higher priority)

Default: 50

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.delayProfiles.*.preferredProtocol Link copied!

Type: one of "usenet", "torrent"

Preferred download protocol when both are available

Default: "usenet"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.delayProfiles.*.tags Link copied!

Type: list of signed integer

List of tag IDs this delay profile applies to (empty = applies to all)

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.delayProfiles.*.torrentDelay Link copied!

Type: signed integer

Delay in minutes before grabbing a Torrent release

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.delayProfiles.*.usenetDelay Link copied!

Type: signed integer

Delay in minutes before grabbing a Usenet release

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig Link copied!

Type: submodule

Host configuration options that will be set via the API /config/host endpoint

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.analyticsEnabled Link copied!

Type: boolean

Enable analytics

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.applicationUrl Link copied!

Type: string

Application URL

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.authenticationMethod Link copied!

Type: one of "none", "basic", "forms", "external"

Authentication method

Default: "forms"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.authenticationRequired Link copied!

Type: one of "enabled", "disabled", "disabledForLocalAddresses"

Authentication requirement level

Default: "enabled"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.backupFolder Link copied!

Type: string

Backup folder name

Default: "Backups"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.backupInterval Link copied!

Type: signed integer

Backup interval in days

Default: 7

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.backupRetention Link copied!

Type: signed integer

Backup retention in days

Default: 28

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.bindAddress Link copied!

Type: string

Address to bind to

Default: "0.0.0.0"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.branch Link copied!

Type: string

Update branch

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.certificateValidation Link copied!

Type: one of "enabled", "disabled", "disabledForLocalAddresses"

Certificate validation

Default: "enabled"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.consoleLogLevel Link copied!

Type: string

Console log level

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.enableSsl Link copied!

Type: boolean

Enable SSL

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.instanceName Link copied!

Type: string

Instance name

Default: "Sonarr-anime"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.launchBrowser Link copied!

Type: boolean

Launch browser on start (not applicable for NixOS services)

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.logLevel Link copied!

Type: one of "info", "debug", "trace"

Log level

Default: "info"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.logSizeLimit Link copied!

Type: signed integer

Log size limit in MB

Default: 1

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.password Link copied!

Type: null or string or (submodule)

Password for web interface authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port the service listens on

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.proxyBypassFilter Link copied!

Type: string

Proxy bypass filter

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.proxyBypassLocalAddresses Link copied!

Type: boolean

Proxy bypass local addresses

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.proxyEnabled Link copied!

Type: boolean

Enable proxy

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.proxyHostname Link copied!

Type: string

Proxy hostname

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.proxyPassword Link copied!

Type: string or (submodule)

Proxy password

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.proxyPort Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Proxy port

Default: 8080

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.proxyType Link copied!

Type: one of "http", "socks4", "socks5"

Proxy type

Default: "http"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.proxyUsername Link copied!

Type: string or (submodule)

Proxy username

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.sslCertPassword Link copied!

Type: string or (submodule)

SSL certificate password

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.sslCertPath Link copied!

Type: string

SSL certificate path

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.sslPort Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

SSL port

Default: 9898

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.trustCgnatIpAddresses Link copied!

Type: boolean

Trust CGNAT IP addresses

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.updateAutomatically Link copied!

Type: boolean

Update automatically

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.updateMechanism Link copied!

Type: one of "builtIn", "script", "external", "docker"

Update mechanism

Default: "builtIn"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.updateScriptPath Link copied!

Type: string

Update script path

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.urlBase Link copied!

Type: string

URL base path

Default: ""

Example: "/takeMeThere"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.hostConfig.username Link copied!

Type: null or string or (submodule)

Username for web interface authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.autoUnmonitorPreviouslyDownloadedEpisodes Link copied!

Type: boolean

Automatically unmonitor episodes after they have been downloaded.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.chmodFolder Link copied!

Type: string

Octal permissions to apply to media folders.

Default: "755"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.chownGroup Link copied!

Type: string

Group name or gid to apply to media folders.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.copyUsingHardlinks Link copied!

Type: boolean

Use hardlinks instead of copying when importing from torrents still being seeded.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.createEmptySeriesFolders Link copied!

Type: boolean

Create missing series folders during disk scan.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.deleteEmptyFolders Link copied!

Type: boolean

Delete empty folders during disk scan and when media files are deleted.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.downloadPropersAndRepacks Link copied!

Type: one of "preferAndUpgrade", "doNotUpgrade", "doNotPrefer"

How to handle proper and repack releases.

Default: "preferAndUpgrade"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.enableMediaInfo Link copied!

Type: boolean

Scan video files for media info such as resolution, runtime, and codec.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.episodeTitleRequired Link copied!

Type: one of "always", "bulkSeasonReleases", "never"

Prevent importing for a limited time if the episode title is TBA.

Default: "always"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.extraFileExtensions Link copied!

Type: string

Comma-separated list of extra file extensions to import.

Default: "srt"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.fileDate Link copied!

Type: one of "none", "localAirDate", "utcAirDate"

Set the file date on imported media files.

Default: "none"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.importExtraFiles Link copied!

Type: boolean

Import matching extra files alongside media files.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.minimumFreeSpaceWhenImporting Link copied!

Type: signed integer

Minimum free space in MB to leave on the disk when importing.

Default: 100

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.recycleBin Link copied!

Type: string

Path to the recycle bin directory.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.recycleBinCleanupDays Link copied!

Type: signed integer

Number of days before items in the recycle bin are permanently deleted.

Default: 7

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.rescanAfterRefresh Link copied!

Type: one of "always", "afterManual", "never"

When to rescan the media folder after refreshing media information.

Default: "always"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.scriptImportPath Link copied!

Type: string

Path to the custom import script.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.setPermissionsLinux Link copied!

Type: boolean

Set chmod and chown on imported files and media folders.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.skipFreeSpaceCheckWhenImporting Link copied!

Type: boolean

Skip the free space check when importing media files.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.mediaManagement.useScriptImport Link copied!

Type: boolean

Use a custom script for importing instead of the built-in import.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.config.rootFolders Link copied!

Type: list of (attribute set)

List of root folders to create via the API /rootfolder endpoint. Each folder is an attribute set that will be converted to JSON and sent to the API.

For Sonarr/Radarr, a simple path is sufficient: {path = "/path/to/folder";}

For Lidarr, additional fields are required like defaultQualityProfileId, etc.

Default: map (mediaDir: {path = mediaDir;}) nixflix.sonarr-anime.mediaDirs

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.connectionAddress Link copied!

read-only

Type: string

Address for connecting to this service.

Default: "127.0.0.1"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.dataDir Link copied!

Type: absolute path

Directory containing Seerr data and configuration

Default: "${config.nixflix.stateDir}/${serviceName}"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.enable Link copied!

Type: boolean

Whether to enable Sonarr-anime.

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.group Link copied!

Type: string

Group under which the service runs

Default: "sonarr-anime"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.mediaDirs Link copied!

Type: list of absolute path

List of media directories to create and manage

Default: [config.nixflix.mediaDir + "/<media-type>"]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.openFirewall Link copied!

Type: boolean

Open ports in the firewall for the Radarr web interface.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.package Link copied!

Type: package

The sonarr package to use.

Default: pkgs.sonarr

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.reverseProxy.expose Link copied!

Type: boolean

Whether to expose this service via the reverse proxy.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.settings Link copied!

Type: open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Attribute set of arbitrary config options. Please consult the documentation at the wiki.

!!! warning

This configuration is stored in the world-readable Nix store!
Don't put secrets here!

Default:

{
  auth = {
    required = "Enabled";
    method = "Forms";
  };
  server = {
    inherit (config.nixflix.sonarr-anime.config.hostConfig) port urlBase;
  };
} // optionalAttrs config.nixflix.postgres.enable {
  log.dbEnabled = true;
  postgres = {
    user = config.nixflix.sonarr-anime.user;
    host = "/run/postgresql";
    port = config.services.postgresql.settings.port;
    mainDb = config.nixflix.sonarr-anime.user;
    logDb = "${config.nixflix.sonarr-anime.user}-logs";
  };
}

Example:

{
  update.mechanism = "internal";
  server = {
    urlbase = "localhost";
    port = 8989;
    bindaddress = "*";
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.settings.app.instanceName Link copied!

Type: string

Name of the instance

Default: "Sonarr-anime"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.settings.log.analyticsEnabled Link copied!

Type: boolean

Send Anonymous Usage Data

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.settings.server.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port Number

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.settings.update.automatically Link copied!

Type: boolean

Automatically download and install updates.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.settings.update.mechanism Link copied!

Type: null or one of "external", "builtIn", "script"

which update mechanism to use

Default: "external"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.subdomain Link copied!

Type: string

Subdomain prefix for reverse proxy. Service accessible at <subdomain>.<domain>.

Default: "sonarr-anime"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.user Link copied!

Type: string

User under which the service runs

Default: "sonarr-anime"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr-anime.vpn.enable Link copied!

Type: boolean

Whether to route Sonarr-anime traffic through the VPN.

When false (default), Sonarr-anime bypasses the VPN to prevent Cloudflare and image provider blocks. When true, Sonarr-anime routes through the VPN (requires nixflix.vpn.enable = true).

TRaSH Guides recommend leaving this false.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr-anime.nix

nixflix.sonarr.config.apiKey Link copied!

Type: string or (submodule)

API key for Sonarr. Can be created by running:

openssl rand -hex 16

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.apiVersion Link copied!

Type: string

Current version of the API of the service

Default: "v3"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.delayProfiles Link copied!

Type: list of (submodule)

List of delay profiles to configure via the API /delayprofile endpoint.

Profiles are created/updated in id order. If no profile with id=1 is provided, a default profile will be added automatically.

Default:

[
  {
    enableUsenet = true;
    enableTorrent = true;
    preferredProtocol = "usenet";
    usenetDelay = 0;
    torrentDelay = 0;
    bypassIfHighestQuality = true;
    bypassIfAboveCustomFormatScore = false;
    minimumCustomFormatScore = 0;
    order = 2147483647;
    tags = [];
    id = 1;
  };
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.delayProfiles.*.bypassIfAboveCustomFormatScore Link copied!

Type: boolean

Bypass delay if custom format score is above minimum

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.delayProfiles.*.bypassIfHighestQuality Link copied!

Type: boolean

Bypass delay if release is the highest quality available

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.delayProfiles.*.enableTorrent Link copied!

Type: boolean

Enable Torrent protocol for this profile

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.delayProfiles.*.enableUsenet Link copied!

Type: boolean

Enable Usenet protocol for this profile

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.delayProfiles.*.id Link copied!

Type: signed integer

Unique identifier for the delay profile

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.delayProfiles.*.minimumCustomFormatScore Link copied!

Type: signed integer

Minimum custom format score to bypass delay

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.delayProfiles.*.order Link copied!

Type: signed integer

Order/priority of this delay profile (lower values = higher priority)

Default: 50

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.delayProfiles.*.preferredProtocol Link copied!

Type: one of "usenet", "torrent"

Preferred download protocol when both are available

Default: "usenet"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.delayProfiles.*.tags Link copied!

Type: list of signed integer

List of tag IDs this delay profile applies to (empty = applies to all)

Default: [ ]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.delayProfiles.*.torrentDelay Link copied!

Type: signed integer

Delay in minutes before grabbing a Torrent release

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.delayProfiles.*.usenetDelay Link copied!

Type: signed integer

Delay in minutes before grabbing a Usenet release

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig Link copied!

Type: submodule

Host configuration options that will be set via the API /config/host endpoint

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.analyticsEnabled Link copied!

Type: boolean

Enable analytics

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.applicationUrl Link copied!

Type: string

Application URL

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.authenticationMethod Link copied!

Type: one of "none", "basic", "forms", "external"

Authentication method

Default: "forms"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.authenticationRequired Link copied!

Type: one of "enabled", "disabled", "disabledForLocalAddresses"

Authentication requirement level

Default: "enabled"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.backupFolder Link copied!

Type: string

Backup folder name

Default: "Backups"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.backupInterval Link copied!

Type: signed integer

Backup interval in days

Default: 7

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.backupRetention Link copied!

Type: signed integer

Backup retention in days

Default: 28

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.bindAddress Link copied!

Type: string

Address to bind to

Default: "0.0.0.0"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.branch Link copied!

Type: string

Update branch

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.certificateValidation Link copied!

Type: one of "enabled", "disabled", "disabledForLocalAddresses"

Certificate validation

Default: "enabled"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.consoleLogLevel Link copied!

Type: string

Console log level

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.enableSsl Link copied!

Type: boolean

Enable SSL

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.instanceName Link copied!

Type: string

Instance name

Default: "Sonarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.launchBrowser Link copied!

Type: boolean

Launch browser on start (not applicable for NixOS services)

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.logLevel Link copied!

Type: one of "info", "debug", "trace"

Log level

Default: "info"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.logSizeLimit Link copied!

Type: signed integer

Log size limit in MB

Default: 1

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.password Link copied!

Type: null or string or (submodule)

Password for web interface authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port the service listens on

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.proxyBypassFilter Link copied!

Type: string

Proxy bypass filter

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.proxyBypassLocalAddresses Link copied!

Type: boolean

Proxy bypass local addresses

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.proxyEnabled Link copied!

Type: boolean

Enable proxy

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.proxyHostname Link copied!

Type: string

Proxy hostname

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.proxyPassword Link copied!

Type: string or (submodule)

Proxy password

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.proxyPort Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Proxy port

Default: 8080

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.proxyType Link copied!

Type: one of "http", "socks4", "socks5"

Proxy type

Default: "http"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.proxyUsername Link copied!

Type: string or (submodule)

Proxy username

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.sslCertPassword Link copied!

Type: string or (submodule)

SSL certificate password

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.sslCertPath Link copied!

Type: string

SSL certificate path

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.sslPort Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

SSL port

Default: 9898

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.trustCgnatIpAddresses Link copied!

Type: boolean

Trust CGNAT IP addresses

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.updateAutomatically Link copied!

Type: boolean

Update automatically

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.updateMechanism Link copied!

Type: one of "builtIn", "script", "external", "docker"

Update mechanism

Default: "builtIn"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.updateScriptPath Link copied!

Type: string

Update script path

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.urlBase Link copied!

Type: string

URL base path

Default: ""

Example: "/takeMeThere"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.hostConfig.username Link copied!

Type: null or string or (submodule)

Username for web interface authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.autoUnmonitorPreviouslyDownloadedEpisodes Link copied!

Type: boolean

Automatically unmonitor episodes after they have been downloaded.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.chmodFolder Link copied!

Type: string

Octal permissions to apply to media folders.

Default: "755"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.chownGroup Link copied!

Type: string

Group name or gid to apply to media folders.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.copyUsingHardlinks Link copied!

Type: boolean

Use hardlinks instead of copying when importing from torrents still being seeded.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.createEmptySeriesFolders Link copied!

Type: boolean

Create missing series folders during disk scan.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.deleteEmptyFolders Link copied!

Type: boolean

Delete empty folders during disk scan and when media files are deleted.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.downloadPropersAndRepacks Link copied!

Type: one of "preferAndUpgrade", "doNotUpgrade", "doNotPrefer"

How to handle proper and repack releases.

Default: "preferAndUpgrade"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.enableMediaInfo Link copied!

Type: boolean

Scan video files for media info such as resolution, runtime, and codec.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.episodeTitleRequired Link copied!

Type: one of "always", "bulkSeasonReleases", "never"

Prevent importing for a limited time if the episode title is TBA.

Default: "always"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.extraFileExtensions Link copied!

Type: string

Comma-separated list of extra file extensions to import.

Default: "srt"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.fileDate Link copied!

Type: one of "none", "localAirDate", "utcAirDate"

Set the file date on imported media files.

Default: "none"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.importExtraFiles Link copied!

Type: boolean

Import matching extra files alongside media files.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.minimumFreeSpaceWhenImporting Link copied!

Type: signed integer

Minimum free space in MB to leave on the disk when importing.

Default: 100

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.recycleBin Link copied!

Type: string

Path to the recycle bin directory.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.recycleBinCleanupDays Link copied!

Type: signed integer

Number of days before items in the recycle bin are permanently deleted.

Default: 7

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.rescanAfterRefresh Link copied!

Type: one of "always", "afterManual", "never"

When to rescan the media folder after refreshing media information.

Default: "always"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.scriptImportPath Link copied!

Type: string

Path to the custom import script.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.setPermissionsLinux Link copied!

Type: boolean

Set chmod and chown on imported files and media folders.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.skipFreeSpaceCheckWhenImporting Link copied!

Type: boolean

Skip the free space check when importing media files.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.mediaManagement.useScriptImport Link copied!

Type: boolean

Use a custom script for importing instead of the built-in import.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.config.rootFolders Link copied!

Type: list of (attribute set)

List of root folders to create via the API /rootfolder endpoint. Each folder is an attribute set that will be converted to JSON and sent to the API.

For Sonarr/Radarr, a simple path is sufficient: {path = "/path/to/folder";}

For Lidarr, additional fields are required like defaultQualityProfileId, etc.

Default: map (mediaDir: {path = mediaDir;}) nixflix.sonarr.mediaDirs

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.connectionAddress Link copied!

read-only

Type: string

Address for connecting to this service.

Default: "127.0.0.1"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.dataDir Link copied!

Type: absolute path

Directory containing Seerr data and configuration

Default: "${config.nixflix.stateDir}/${serviceName}"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.enable Link copied!

Type: boolean

Whether to enable Sonarr.

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.group Link copied!

Type: string

Group under which the service runs

Default: "sonarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.mediaDirs Link copied!

Type: list of absolute path

List of media directories to create and manage

Default: [config.nixflix.mediaDir + "/<media-type>"]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.openFirewall Link copied!

Type: boolean

Open ports in the firewall for the Radarr web interface.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.package Link copied!

Type: package

The sonarr package to use.

Default: pkgs.sonarr

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.reverseProxy.expose Link copied!

Type: boolean

Whether to expose this service via the reverse proxy.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.settings Link copied!

Type: open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Attribute set of arbitrary config options. Please consult the documentation at the wiki.

!!! warning

This configuration is stored in the world-readable Nix store!
Don't put secrets here!

Default:

{
  auth = {
    required = "Enabled";
    method = "Forms";
  };
  server = {
    inherit (config.nixflix.sonarr.config.hostConfig) port urlBase;
  };
} // optionalAttrs config.nixflix.postgres.enable {
  log.dbEnabled = true;
  postgres = {
    user = config.nixflix.sonarr.user;
    host = "/run/postgresql";
    port = config.services.postgresql.settings.port;
    mainDb = config.nixflix.sonarr.user;
    logDb = "${config.nixflix.sonarr.user}-logs";
  };
}

Example:

{
  update.mechanism = "internal";
  server = {
    urlbase = "localhost";
    port = 8989;
    bindaddress = "*";
  };
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.settings.app.instanceName Link copied!

Type: string

Name of the instance

Default: "Sonarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.settings.log.analyticsEnabled Link copied!

Type: boolean

Send Anonymous Usage Data

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.settings.server.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port Number

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.settings.update.automatically Link copied!

Type: boolean

Automatically download and install updates.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.settings.update.mechanism Link copied!

Type: null or one of "external", "builtIn", "script"

which update mechanism to use

Default: "external"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.subdomain Link copied!

Type: string

Subdomain prefix for reverse proxy. Service accessible at <subdomain>.<domain>.

Default: "sonarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.user Link copied!

Type: string

User under which the service runs

Default: "sonarr"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.sonarr.vpn.enable Link copied!

Type: boolean

Whether to route Sonarr traffic through the VPN.

When false (default), Sonarr bypasses the VPN to prevent Cloudflare and image provider blocks. When true, Sonarr routes through the VPN (requires nixflix.vpn.enable = true).

TRaSH Guides recommend leaving this false.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/sonarr.nix

nixflix.stateDir Link copied!

Type: absolute path

The location of the state directory for the services.

!!! warning

All parent directories must have execute permissions for everyone.

!!! warning

Setting this to any path, where the subpath is not owned by root, will fail! For example:

```nix
mediaDir = /home/user/data
```

Is not supported, because `/home/user` is owned by `user`.

Default: "/var/lib"

Example: "/data/.state"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.theme.enable Link copied!

Type: boolean

Enables themeing via theme.park. Requires a reverse proxy (nixflix.nginx.enable or nixflix.caddy.enable) for all services except Jellyfin.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.theme.name Link copied!

Type: string

The name of any official theme or community theme supported by theme.park.

Default: "overseerr"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/media/nixflix/default.nix

nixflix.torrentClients.qbittorrent Link copied!

Type: open submodule of attribute set of anything

This option has no description.

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.categories Link copied!

Type: attribute set of string

Map of category names to their save paths (relative or absolute).

Default:

{
  radarr = lib.optionalString (config.nixflix.radarr.enable or false) "/data/downloads/torrent/radarr";
  sonarr = lib.optionalString (config.nixflix.radarr.enable or false) "/data/downloads/torrent/sonarr";
  sonarr-anime = lib.optionalString (config.nixflix.radarr.enable or false) "/data/downloads/torrent/sonarr-anime";
  lidarr = lib.optionalString (config.nixflix.radarr.enable or false) "/data/downloads/torrent/lidarr";
  prowlarr = lib.optionalString (config.nixflix.radarr.enable or false) "/data/downloads/torrent/prowlarr";
}

Example:

{
  prowlarr = "games";
  sonarr = "/mnt/share/movies";
}

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.connectionAddress Link copied!

read-only

Type: string

Address for connecting to this service.

Default: "127.0.0.1"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.downloadsDir Link copied!

Type: string

Base directory for qBittorrent downloads

Default: "$${config.nixflix.downloadsDir}/torrent"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.enable Link copied!

Type: boolean

Whether to enable qBittorrent usenet downloader.

Uses all of the same options as nixpkgs qBittorent.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.group Link copied!

Type: string

Group under which qbittorrent runs.

Default: "media"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.password Link copied!

Type: null or string or (submodule)

The password for qbittorrent. This is for the other services to integrate with qBittorrent. Not for setting the password in qBittorrent

In order to set the password for qBittorrent itself, you will need to configure nixflix.torrentClients.qbittorrent.serverConfig.Preferences.WebUI.Password_PBKDF2. Look at the serverConfig documentation to see how to configure it.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.reverseProxy.expose Link copied!

Type: boolean

Whether to expose qBittorrent via the reverse proxy.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.serverConfig.BitTorrent.Session.DefaultSavePath Link copied!

Type: string

Default save path for downloads without a category.

Default: "${config.nixflix.torrentClients.qbittorrent.downloadsDir}/default"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.serverConfig.BitTorrent.Session.DisableAutoTMMByDefault Link copied!

Type: boolean

Default Torrent Management Mode. Set to false to enable category save paths.

true = Manual, false = Automatic

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.serverConfig.Preferences.WebUI.Address Link copied!

Type: string

Bind address for the WebUI

Default: "*"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/torrentClients/qbittorrent.nix

Type: boolean

Whether to enable SABnzbd usenet downloader

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.group Link copied!

Type: string

Group under which the service runs

Default: config.nixflix.globals.libraryOwner.group

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.openFirewall Link copied!

Type: boolean

Open ports in the firewall for the SABnzbd web interface.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.package Link copied!

Type: package

The sabnzbd package to use.

Default: pkgs.sabnzbd

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.reverseProxy.expose Link copied!

Type: boolean

Whether to expose SABnzbd via the reverse proxy.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings Link copied!

Type: open submodule of anything

SABnzbd settings

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.categories Link copied!

Type: list of (open submodule of anything)

Download categories. By default, categories are automatically created based on enabled services, using the service name as the category name (radarr, sonarr, sonarr-anime, lidarr, prowlarr).

A catch-all "*" category is always included.

Default:

lib.optional (config.nixflix.radarr.enable or false) {
  name = "radarr"; dir = "radarr"; priority = 0; pp = 3; script = "None";
}
++ lib.optional (config.nixflix.sonarr.enable or false) {
  name = "sonarr"; dir = "sonarr"; priority = 0; pp = 3; script = "None";
}
++ lib.optional (config.nixflix.sonarr-anime.enable or false) {
  name = "sonarr-anime"; dir = "sonarr-anime"; priority = 0; pp = 3; script = "None";
}
++ lib.optional (config.nixflix.lidarr.enable or false) {
  name = "lidarr"; dir = "lidarr"; priority = 0; pp = 3; script = "None";
}
++ lib.optional (config.nixflix.prowlarr.enable or false) {
  name = "prowlarr"; dir = "prowlarr"; priority = 0; pp = 3; script = "None";
}
++ [
  { name = "*"; priority = 0; pp = 3; script = "None"; }
]

Example:

[
  {
    name = "radarr";
    dir = "radarr";
    priority = 0;
    pp = 3;
    script = "None";
  }
  {
    name = "sonarr";
    dir = "sonarr";
    priority = 0;
    pp = 3;
    script = "None";
  }
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.categories.*.dir Link copied!

Type: string

Directory name for this category

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.categories.*.name Link copied!

Type: string

Category name

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.categories.*.pp Link copied!

Type:

(one of "", 0, 1, 2, 3) or (one of "Default", "Download", "Repair", "Repair+Unpack", "Repair+Unpack+Delete") convertible to it

Post-processing level

Default: 3

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.categories.*.priority Link copied!

Type: signed integer

Category priority

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.categories.*.script Link copied!

Type: string

Post-processing script

Default: "None"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc Link copied!

Type: open submodule of anything

SABnzbd [misc] section settings

Default: { }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.action_on_unwanted_extensions Link copied!

Type: signed integer

Action on unwanted extensions (0=None, 1=Abort, 2=Delete)

Default: 1

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.admin_dir Link copied!

Type: string

Admin directory

Default: config.nixflix.usenetClients.sabnzbd.downloadsDir + "/admin"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.allow_incomplete_nzb Link copied!

Type: boolean

Sometimes you get an incomplete NZB file (partial content, incorrect syntax etc.) You can enable this option to allow SABnzbd to salvage as much as possible from the NZB. The job will enter the queue in paused mode.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.anon_redirect Link copied!

Type: boolean

Anonymous redirect

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.api_key Link copied!

Type: string or (submodule)

API key for SABnzbd. Can be created with the following:

openssl rand -hex 16

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.article_tries Link copied!

Type: signed integer

Number of attempts per article

Default: 3

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.auto_sort Link copied!

Type: string

Automatically sort queue

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.bandwidth_max Link copied!

Type: string

Maximum bandwidth in bytes/sec (supports prefixes). Use in conjunction with bandwidth_perc.

Default: ""

Example: "50MB/s"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.bandwidth_perc Link copied!

Type: signed integer

Percentage of bandwidth_max that SABnzbd is allowed to use. 0 means no limit.

Default: 0

Example: 50

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.cache_limit Link copied!

Type: string

Size of the RAM cache, in bytes (prefixes supported). SABnzbd recommends 25% of available RAM.

Default: "512M"

Example: "500M"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.check_new_rel Link copied!

Type: boolean

Check for new releases

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.complete_dir Link copied!

Type: string

Complete downloads directory

Default: config.nixflix.usenetClients.sabnzbd.downloadsDir + "/complete"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.connection_limit Link copied!

Type: signed integer

Maximum number of connections

Default: 100

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.deobfuscate_final_filenames Link copied!

Type: boolean

Deobfuscate final filenames

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.direct_unpack Link copied!

Type: boolean

Unpack during download

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.dirscan_dir Link copied!

Type: string

Directory to watch for NZB files

Default: config.nixflix.usenetClients.sabnzbd.downloadsDir + "/watch"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.dirscan_speed Link copied!

Type: signed integer

Directory scan speed in seconds

Default: 5

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.disable_api_key Link copied!

Type: boolean

Disable API key requirement

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.download_dir Link copied!

Type: string

Incomplete downloads directory

Default: config.nixflix.usenetClients.sabnzbd.downloadsDir + "/incomplete"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_account Link copied!

Type: string

Username for SMTP authentication.

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_endjob Link copied!

Type: (one of 1, 0, 2) or (one of "always", "never", "on error") convertible to it

Whether to send emails on job completion.

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_from Link copied!

Type: string

'From:' field for emails (needs to be an address).

Default: ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_full Link copied!

Type: boolean

Whether to send alerts for full disks.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_pwd Link copied!

Type: string or (submodule)

Password for SMTP authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Address for the Web UI to listen on for incoming connections.

Default:

if config.nixflix.vpn.enable && config.nixflix.usenetClients.sabnzbd.vpn.enable
then config.vpnNamespaces.wg.namespaceAddress
else if config.nixflix.reverseProxy.enable then "127.0.0.1"
else "0.0.0.0"

Example: "0.0.0.0"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.host_whitelist Link copied!

Type: string

Hostname verification whitelist. SABnzbd refuses connections from hostnames not in this list. Automatically includes the service hostname when a reverse proxy is enabled.

Default: if config.nixflix.reverseProxy.enable then "${cfg.subdomain}.${config.nixflix.reverseProxy.domain}" else ""

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.html_login Link copied!

Type: boolean

HTML based login form, uncheck for basic authentication. Both offer similar security but password managers might not be able to fill basic authentication automatically.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.https_cert Link copied!

Type: string

Path to the TLS certificate for the web UI. If not set and HTTPS is enabled, a self-signed certificate is generated.

Default: ""

Example: config.security.acme.certs."example.com".directory + "/fullchain.pem"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.https_key Link copied!

Type: string

Path to the TLS key for the web UI. If not set and HTTPS is enabled, a self-signed key is generated.

Default: ""

Example: config.security.acme.certs."example.com".directory + "/key.pem"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.https_port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

HTTPS port for the Web UI (0 to disable HTTPS).

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.ignore_samples Link copied!

Type: boolean

Ignore sample files

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.ignore_unrar_errors Link copied!

Type: boolean

Ignore unrar errors

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.inet_exposure Link copied!

Type:

(one of 1, 3, 2, 4, 5, 0) or (one of "api (add nzbs)", "api (full)", "api (no config)", "api+web (auth needed)", "api+web (locally no auth)", "none") convertible to it

Controls access restrictions from non-local IP addresses. Defaults to api+web (auth needed) when a reverse proxy is enabled, because nginx forwards the real client IP via X-Forwarded-For and SABnzbd only considers RFC 1918 ranges local — clients on Tailscale (100.64.0.0/10) or similar networks would otherwise be refused.

Default: if config.nixflix.reverseProxy.enable then 4 else 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.keep_awake Link copied!

Type: boolean

Disable to stop SABnzbd's attempts to keep the system awake while the queue isn't empty.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.language Link copied!

Type: string

Interface language.

Default: "en"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.log_dir Link copied!

Type: string

Log directory

Default: config.nixflix.usenetClients.sabnzbd.downloadsDir + "/logs"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.log_level Link copied!

Type: signed integer

Log level (0=None, 1=Info, 2=Debug)

Default: 1

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.max_log_size Link copied!

Type: string

Maximum log file size

Default: "10M"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.max_queue_size Link copied!

Type: signed integer

Maximum queue size

Default: 3000

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.no_smart_dupes Link copied!

Type: signed integer

Smart duplicate detection

Default: 4

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.nomedia Link copied!

Type: boolean

Create .nomedia files

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.nzb_backup_dir Link copied!

Type: string

NZB backup directory

Default: config.nixflix.usenetClients.sabnzbd.downloadsDir + "/nzb-backup"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.nzb_key Link copied!

Type: string or (submodule)

NZB key for adding downloads via URL.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.pause_on_failure Link copied!

Type: boolean

Pause queue on download failure

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.pause_on_post_processing Link copied!

Type: boolean

Pause download during post-processing

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.pause_on_pwrar Link copied!

Type: signed integer

Action when encrypted RAR is downloaded

Default: 1

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.permissions Link copied!

Type: string

File permissions for downloaded files

Default: "775"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

nixflix.usenetClients.sabnzbd.settings.servers.*.connections Link copied!

Type: signed integer

Number of parallel connections permitted by the server.

Default: 10

Example: 50

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.servers.*.displayname Link copied!

Type: string

Type: string or (submodule)

Password for server authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.servers.*.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port of the server.

Default: 563

Example: 443

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.servers.*.priority Link copied!

Type: signed integer

Priority of this server. Servers are queried in order of priority, from highest (0) to lowest (100).

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.servers.*.required Link copied!

Type: boolean

In case of connection failures, wait for the server to come back online instead of skipping it.

Default: false

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.servers.*.retention Link copied!

Type: signed integer

Server retention in days (0 = unknown).

Default: 0

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.servers.*.ssl Link copied!

Type: boolean

Whether the server supports TLS.

Default: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.servers.*.ssl_verify Link copied!

Type: (one of 2, 0, 3) or (one of "allow injection", "none", "strict") convertible to it

Certificate verification level.

Default: 2

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.servers.*.timeout Link copied!

Type: signed integer

Time, in seconds, to wait for a response before attempting error recovery.

Default: 60

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.servers.*.username Link copied!

Type: string or (submodule)

Username for server authentication.

!!! warning Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use `{ _secret = path; }` for sensitive data.

Default: null

Example: { _secret = "/run/secrets/secret-file"; }

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.subdomain Link copied!

Type: string

Subdomain prefix for reverse proxy.

Default: "sabnzbd"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.user Link copied!

Type: string

User under which the service runs

Default: "sabnzbd"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.vpn.enable Link copied!

Type: boolean

Whether to route SABnzbd traffic through the VPN.

When false, SABnzbd bypasses the VPN. When true, SABnzbd is confined to the WireGuard network namespace (requires nixflix.vpn.enable = true).

Default: config.nixflix.vpn.enable

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/usenetClients/sabnzbd

nixflix.vpn.accessibleFrom Link copied!

Type: list of string

List of subnets or addresses in the default network namespace that should be able to reach services confined in the VPN namespace.

Required to access VPN-confined services (e.g. Radarr, Sonarr) from your local network. Example: ["192.168.1.0/24"].

Default:

[
  "192.168.1.0/24"
]

Example:

[
  "192.168.1.0/24"
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/vpn.nix

nixflix.vpn.enable Link copied!

Type: boolean

Whether to enable WireGuard VPN.

Default: false

Example: true

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/vpn.nix

nixflix.vpn.openVPNPorts Link copied!

Type: list of (submodule)

Ports to open through the VPN interface, e.g. for port forwarding provided by the VPN provider (AirVPN, IVPN, etc.).

Default: [ ]

Example:

[
  {
    port = 60729;
    protocol = "both";
  }
]

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/vpn.nix

nixflix.vpn.openVPNPorts.*.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port number to open through the VPN interface.

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/vpn.nix

nixflix.vpn.openVPNPorts.*.protocol Link copied!

Type: one of "tcp", "udp", "both"

Protocol for the port.

Default: "tcp"

Declared in: /nix/store/k2v8axq3ywxv6i82nvmm97qdf0c5pw7w-source/modules/vpn.nix

nixflix.vpn.wgConfFile Link copied!

Type: absolute path

Path to a wg-quick compatible WireGuard configuration file.

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.accounts.<name>.passwordFile Link copied!

Type: string

Runtime file path to a file containing the user password. Must be readable by the copyparty user.

Example: "/run/keys/copyparty/ed"

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.enable Link copied!

Type: boolean

Whether to enable web-based file manager.

Default: false

Example: true

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.globalExtraConfig Link copied!

Type: string

Appended to the end of the [global] section verbatim. This is useful for flags which are used in a repeating manner (e.g. ipu: 255.255.255.1=user) which can't be repeated in the settings = {} attribute set.

Default: ""

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.group Link copied!

Type: string

The group that copyparty will run under.

If changed from default, you are responsible for making sure the user exists.

Default: "copyparty"

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.groups Link copied!

Type: attribute set of list of string

A set of copyparty groups to create and the users that should be part of each group.

Default: { }

Example:

{
  group_name = [ "user1" "user2" ];
};

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.mkHashWrapper Link copied!

Type: boolean

Make a shell script wrapper called copyparty-hash with all options set here, that launches the hashing cli.

Default: true

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.openFilesLimit Link copied!

Type: signed integer or string

Number of files to allow copyparty to open.

Default: 4096

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.package Link copied!

Type: package

The copyparty package to use. Package of the application to run, exposed for overriding purposes.

Default: pkgs.copyparty

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.settings Link copied!

Type: attribute set

Global settings to apply. Directly maps to values in the [global] section of the copyparty config. Cannot set "c" or "hist", those are set by this module. See copyparty --help for more details.

Default:

{
  hist = "/var/cache/copyparty";
  i = "127.0.0.1";
  no-reload = true;
}

Example:

{
  i = "0.0.0.0";
  no-reload = true;
  hist = /var/cache/copyparty;
}

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.user Link copied!

Type: string

The user that copyparty will run under.

If changed from default, you are responsible for making sure the user exists.

Default: "copyparty"

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.volumes Link copied!

Type: attribute set of (submodule)

A set of copyparty volumes to create

Default:

{
  "/" = {
    access = {
      r = "*";
    };
    path = "/var/lib/copyparty/data";
  };
}

Example:

{
  "/" = {
    path = /var/lib/copyparty/data;
    access = {
      # wG = write-upget = see your own uploads only
      wG = "*";
      # read-write-modify-delete for users "ed" and "k"
      rwmd = ["ed" "k"];
    };
  };
};

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.volumes.<name>.access Link copied!

Type: attribute set

Attribute list of permissions and the users to apply them to.

The key must be a string containing any combination of allowed permission:

"r" (read): list folder contents, download files
"w" (write): upload files; need "r" to see the uploads
"m" (move): move files and folders; need "w" at destination
"d" (delete): permanently delete files and folders
"g" (get): download files, but cannot see folder contents
"G" (upget): "get", but can see filekeys of their own uploads
"h" (html): "get", but folders return their index.html
"a" (admin): can see uploader IPs, config-reload

For example: "rwmd"

The value must be one of:

an account name, defined in accounts
a list of account names
"*", which means "any account"

Default: { }

Example:

{
  # wG = write-upget = see your own uploads only
  wG = "*";
  # read-write-modify-delete for users "ed" and "k"
  rwmd = ["ed" "k"];
};

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.volumes.<name>.flags Link copied!

Type: attribute set

Attribute list of volume flags to apply. See copyparty --help-flags for more details.

Default: { }

Example:

{
  # "fk" enables filekeys (necessary for upget permission) (4 chars long)
  fk = 4;
  # scan for new files every 60sec
  scan = 60;
  # volflag "e2d" enables the uploads database
  e2d = true;
  # "d2t" disables multimedia parsers (in case the uploads are malicious)
  d2t = true;
  # skips hashing file contents if path matches *.iso
  nohash = "\.iso$";
};

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.copyparty.volumes.<name>.path Link copied!

Type: absolute path

Path of a directory to share.

Declared in: /nix/store/xffxbzlbgaglf21kjswbcaarlp72xvfh-source/contrib/nixos/modules/copyparty.nix

services.minecraft-servers.dataDir Link copied!

Type: absolute path

Directory to store the Minecraft servers. Each server will be under a subdirectory named after the server name in this directory, such as <literal>/srv/minecraft/servername</literal>.

Default: "/srv/minecraft"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.enable Link copied!

Type: boolean

If enabled, the servers in <option>services.minecraft-servers.servers</option> will be created and started as applicable. The data for the servers will be loaded from and saved to <option>services.minecraft-servers.dataDir</option>

Default: false

Example: true

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.environmentFile Link copied!

Type: null or absolute path

File consisting of lines in the form varname=value to define environment variables for the minecraft servers.

Secrets (database passwords, secret keys, etc.) can be provided to server files without adding them to the Nix store by defining them in the environment file and referring to them in option <option>services.minecraft-servers.servers.<name>.files</option> with the syntax @varname@.

Default: null

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.eula Link copied!

Type: boolean

Whether you agree to <link xlink:href="https://account.mojang.com/documents/minecraft_eula"> Mojang's EULA</link>. This option must be set to <literal>true</literal> to run Minecraft server.

Default: false

Example: true

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.group Link copied!

Type: string

Name of the group to create and run servers under. In order to modify the server files your user must be a part of this group. If you are using the tmux management system (the default), you also need to be a part of this group to attach to the tmux socket. It is recommended to leave this as the default, as it is the same group as <option>services.minecraft-server</option>.

Default: "minecraft"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.managementSystem Link copied!

Type: submodule

The default management system for all servers.

Default:

{
  tmux = {
    enable = true;
  };
}

Example:

''
  {
    tmux.enable = false;
    systemd-socket.enable = true;
  }
''

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.managementSystem.systemd-socket.enable Link copied!

Type: boolean

management through the systemd journal & a command socket

Default: false

Example: true

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.managementSystem.systemd-socket.stdinSocket.mode Link copied!

Type: string matching the pattern [0-7]{4}

Access mode of the socket file in octal notation

Default: "0660"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.managementSystem.systemd-socket.stdinSocket.path Link copied!

Type: function that evaluates to a(n) absolute path

Function from a server name to the path at which the server's stdin socket is placed. You can send the server commands by writing to this socket, for example with shell redirection: echo 'list' > <path to socket>.

Note that while currently the default respects <option>services.minecraft-servers.runDir</option>, that option is deprecated and will be removed. The default will then change to name: "/run/minecraft/${name}.stdin.

Default: name: "${cfg.runDir}/${name}.stdin"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.managementSystem.tmux.enable Link copied!

Type: boolean

Whether to enable management via a TMUX socket.

Default: false

Example: true

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.managementSystem.tmux.socketPath Link copied!

Type: function that evaluates to a(n) absolute path

Function from a server name to the path at which the server's tmux socket is placed. To connect to the console, run tmux -S <path to socket> attach, press Ctrl + b then d to detach.

Note that while currently the default respects <option>services.minecraft-servers.runDir</option>, that option is deprecated and will be removed. The default will then change to name: "/run/minecraft/${name}.sock.

Default: name: "${cfg.runDir}/${name}.sock"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.openFirewall Link copied!

Type: boolean

Whether to open ports in the firewall for each server. Sets the default for <option>services.minecraft-servers.servers.<name>.openFirewall</option>.

Default: false

Example: true

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.runDir Link copied!

Type: absolute path

Deprecated: Directory to place the runtime tmux sockets into. Each server's console will be a tmux socket file in the form of <literal>servername.sock</literal>. To connect to the console, run tmux -S /run/minecraft/servername.sock attach, press Ctrl + b then d to detach.

Plase use <option>services.minecraft-servers.managementSystem.tmux.socketPath</option>` instead.

Default: "/run/minecraft"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers Link copied!

Type: attribute set of (submodule)

Servers to create and manage using this module. Each server can be stopped with <literal>systemctl stop minecraft-server-servername</literal>.

Warning

If the server is not stopped using systemctl, the service will automatically restart the server. See <option>services.minecraft-servers.servers.<name>.restart</option>.

Default: { }

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.allowedSymlinks Link copied!

Type: list of string

Minecraft 1.20+ disallows symlinks inside world directories, unless its destinations are allow-listed. /nix/store is allowed by default, but you may add more destinations through this option. See <link xlink:href="https://help.minecraft.net/hc/en-us/articles/16165590199181"/> for more information.

Use lib.mkForce to shadow the default value (i.e. if you want to exclude /nix/store).

Default: [ ]

Example:

[
  "/mnt/worlds"
]

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.autoStart Link copied!

Type: boolean

Whether to start this server on boot. If set to <literal>false</literal>, can still be started with <literal>systemctl start minecraft-server-servername</literal>. Requires the server to be enabled.

Default: true

Example: true

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.bannedPlayers Link copied!

Type: attribute set of ((submodule) or Minecraft UUID convertible to it)

Banned players. See <link xlink:href="https://docs.papermc.io/paper/reference/vanilla-data-files/"/>.

To use a non-declarative banned player list, don't fill in this value. As long as it is empty, no banned players file is generated.

Default: { }

Example:

{
  username1 = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
  username2 = {
    uuid = "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy";
    created = "2025-12-01 09:00:00 -0500";
    source = "(Unknown)";
    expires = "forever";
    reason = "Banned by an operator.";
  };
}

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.bannedPlayers.<name>.created Link copied!

Type: null or string

The date of the ban

Default: null

Example: "2025-12-01 09:00:00 -0500"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.bannedPlayers.<name>.expires Link copied!

Type: null or string

When the ban expires, if ever

Default: null

Example: "forever"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.bannedPlayers.<name>.reason Link copied!

Type: null or string

The reason for the ban, if any.

Default: null

Example: "Banned by an operator."

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.bannedPlayers.<name>.source Link copied!

Type: null or string

The source of the ban

Default: null

Example: "Server"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.bannedPlayers.<name>.uuid Link copied!

Type: Minecraft UUID

The banned player's UUID

Example: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.enable Link copied!

Type: boolean

Whether to enable this server. If set to <literal>false</literal>, does NOT delete any data in the data directory, just does not generate the service file.

Default: false

Example: true

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.enableReload Link copied!

Type: boolean

services.minecraft-servers.servers.<name>.jvmOpts Link copied!

Type: strings concatenated with " " or (list of string) convertible to it

JVM options for this server.

Default: "-Xmx2G -Xms1G"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.managementSystem Link copied!

Type: submodule

Configuration for the system used to manage this server. Overrides the global configuration on an option-by-option basis.

Default: { }

Example:

''
  {
    tmux.enable = false;
    systemd-socket.enable = true;
  }
''

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.managementSystem.systemd-socket.enable Link copied!

Type: boolean

management through the systemd journal & a command socket

Default: false

Example: true

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.managementSystem.systemd-socket.stdinSocket.mode Link copied!

Type: string matching the pattern [0-7]{4}

Access mode of the socket file in octal notation

Default: "0660"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.managementSystem.systemd-socket.stdinSocket.path Link copied!

Type: function that evaluates to a(n) absolute path

Function from a server name to the path at which the server's stdin socket is placed. You can send the server commands by writing to this socket, for example with shell redirection: echo 'list' > <path to socket>.

Note that while currently the default respects <option>services.minecraft-servers.runDir</option>, that option is deprecated and will be removed. The default will then change to name: "/run/minecraft/${name}.stdin.

Default: name: "${cfg.runDir}/${name}.stdin"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.managementSystem.tmux.enable Link copied!

Type: boolean

Whether to enable management via a TMUX socket.

Default: false

Example: true

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.managementSystem.tmux.socketPath Link copied!

Type: function that evaluates to a(n) absolute path

Function from a server name to the path at which the server's tmux socket is placed. To connect to the console, run tmux -S <path to socket> attach, press Ctrl + b then d to detach.

Note that while currently the default respects <option>services.minecraft-servers.runDir</option>, that option is deprecated and will be removed. The default will then change to name: "/run/minecraft/${name}.sock.

Default: name: "${cfg.runDir}/${name}.sock"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.openFirewall Link copied!

Type: boolean

Whether to open ports in the firewall for this server.

Default: "The value of <literal>services.minecraft-servers.openFirewall</literal>"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.operators Link copied!

Type: attribute set of ((submodule) or Minecraft UUID convertible to it)

Server operators. See <link xlink:href="https://minecraft.wiki/w/Ops.json_format"/>.

To use a non-declarative operator list, don't fill in this value. As long as it is empty, no operators file is generated.

Default: { }

Example:

{
  username1 = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
  username2 = {
    uuid = "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy";
    level = 3;
    bypassesPlayerLimit = true;
  };
}

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.operators.<name>.bypassesPlayerLimit Link copied!

Type: boolean

If true, the operator can join the server even if the player limit has been reached

Default: false

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.operators.<name>.level Link copied!

Type: integer between 0 and 4 (both inclusive)

The operator's permission level

Default: 4

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.operators.<name>.uuid Link copied!

Type: Minecraft UUID

The operator's UUID

Example: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.package Link copied!

Type: package

The Minecraft server package to use.

Default: pkgs.minecraft-server

Example: "pkgs.minecraftServers.vanilla-1_18_2"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.path Link copied!

Type: list of (absolute path or string)

Packages added to the Minecraft server's <literal>PATH</literal> environment variable. Works as <option>systemd.services.<name>.path</option>.

Default: [ ]

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.restart Link copied!

Type: string

Value of systemd's <literal>Restart=</literal> service configuration option. If you are using the tmux management system (the default), values other than <literal>"no"</literal> and <literal>"always"</literal> may not work properly. As a consequence of the <literal>"always"</literal> option, stopping the server in-game with the <literal>stop</literal> command will cause the server to automatically restart.

Default: "always"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.serverProperties Link copied!

Type: attribute set of (boolean or signed integer or string)

Minecraft server properties for the server.properties file of this server. See <link xlink:href="https://minecraft.gamepedia.com/Server.properties#Java_Edition_3"/> for documentation on these values.

To use a non-declarative server.properties, don't fill in this value. As long as it is empty, no server.properties file is generated.

Default: { }

Example:

{
  server-port = 43000;
  difficulty = 3;
  gamemode = 1;
  max-players = 5;
  motd = "NixOS Minecraft server!";
  white-list = true;
  enable-rcon = true;
  "rcon.password" = "hunter2";
}

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.stopCommand Link copied!

Type: null or string

Console command to run when cleanly stopping the server (ExecStop). Defaults to <literal>stop</literal>, which works for most servers. For proxies (bungeecord, velocity), you should set <literal>end</literal>.

If set to <literal>null</literal>, the server will be stopped by systemd without issuing any command.

Default: "stop"

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.symlinks Link copied!

Type: attribute set of (absolute path or (submodule))

Things to symlink into this server's data directory, in the form of a nix package/derivation. Can be used to declaratively manage arbitrary files in the server's data directory.

Default: { }

Declared in: /nix/store/9zagm6asbgmbx8mmxa72gjaqz2v829fi-source/modules/minecraft-servers.nix

services.minecraft-servers.servers.<name>.whitelist Link copied!

Type: attribute set of Minecraft UUID

Whitelisted players, only has an effect when enabled via <option>services.minecraft-servers.<name>.serverProperties</option> by setting <literal>white-list</literal> to <literal>true</literal.

To use a non-declarative whitelist, enable the whitelist and don't fill in this value. As long as it is empty, no whitelist file is generated.

Default: { }

Example:

{
  username1 = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
  username2 = "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy";
}

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/takina.nix

services.takina.enable Link copied!

Type: boolean

Whether to enable Takina Discord bot.

Default: false

Example: true

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/takina.nix

services.takina.environmentFile Link copied!

Type: null or absolute path

Path to a environment file, usually used for passing sensitive environment variables to Takina such as the Discord bot token.

Default: null

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/takina.nix

services.takina.group Link copied!

Type: string

Group under which Takina runs.

Default: "takina"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/takina.nix

services.takina.package Link copied!

Type: package

The Takina package to use.

Default: <derivation takina-1.20.4>

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/takina.nix

services.takina.user Link copied!

Type: string

User account under which Takina runs.

Default: "takina"

Declared in: /nix/store/vyjlak0984lhzlj6zmq140w7l24fs6pw-source/modules/services/misc/takina.nix

sops.age.generateKey Link copied!

Type: boolean

Whether or not to generate the age key. If this option is set to false, the key must already be present at the specified location.

Default: false

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.age.keyFile Link copied!

Type: null or path not in the Nix store

Path to age key file used for sops decryption.

Default: null

Example: "/var/lib/sops-nix/key.txt"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.age.plugins Link copied!

Type: list of package

List of plugins to use for sops decryption.

Default: [ ]

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.age.sshKeyPaths Link copied!

Type: list of absolute path

Paths to ssh keys added as age keys during sops description.

Default: The ed25519 keys from {option}`config.services.openssh.hostKeys`

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.defaultSopsFile Link copied!

Type: absolute path

Default sops file used for all secrets.

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.defaultSopsFormat Link copied!

Type: string

Default sops format used for all secrets.

Default: "yaml"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.defaultSopsKey Link copied!

Type: null or string

Default key used to lookup in all secrets. This option is ignored if format is binary. "" means whole file.

Default: null

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.environment Link copied!

Type: attribute 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.

Default: { }

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.gnupg.home Link copied!

Type: null or string

Path to gnupg database directory containing the key for decrypting the sops file.

Default: null

Example: "/root/.gnupg"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.gnupg.package Link copied!

Type: package

The gnupg package to use for sops operations.

Default: pkgs.gnupg

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.gnupg.sshKeyPaths Link copied!

Type: list of absolute path

Path 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.

Default: The rsa keys from {option}`config.services.openssh.hostKeys`

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.keepGenerations Link copied!

Type: unsigned integer, meaning >=0

Number of secrets generations to keep. Setting this to 0 disables pruning.

Default: 1

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.log Link copied!

Type: list of (one of "keyImport", "secretChanges")

What to log

Default:

[
  "keyImport"
  "secretChanges"
]

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.package Link copied!

Type: package

sops-install-secrets package to use.

Default: (pkgs.callPackage ../.. {}).sops-install-secrets

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets Link copied!

Type: attribute set of (submodule)

Path where the latest secrets are mounted to.

Default: { }

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.format Link copied!

Type: one of "yaml", "json", "binary", "dotenv", "ini"

File format used to decrypt the sops secret. Binary files are written to the target file as is.

Default: "yaml"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.gid Link copied!

Type: null or signed integer

GID of the file, only applied when group is null. The GID will be applied even if the corresponding group doesn't exist.

Default: 0

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.group Link copied!

Type: null or string

Group of the file. Can only be set if gid is 0.

Default: {option}`config.users.users.${owner}.group`

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.key Link copied!

Type: string

Key used to lookup in the sops file. No tested data structures are supported right now. This option is ignored if format is binary. "" means whole file.

Default: "‹name›"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.mode Link copied!

Type: string

Permissions mode of the in octal.

Default: "0400"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.name Link copied!

Type: string

Name of the file used in /run/secrets

Default: "‹name›"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.neededForUsers Link copied!

Type: boolean

Enabling this option causes the secret to be decrypted before users and groups are created. This can be used to retrieve user's passwords from sops-nix. Setting this option moves the secret to /run/secrets-for-users and disallows setting owner and group to anything else than root.

Default: false

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.owner Link copied!

Type: null or string

User of the file. Can only be set if uid is 0.

Default: null

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.path Link copied!

Type: string

Path where secrets are symlinked to. If the default is kept no symlink is created.

Default: "/run/secrets-for-users/$name when neededForUsers is set, /run/secrets/$name when otherwise."

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.reloadUnits Link copied!

Type: list of string

Names of units that should be reloaded when this secret changes. This works the same way as <xref linkend="opt-systemd.services.name.reloadTriggers" />.

Default: [ ]

Example:

[
  "sshd.service"
]

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.restartUnits Link copied!

Type: list of string

Names of units that should be restarted when this secret changes. This works the same way as <xref linkend="opt-systemd.services.name.restartTriggers" />.

Default: [ ]

Example:

[
  "sshd.service"
]

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.sopsFile Link copied!

Type: absolute path

Sops file the secret is loaded from.

Default: ${config.sops.defaultSopsFile}

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.sopsFileHash Link copied!

read-only

Type: string

Hash of the sops file, useful in <xref linkend="opt-systemd.services.name.restartTriggers" />.

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.secrets.<name>.uid Link copied!

Type: null or signed integer

UID of the file, only applied when owner is null. The UID will be applied even if the corresponding user doesn't exist.

Default: 0

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.templates Link copied!

Type: attribute set of (submodule)

Templates for secret files

Default: { }

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops/templates

sops.templates.<name>.content Link copied!

Type: strings concatenated with "\n"

Content of the file

Default: ""

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops/templates

sops.templates.<name>.file Link copied!

Type: absolute path

File used as the template. When this value is specified, sops.templates.<name>.content is ignored.

Default: pkgs.writeText config.name config.content

Example: "./configuration-template.conf"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops/templates

sops.templates.<name>.gid Link copied!

Type: null or signed integer

GID of the template, only applied when group is null. The GID will be applied even if the corresponding group doesn't exist.

Default: 0

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops/templates

sops.templates.<name>.group Link copied!

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

Group of the file. Can only be set if gid is 0.

Default: config.users.users.${cfg.owner}.group

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops/templates

sops.templates.<name>.mode Link copied!

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

Permissions mode of the rendered secret file in octal.

Default: "0400"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops/templates

sops.templates.<name>.name Link copied!

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

Name of the file used in /run/secrets/rendered

Default: "‹name›"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops/templates

sops.templates.<name>.owner Link copied!

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

User of the file. Can only be set if uid is 0;

Default: null

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops/templates

sops.templates.<name>.path Link copied!

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

Path where the rendered file will be placed

Default: "/run/secrets/rendered/‹name›"

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops/templates

sops.templates.<name>.reloadUnits Link copied!

Type: list of string

Names of units that should be reloaded when the rendered template changes. This works the same way as <xref linkend="opt-systemd.services.name.reloadTriggers" />.

Default: [ ]

Example:

[
  "sshd.service"
]

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops/templates

sops.templates.<name>.restartUnits Link copied!

Type: list of string

Names of units that should be restarted when the rendered template changes. This works the same way as <xref linkend="opt-systemd.services.name.restartTriggers" />.

Default: [ ]

Example:

[
  "sshd.service"
]

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops/templates

sops.templates.<name>.uid Link copied!

Type: null or signed integer

UID of the template, only applied with owner is null. the UID will be applied even if the corresponding user doesn't exist.

Default: 0

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops/templates

sops.useSystemdActivation Link copied!

Type: boolean

Use 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.

Default:

(options.systemd ? sysusers && config.systemd.sysusers.enable) || (options.services ? userborn && config.services.userborn.enable)

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.useTmpfs Link copied!

Type: boolean

Use 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;
}];

Default: false

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.validateSopsFiles Link copied!

Type: boolean

Check all sops files at evaluation time. This requires sops files to be added to the nix store.

Default: true

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

sops.validationPackage Link copied!

Type: package

sops-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.

Default: config.sops.package

Declared in: /nix/store/zx4a97llib7qwkcnc5vdjv0sg31zgqhj-source/modules/sops

systemd.services Link copied!

Type: attribute set of (submodule)

This option has no description.

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/systemd.nix

systemd.services.<name>.vpnConfinement.enable Link copied!

Type: boolean

Whether to confine the systemd service in a networking namespace which routes traffic through a VPN tunnel and forces a specified DNS.

Default: false

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/systemd.nix

systemd.services.<name>.vpnConfinement.vpnNamespace Link copied!

Type: string

Name of the VPN networking namespace to use for the systemd service.

Default: null

Example: "wg"

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/systemd.nix

vpnNamespaces Link copied!

Type: attribute set of (submodule)

This option has no description.

Default: { }

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.accessibleFrom Link copied!

Type: list of (valid ipv4 or ipv6 address with optional mask)

Subnets, ranges, and specific addresses that the namespace should be accessible to.

Default: [ ]

Example:

[
  "10.0.2.0/24"
  "192.168.1.27"
  "fd25:9ab6:6133::/64"
  "fd25:9ab6:6133::203"
]

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.bridgeAddress Link copied!

Type: valid ipv4 address with optional mask

The address of the linux bridge on the default namespace.

The linux bridge sits on the default namespace and needs an address to make communication between connected namespaces possible, including the default namespace.

Default: "192.168.15.5"

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.bridgeAddressIPv6 Link copied!

Type: valid ipv6 address with optional mask

The address of the linux bridge on the default namespace.

The linux bridge sits on the default namespace and needs an address to make communication between connected namespaces possible, including the default namespace.

Default: "fd93:9701:1d00::1"

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.enable Link copied!

Type: boolean

Whether to enable the VPN namespace.

To access the networking namespace(netns) a veth pair is created to connect it and the default namespace through a linux bridge. One end of the pair is connected to the linux bridge on the default netns. The other end is connected to the vpn netns.

Default: false

Example: true

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.namespaceAddress Link copied!

Type: valid ipv4 address with optional mask

The address of the veth interface connected to the vpn namespace.

This is the address used to reach the vpn namespace from other namespaces connected to the linux bridge.

Default: "192.168.15.1"

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.namespaceAddressIPv6 Link copied!

Type: valid ipv6 address with optional mask

The address of the veth interface connected to the vpn namespace.

This is the address used to reach the vpn namespace from other namespaces connected to the linux bridge.

Default: "fd93:9701:1d00::2"

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.openVPNPorts Link copied!

Type: list of (submodule)

Ports that should be accessible through the VPN interface.

Default: [ ]

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.openVPNPorts.*.port Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

The port to open.

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.openVPNPorts.*.protocol Link copied!

Type: one of "tcp", "udp", "both"

The transport layer protocol to use.

Default: "tcp"

Example: "both"

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.portMappings Link copied!

Type: list of (submodule)

A list of port mappings from the host to ports in the namespace. Neither the 'to' or 'from' ports should be open on the default netns as they are routed to the VPN netns. The 'to' ports are automatically opened in the VPN netns.

Default: [ ]

Example:

[
  {
    from = 80;
    protocol = "tcp";
    to = 80;
  }
]

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.portMappings.*.from Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port on the default netns.

Example: 80

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.portMappings.*.protocol Link copied!

Type: one of "tcp", "udp", "both"

The transport layer protocol to use.

Default: "tcp"

Example: "both"

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.portMappings.*.to Link copied!

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Port on the VPN netns.

Example: 443

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

vpnNamespaces.<name>.wireguardConfigFile Link copied!

Type: absolute path

Path to a wg-quick config file.

Default: null

Example: "/secret/wg0.conf"

Declared in: /nix/store/sja8ma9gvpzw5081bv19h82ncmzyr3z2-source/modules/vpn-netns.nix

orangc's Flake Documentation Options

aagl.enableNixpkgsReleaseBranchCheck Link copied!

modules.core.boot.enable Link copied!

modules.core.locale Link copied!

modules.core.networking.enable Link copied!

modules.core.users.autoDeclare Link copied!

modules.core.users.home-manager.autoDeclare Link copied!

modules.core.users.home-manager.stateVersion Link copied!

modules.desktop.compositors.hyprland.enable Link copied!

modules.desktop.display-managers.sddm.enable Link copied!

modules.desktop.display-managers.sddm.theme Link copied!

modules.desktop.display-managers.sddm.wallpaper Link copied!

modules.desktop.file-managers.thunar.archive-plugin.enable Link copied!

modules.desktop.file-managers.thunar.enable Link copied!

modules.desktop.fonts.enable Link copied!

modules.gaming.bottles.enable Link copied!

modules.gaming.heroic.enable Link copied!

modules.gaming.hoyoverse.enable Link copied!

modules.gaming.hoyoverse.genshin.enable Link copied!

modules.gaming.hoyoverse.honkai.enable Link copied!

modules.gaming.hoyoverse.zzz.enable Link copied!

modules.gaming.lutris.enable Link copied!

modules.gaming.minecraft.enable Link copied!

modules.gaming.minecraft.labymod.enable Link copied!

modules.gaming.minecraft.modrinth.enable Link copied!

modules.gaming.osu.enable Link copied!

modules.gaming.steam.enable Link copied!

modules.gaming.wine.enable Link copied!

modules.hardware.bluetooth.enable Link copied!

modules.hardware.btrfs.enable Link copied!

modules.hardware.drivers.amd.enable Link copied!

modules.hardware.drivers.intel.enable Link copied!

modules.hardware.drivers.nvidia.enable Link copied!

modules.hardware.printing.enable Link copied!

modules.hardware.sound.enable Link copied!

modules.programs.appimages.enable Link copied!

modules.programs.syncthing.enable Link copied!

modules.programs.syncthing.exampleOption Link copied!

modules.security.restic.enable Link copied!

modules.security.restic.keepLast Link copied!

modules.security.restic.paths Link copied!

modules.security.restic.repository Link copied!

modules.security.sops.enable Link copied!

modules.security.sops.secrets Link copied!

modules.security.sops.secrets.<name>.format Link copied!

modules.security.sops.secrets.<name>.gid Link copied!

modules.security.sops.secrets.<name>.group Link copied!

modules.security.sops.secrets.<name>.key Link copied!

modules.security.sops.secrets.<name>.mode Link copied!

modules.security.sops.secrets.<name>.name Link copied!

modules.security.sops.secrets.<name>.neededForUsers Link copied!

modules.security.sops.secrets.<name>.owner Link copied!

modules.security.sops.secrets.<name>.path Link copied!

modules.security.sops.secrets.<name>.reloadUnits Link copied!

modules.security.sops.secrets.<name>.restartUnits Link copied!

modules.security.sops.secrets.<name>.sopsFile Link copied!

modules.security.sops.secrets.<name>.sopsFileHash Link copied!

modules.security.sops.secrets.<name>.uid Link copied!

modules.security.sudo-rs Link copied!

modules.services.databases.couchdb.enable Link copied!

modules.services.databases.postgresql.databases Link copied!

modules.services.databases.postgresql.enable Link copied!

modules.services.databases.postgresql.port Link copied!

modules.services.databases.postgresql.users Link copied!

modules.services.files.copyparty.autoConfiguredServiceInfra Link copied!

modules.services.files.copyparty.cloudflared.enable Link copied!

modules.services.files.copyparty.enable Link copied!

modules.services.files.copyparty.glance.enable Link copied!

modules.services.files.copyparty.glance.icon Link copied!

modules.services.files.copyparty.internalTailscaleDomain.enable Link copied!

modules.services.files.copyparty.name Link copied!

modules.services.files.copyparty.ntfyChecking.enable Link copied!

modules.services.files.copyparty.port Link copied!

modules.services.files.copyparty.subdomain Link copied!

modules.services.files.cryptpad.autoConfiguredServiceInfra Link copied!

modules.services.files.cryptpad.cloudflared.enable Link copied!

modules.services.files.cryptpad.enable Link copied!

modules.services.files.cryptpad.glance.enable Link copied!

modules.services.files.cryptpad.glance.icon Link copied!

modules.services.files.cryptpad.internalTailscaleDomain.enable Link copied!