Nix Podman Stacks

Appearance

dynacat ​

Highly customizable dashboard with dynamic updates

Example ​

nix
{config, ...}: {
  nps.stacks.dynacat = {
    enable = true;
    settings.pages.home = {
      columns.start = {
        rank = 500;
        size = "small";
        widgets = [
          {
            type = "server-stats";
            servers = [
              {
                type = "local";
                name = "Server";
              }
            ];
          }
          {
            type = "reddit";
            subreddit = "selfhosted";
            collapse-after = 3;
          }
        ];
      };
    };
  };
}

With OIDC ​

nix
{config, ...}: {
  nps.stacks.dynacat = {
    enable = true;
    secretKeyFile = config.sops.secrets."dynacat/secret_key".path;
    oidc = {
      enable = true;
      clientSecretFile = config.sops.secrets."dynacat/authelia_client_secret".path;
    };
  };
}

Stack Options ​

nps.stacks.dynacat.enable ​

Whether to enable dynacat.

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

nps.stacks.dynacat.extraEnv ​

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

See https://dynacat.artur.zone/#configuration/environment-variables

Type
plaintext
attribute set of (null or boolean or signed integer or string or absolute path or (submodule))
Default
nix
{ }
Example
nix
{
  FOO = "bar";
  SOME_SECRET = {
    fromFile = "/run/secrets/secret_name";
  };
}
Declaration
<nps/modules/dynacat>

nps.stacks.dynacat.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/dynacat>

nps.stacks.dynacat.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/dynacat>

nps.stacks.dynacat.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 https://dynacat.artur.zone/#authentication/oidc-authentication

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

nps.stacks.dynacat.oidc.userGroup ​

Users of this group will be able to log in

Type
plaintext
string
Default
nix
"dynacat_user"
Declaration
<nps/modules/dynacat>

nps.stacks.dynacat.secretKeyFile ​

Path to the file containing the secret key used to sign the session cookies. Only required when OIDC is enabled.

Can be generated with podman run --rm panonim/dynacat secret:make.

See https://dynacat.artur.zone/#authentication

Type
plaintext
null or absolute path
Default
nix
null
Declaration
<nps/modules/dynacat>

nps.stacks.dynacat.settings ​

Settings that will be provided as the dynacat.yml configuration file.

See https://dynacat.artur.zone/#configuration

Type
plaintext
open submodule of (YAML 1.1 value)
Default
nix
{ }
Declaration
<nps/modules/dynacat>

nps.stacks.dynacat.settings.pages ​

This option has no description.

Type
plaintext
attribute set of (open submodule of (YAML 1.1 value))
Declaration
<nps/modules/dynacat>

nps.stacks.dynacat.settings.pages.<name>.columns ​

The columns to display on the page

Type
plaintext
attribute set of (open submodule of (YAML 1.1 value))
Declaration
<nps/modules/dynacat>

nps.stacks.dynacat.settings.pages.<name>.columns.<name>.rank ​

The order of the column on the page.

Type
plaintext
signed integer
Default
nix
1000
Declaration
<nps/modules/dynacat>

nps.stacks.dynacat.settings.pages.<name>.columns.<name>.size ​

The size of the column.

Type
plaintext
one of "small", "full"
Declaration
<nps/modules/dynacat>

nps.stacks.dynacat.settings.pages.<name>.dynamic-updates ​

Whether the page should refresh its widgets automatically.

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

nps.stacks.dynacat.settings.pages.<name>.name ​

The name of the page. Default to the attribute name.

Type
plaintext
string
Default
nix
lib.toSentenceCase <pageName>
Declaration
<nps/modules/dynacat>

nps.stacks.dynacat.useSocketProxy ​

Whether to access the Podman socket through the read-only proxy for the dynacat stack. Will be enabled by default if the 'socket-proxy' stack is enabled.

Type
plaintext
boolean
Default
nix
config.nps.stacks.socket-proxy.enable
Declaration
<nps/modules/dynacat>

nps.stacks.dynacat.userCss ​

