Nix Podman Stacks

Appearance

streaming ​

Full streaming and automation stack containing:

By default, the following services are enabled:

  • Sonarr
  • Radarr
  • Bazarr

Additionally, the following services can be enabled (disabled by default):

  • Seerr
  • Profilarr
  • Maintainerr

NOTE

The following services are provided by separate stacks:

  • qBittorrent (with Gluetun and qui) — enabled by default via nps.stacks.streaming.useQbittorrent = true
  • Prowlarr — enabled by default via nps.stacks.streaming.useProwlarr = true
  • SABnzbd — disabled by default, enable with nps.stacks.streaming.useSabnzbd = true

Examples ​

Base ​

nix
{
  nps.stacks.streaming = {
    enable = true;
  };
}

Full ​

nix
{config, ...}: {
  nps.stacks.streaming = {
    enable = true;

    jellyfin = {
      oidc = {
        enable = true;
        clientSecretFile = config.sops.secrets."jellyfin/authelia/client_secret".path;
      };
    };

    profilarr.enable = true;
    seerr.enable = true;
    maintainerr.enable = true;
  };
}

Notes ​

By default, Jellyfin writes to /config/cache/transcodes for transcoding. This can cause a high amount of write operations on the underlying disk. To avoid this, you can optionally mount a tmpfs into the container:

nix
{
  nps.stacks.streaming = {
    containers.jellyfin.extraPodmanArgs = [ "--tmpfs=/config/cache/transcodes:size=4G" ];
  };
}

Ram size to be determined on what you have available but 4G seems to be sufficient for most transcodes. Thanks to @Zer0PointModule for the hint.

Stack Options ​

nps.stacks.streaming.bazarr.db.passwordFile ​

The file containing the PostgreSQL password for the database. Only used if db.type is set to "postgres".

Type
plaintext
absolute path
Declaration
<nps/modules/streaming>

nps.stacks.streaming.bazarr.db.type ​

Type of the database to use. Can be set to "sqlite" or "postgres". If set to "postgres", the passwordFile option must be set.

Type
plaintext
one of "sqlite", "postgres"
Default
nix
"sqlite"
Declaration
<nps/modules/streaming>

nps.stacks.streaming.bazarr.db.username ​

The PostgreSQL user to use for the database. Only used if db.type is set to "postgres".

Type
plaintext
string
Default
nix
"bazarr"
Declaration
<nps/modules/streaming>

nps.stacks.streaming.bazarr.enable ​

Whether to enable bazarr.

Type
plaintext
boolean
Default
nix
true
Example
nix
true
Declaration
<nps/modules/streaming>

nps.stacks.streaming.bazarr.extraEnv ​

Extra environment variables to set for the container. Variables can be either set directly or sourced from a file (e.g. for secrets).

Type
plaintext
attribute set of (null or boolean or signed integer or string or absolute path or (submodule))
Default
nix
{ }
Declaration
<nps/modules/streaming>

nps.stacks.streaming.enable ​

Whether to enable streaming.

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration
<nps/modules/streaming>

nps.stacks.streaming.jellyfin.enable ​

Whether to enable Jellyfin.

Type
plaintext
boolean
Default
nix
true
Example
nix
true
Declaration
<nps/modules/streaming>

nps.stacks.streaming.jellyfin.oidc.adminGroup ​

Users of this group will be assigned admin rights in Jellyfin

Type
plaintext
string
Default
nix
"jellyfin_admin"
Declaration
<nps/modules/streaming>

nps.stacks.streaming.jellyfin.oidc.clientSecretFile ​

The file containing the client secret for the OIDC client that will be registered in Authelia.

For examples on how to generate a client secret, see

https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#client-secret

Type
plaintext
absolute path
Example
nix
config.sops.secrets."immich/authelia/client_secret".path"
Declaration
<nps/modules/streaming>

nps.stacks.streaming.jellyfin.oidc.clientSecretHash ​

The client secret hash. For examples on how to generate a client secret, see https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#client-secret

The value can be passed in multiple ways:

  1. As a literal string
  2. As an absolute path to a file containing the hash (toFile)
  3. As an absolute oath to a file containing the client_secret, in which case the hash will be automatically computed (toHash)
  4. As null

If left unset (null), the client secret will be read from the file specified in the clientSecretFile option and hashed automatically before being passed to the Authelia container.

Type
plaintext
null or string or (submodule)
Default
nix
null
Example
nix
# Literal String:
"$pbkdf2-sha512$310000$cbOAIWbfz3vCVXIPIp6d2A$J0klwULa6TvPRCU1HAfuKua/dMKTl8gbTYJz2N73ejGUu0LUGz/y3kwmJLuKuAYGg3WQOT0q9ZzVHHUvpKpgvQ"

