Nix Podman Stacks

Appearance

homepage ​

Customizable application dashboard

Example ​

nix
{
  nps.stacks.homepage = {
    enable = true;

    containers.homepage.volumes = [
      "/hostpath/to/image:/app/public/images/background.jpg"
    ];
    settings.background = {
      image = "/images/background.jpg";
      opacity = 50;
    };
    widgets = [
      {
        openweathermap = {
          units = "metric";
          cache = 5;
          apiKey.path = config.sops.secrets."OPENWEATHERMAP_API_KEY".path;
        };
      }
    ];
  };
}

Stack Options ​

nps.stacks.homepage.authSecretFile ​

Path to a file containing the auth secret. Only required if OIDC Is enabled. You can generate a secret using `openssl rand -base64 32.

See https://gethomepage.dev/installation/#security-authentication

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

nps.stacks.homepage.bookmarks ​

Homepage bookmarks configuration.

See https://gethomepage.dev/configs/bookmarks/.

Type
plaintext
YAML 1.1 value
Default
nix
[ ]
Example
nix
[
  {
    Developer = [
      {
        Github = [
          {
            abbr = "GH";
            href = "https://github.com/";
          }
        ];
      }
    ];
  }
  {
    Entertainment = [
      {
        YouTube = [
          {
            abbr = "YT";
            href = "https://youtube.com/";
          }
        ];
      }
    ];
  }
]
Declaration
<nps/modules/homepage>

nps.stacks.homepage.docker ​

Homepage docker configuration.

See https://gethomepage.dev/configs/docker/.

Type
plaintext
YAML 1.1 value
Default
nix
{ }
Declaration
<nps/modules/homepage>

nps.stacks.homepage.enable ​

Whether to enable the Homepage stack.

The services of enabled stacks will be automatically added to Homepage. The module will also automatically configure the docker integration for the local host and setup some widgets.

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

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

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

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

nps.stacks.homepage.oidc.userGroup ​

Users of this group will be able to log in

Type
plaintext
string
Default
nix
"homepage_user"
Declaration
<nps/modules/homepage>

nps.stacks.homepage.services ​

Homepage services configuration.

See https://gethomepage.dev/configs/services/.

Type
plaintext
YAML 1.1 value
Default
nix
{ }
Example
nix
{
  "My First Group" = {
    "My First Service" = {
      description = "Some Service";
      href = "http://localhost/";
    };
  };
  "My Second Group" = {
    "My Second Service" = {
      description = "Some other Service";
      href = "http://localhost/";
    };
  };
}
Declaration
<nps/modules/homepage>

nps.stacks.homepage.settings ​

Type
plaintext
YAML 1.1 value
Default
nix
{ }
Declaration
<nps/modules/homepage>

nps.stacks.homepage.useSocketProxy ​

Whether to access the Podman socket through the read-only proxy for the homepage 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/homepage>

nps.stacks.homepage.widgets ​

Homepage widgets configuration.

See https://gethomepage.dev/widgets/.

Type
plaintext
YAML 1.1 value
Default
nix
[ ]
Example
nix
[
  {
    resources = {
      cpu = true;
      disk = "/";
      memory = true;
    };
  }
  {
    search = {
      provider = "duckduckgo";
      target = "_blank";
    };
  }
]
Declaration
<nps/modules/homepage>

Container Extension ​

Homepage adds the homepage container options to the existing services.podman.containers.<name> options. Setting the category automatically adds the container to the Homepage dashboard under that category.

Metadata that is shared with Glance is configured via the dashboard container option, category and name as well as the href, description and icon settings are derived from it. Homepage specific settings such as the widget configuration are added via the settings attribute, see https://gethomepage.dev/configs/services/.

To hide a service from the dashboard, set the dashboard.category option to null, or homepage.category to only hide it on Homepage. Containers with a dashboard.parent are child services and hidden on Homepage by default, set homepage.category to show them there anyway.

Example:

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

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

  # Homepage only
  nps.stacks.streaming.containers.jellyfin.homepage.settings.widget.enable = true;
}

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>.homepage.category ​

Category of the service, null hides it on Homepage. Containers with a dashboard.parent are hidden by default.

Type
plaintext
null or string
Default
nix
config.dashboard.category
Declaration
<nps/modules/homepage/extension.nix>

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

The name of the service as it will appear on the Homepage dashboard.

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

services.podman.containers.<name>.homepage.settings ​

Settings for the Homepage service. This can include widget configuration, rank and so on.

See https://gethomepage.dev/configs/services/#services/

Type
plaintext
YAML 1.1 value
Default
nix
{ }
Declaration
<nps/modules/homepage/extension.nix>

Container Aliases ​

nps.stacks.homepage.containers.homepage ​

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

Type
plaintext
submodule
Declaration
<nps/modules/homepage>