Type
plaintext
strings concatenated with "\n"
Default
nix
""
Declaration
<nps/modules/dynacat>

Container Extension ​

Dynacat adds the dynacat container options to the existing services.podman.containers.<name> options. Setting the category automatically adds the container to a docker-containers widget on the dashboard.

Metadata that is shared between the dashboards is configured via the dashboard container option, category, name, url as well as the description, icon, id and parent settings are derived from it. Dynacat specific settings can be added via the freeform dynacat attributes, see https://dynacat.artur.zone/#configuration/docker-containers.

To hide a service from the dashboard, set the dashboard.category option to null, or dynacat.category to only hide it on Dynacat.

Example:

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

  # Shared between the dashboards
  nps.stacks.streaming.containers.jellyfin.dashboard = {
    category = "Media";
    name = "Jellyfin";
    description = "Media Server";
    icon = "di:jellyfin";
  };

  # Dynacat only
  nps.stacks.streaming.containers.jellyfin.dynacat.icon = "si:jellyfin";
}

Icons are written in the Dynacat syntax, see the dashboard.icon option for the available prefixes.

services.podman.containers.<name>.dashboard ​

Metadata shared between the dashboards. Settings that only apply to a single dashboard go into its own container option.

Type
plaintext
submodule
Default
nix
{ }
Declaration
<nps/modules/extension.nix>

services.podman.containers.<name>.dashboard.category ​

Category of the service, null hides it.

Type
plaintext
null or string
Default
nix
null
Declaration
<nps/modules/extension.nix>

services.podman.containers.<name>.dashboard.description ​

Short description of the service.

Type
plaintext
null or string
Default
nix
null
Declaration
<nps/modules/extension.nix>

services.podman.containers.<name>.dashboard.icon ​

Icon in Glance syntax, translated for Homepage. di:name becomes name, sh:name becomes sh-name, a bare name is resolved via dashboard-icons.

Type
plaintext
null or string
Default
nix
null
Example
nix
"di:jellyfin"
Declaration
<nps/modules/extension.nix>

services.podman.containers.<name>.dashboard.id ​

Identifier of the service, referenced by the parent of its child containers. Defaults to the container name.

Type
plaintext
null or string
Default
nix
null
Declaration
<nps/modules/extension.nix>

services.podman.containers.<name>.dashboard.name ​

Name of the service on the dashboards.

Type
plaintext
string
Default
nix
lib.toSentenceCase "<container name>"
Declaration
<nps/modules/extension.nix>

services.podman.containers.<name>.dashboard.parent ​

Identifier of the service this container belongs to. Groups it below the parent on the dashboard and keeps it off Homepage, set homepage.category to show it there anyway.

Type
plaintext
null or string
Default
nix
null
Declaration
<nps/modules/extension.nix>

services.podman.containers.<name>.dashboard.url ​

URL the service links to, defaults to the Traefik serviceUrl.

Type
plaintext
null or string
Default
nix
config.traefik.serviceUrl
Declaration
<nps/modules/extension.nix>

services.podman.containers.<name>.dynacat ​

Type
plaintext
open submodule of (YAML 1.1 value)
Default
nix
{ }
Declaration
<nps/modules/dynacat/extension.nix>

services.podman.containers.<name>.dynacat.category ​

Category of the service, null hides it on Dynacat.

Type
plaintext
null or string
Default
nix
null
Declaration
<nps/modules/dynacat/extension.nix>

services.podman.containers.<name>.dynacat.name ​

The name of the service as it will displayed on the dashboard.

Type
plaintext
string
Default
nix
"‹name›"
Declaration
<nps/modules/dynacat/extension.nix>

services.podman.containers.<name>.dynacat.url ​

The URL of the service.

Type
plaintext
string
Default
nix
""
Declaration
<nps/modules/dynacat/extension.nix>

Container Aliases ​

nps.stacks.dynacat.containers.dynacat ​

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

Type
plaintext
submodule
Declaration
<nps/modules/dynacat>