# Client secret hash stored in a file
{ fromFile = config.sops.secrets."immich/client_secret_hash".path; }

# Client secret stored in a file: Hash will be computed dynamically
{ toHash = config.sops.secrets."immich/client_secret".path; }

# Null (default): Hash will be computed automatically based on the clientSecretFile option
# Equivalent to { toHash = cfg.oidc.clientSecretFile; }
null
Declaration
<nps/modules/streaming>

nps.stacks.streaming.jellyfin.oidc.enable ​

Whether to enable OIDC login with Authelia. This will register an OIDC client in Authelia and setup the necessary configuration file.

The plugin configuration will be automatically provided, the plugin itself has to be installed in the Jellyfin Web-UI tho.

For details, see:

Type
plaintext
boolean
Default
nix
false
Declaration
<nps/modules/streaming>

nps.stacks.streaming.jellyfin.oidc.userGroup ​

Users of this group will be able to log in

Type
plaintext
string
Default
nix
"jellyfin_user"
Declaration
<nps/modules/streaming>

nps.stacks.streaming.maintainerr.enable ​

Whether to enable Maintainerr.

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration
<nps/modules/streaming>

nps.stacks.streaming.profilarr.enable ​

Whether to enable Profilarr.

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration
<nps/modules/streaming>

nps.stacks.streaming.profilarr.enableParser ​

Whether to enable Profilarr Parser.

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration
<nps/modules/streaming>

nps.stacks.streaming.profilarr.oidc.clientSecretFile ​

The file containing the client secret for the OIDC client that will be registered in Authelia.

For examples on how to generate a client secret, see

https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#client-secret

Type
plaintext
absolute path
Example
nix
config.sops.secrets."immich/authelia/client_secret".path"
Declaration
<nps/modules/streaming>

nps.stacks.streaming.profilarr.oidc.clientSecretHash ​

The client secret hash. For examples on how to generate a client secret, see https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#client-secret

The value can be passed in multiple ways:

  1. As a literal string
  2. As an absolute path to a file containing the hash (toFile)
  3. As an absolute oath to a file containing the client_secret, in which case the hash will be automatically computed (toHash)
  4. As null

If left unset (null), the client secret will be read from the file specified in the clientSecretFile option and hashed automatically before being passed to the Authelia container.

Type
plaintext
null or string or (submodule)
Default
nix
null
Example
nix
# Literal String:
"$pbkdf2-sha512$310000$cbOAIWbfz3vCVXIPIp6d2A$J0klwULa6TvPRCU1HAfuKua/dMKTl8gbTYJz2N73ejGUu0LUGz/y3kwmJLuKuAYGg3WQOT0q9ZzVHHUvpKpgvQ"

# Client secret hash stored in a file
{ fromFile = config.sops.secrets."immich/client_secret_hash".path; }

# Client secret stored in a file: Hash will be computed dynamically
{ toHash = config.sops.secrets."immich/client_secret".path; }

# Null (default): Hash will be computed automatically based on the clientSecretFile option
# Equivalent to { toHash = cfg.oidc.clientSecretFile; }
null
Declaration
<nps/modules/streaming>

nps.stacks.streaming.profilarr.oidc.enable ​

Whether to enable OIDC login with Authelia. This will register an OIDC client in Authelia and setup the necessary configuration.

For details, see:

Type
plaintext
boolean
Default
nix
false
Declaration
<nps/modules/streaming>

nps.stacks.streaming.profilarr.oidc.userGroup ​

Users of this group will be able to log in

Type
plaintext
string
Default
nix
"profilarr_user"
Declaration
<nps/modules/streaming>

nps.stacks.streaming.radarr.db.passwordFile ​

The file containing the PostgreSQL password for the database. Only used if db.type is set to "postgres".

Type
plaintext
absolute path
Declaration
<nps/modules/streaming>

nps.stacks.streaming.radarr.db.type ​

Type of the database to use. Can be set to "sqlite" or "postgres". If set to "postgres", the passwordFile option must be set.

Type
plaintext
one of "sqlite", "postgres"
Default
nix
"sqlite"
Declaration
<nps/modules/streaming>

nps.stacks.streaming.radarr.db.username ​

The PostgreSQL user to use for the database. Only used if db.type is set to "postgres".

Type
plaintext
string
Default
nix
"radarr"
Declaration
<nps/modules/streaming>

nps.stacks.streaming.radarr.enable ​

Whether to enable radarr.

Type
plaintext
boolean
Default
nix
true
Example
nix
true
Declaration
<nps/modules/streaming>

nps.stacks.streaming.radarr.extraEnv ​

Extra environment variables to set for the container. Variables can be either set directly or sourced from a file (e.g. for secrets).

Type
plaintext
attribute set of (null or boolean or signed integer or string or absolute path or (submodule))
Default
nix
{ }
Declaration
<nps/modules/streaming>

nps.stacks.streaming.seerr.enable ​

Whether to enable Seerr.

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration
<nps/modules/streaming>

nps.stacks.streaming.sonarr.db.passwordFile ​

The file containing the PostgreSQL password for the database. Only used if db.type is set to "postgres".

Type
plaintext
absolute path
Declaration
<nps/modules/streaming>

nps.stacks.streaming.sonarr.db.type ​

Type of the database to use. Can be set to "sqlite" or "postgres". If set to "postgres", the passwordFile option must be set.

Type
plaintext
one of "sqlite", "postgres"
Default
nix
"sqlite"
Declaration
<nps/modules/streaming>

nps.stacks.streaming.sonarr.db.username ​

The PostgreSQL user to use for the database. Only used if db.type is set to "postgres".

Type
plaintext
string
Default
nix
"sonarr"
Declaration
<nps/modules/streaming>

nps.stacks.streaming.sonarr.enable ​

Whether to enable sonarr.

Type
plaintext
boolean
Default
nix
true
Example
nix
true
Declaration
<nps/modules/streaming>

nps.stacks.streaming.sonarr.extraEnv ​

Extra environment variables to set for the container. Variables can be either set directly or sourced from a file (e.g. for secrets).

Type
plaintext
attribute set of (null or boolean or signed integer or string or absolute path or (submodule))
Default
nix
{ }
Declaration
<nps/modules/streaming>

nps.stacks.streaming.useProwlarr ​

Whether to enable the Prowlarr stack and connect it to the streaming network. The Prowlarr stack runs standalone and is attached to the streaming network and Traefik.

Type
plaintext
boolean
Default
nix
true
Declaration
<nps/modules/streaming>

nps.stacks.streaming.useQbittorrent ​

Whether to enable the qBittorrent stack and connect it to the streaming network. The qBittorrent stack (Gluetun, qBittorrent and qui) runs standalone and is attached to the streaming network and Traefik.

Type
plaintext
boolean
Default
nix
true
Declaration
<nps/modules/streaming>

nps.stacks.streaming.useSabnzbd ​

Whether to enable the SABnzbd stack and connect it to the streaming network. The SABnzbd stack runs standalone and is attached to the streaming network and Traefik.

Type
plaintext
boolean
Default
nix
false
Declaration
<nps/modules/streaming>

Container Aliases ​

nps.stacks.streaming.containers.bazarr ​

Alias of {option}services.podman.containers.bazarr.

Type
plaintext
submodule
Declaration
<nps/modules/streaming>

nps.stacks.streaming.containers.bazarr-db ​

Alias of {option}services.podman.containers.bazarr-db.

Type
plaintext
submodule
Declaration
<nps/modules/streaming>

nps.stacks.streaming.containers.jellyfin ​

Alias of {option}services.podman.containers.jellyfin.

Type
plaintext
submodule
Declaration
<nps/modules/streaming>

nps.stacks.streaming.containers.maintainerr ​

Alias of {option}services.podman.containers.maintainerr.

Type
plaintext
submodule
Declaration
<nps/modules/streaming>

nps.stacks.streaming.containers.profilarr ​

Alias of {option}services.podman.containers.profilarr.

Type
plaintext
submodule
Declaration
<nps/modules/streaming>

nps.stacks.streaming.containers.profilarr-parser ​

Alias of {option}services.podman.containers.profilarr-parser.

Type
plaintext
submodule
Declaration
<nps/modules/streaming>

nps.stacks.streaming.containers.radarr ​

Alias of {option}services.podman.containers.radarr.

Type
plaintext
submodule
Declaration
<nps/modules/streaming>

nps.stacks.streaming.containers.radarr-db ​

Alias of {option}services.podman.containers.radarr-db.

Type
plaintext
submodule
Declaration
<nps/modules/streaming>

nps.stacks.streaming.containers.seerr ​

Alias of {option}services.podman.containers.seerr.

Type
plaintext
submodule
Declaration
<nps/modules/streaming>

nps.stacks.streaming.containers.sonarr ​

Alias of {option}services.podman.containers.sonarr.

Type
plaintext
submodule
Declaration
<nps/modules/streaming>

nps.stacks.streaming.containers.sonarr-db ​

Alias of {option}services.podman.containers.sonarr-db.

Type
plaintext
submodule
Declaration
<nps/modules/streaming>