Nix Podman Stacks
Search K

Appearance

gatus ​

Health dashboard for containers

Example ​

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

    db = {
      type = "postgres";
      passwordFile = config.sops.secrets."gatus/postgresPassword".path;
    };

    settings.endpoints = [
      {
        name = "Some website";
        url = "https://example.com";
        client.dns-resolver = "tcp://1.1.1.1:53";
        conditions = [
          "[STATUS] == 200"
        ];
      }
    ];

    oidc = {
      enable = true;
      clientSecretFile = config.sops.secrets."gatus/authelia_client_secret".path;
      clientSecretHash = "$pbkdf2-sha512$...";
    };
  };
}

Stack Options ​

nps.stacks.gatus.containers.gatus ​

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

Type
plaintext
submodule
Declaration
<nps/modules/gatus>

nps.stacks.gatus.containers.gatus-db ​

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

Type
plaintext
submodule
Declaration
<nps/modules/gatus>

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

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

nps.stacks.gatus.db.username ​

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

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

nps.stacks.gatus.defaultEndpoint ​

Default endpoint settings. Will merged with each provided endpoint. Only applies if endpoint does not override the default endpoint settings.

Type
plaintext
YAML 1.1 value
Default
nix
{
  client = {
    insecure = true;
    timeout = "10s";
  };
  conditions = [
    "[STATUS] >= 200"
    "[STATUS] < 300"
  ];
  group = "core";
  interval = "5m";
}
Declaration
<nps/modules/gatus>

nps.stacks.gatus.enable ​

Whether to enable Gatus. The module also provides an extension that will add Gatus options to a container. This allows services to be added to Gatus by settings container options.

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

nps.stacks.gatus.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://github.com/TwiN/gatus?tab=readme-ov-file#configuration

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/gatus>

nps.stacks.gatus.extraSettingsFiles ​

List of additional YAML files to include in the settings. These files will be mounted as is. Can be used to directly provide YAML files containing secrets, e.g. from sops

Type
plaintext
list of absolute path
Default
nix
[ ]
Declaration
<nps/modules/gatus>

nps.stacks.gatus.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
string
Example
nix
config.sops.secrets."immich/authelia/client_secret".path"
Declaration
<nps/modules/gatus>

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

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

nps.stacks.gatus.oidc.userGroup ​

Users of this group will be able to log in

Type
plaintext
string
Default
nix
"gatus_user"
Declaration
<nps/modules/gatus>

nps.stacks.gatus.settings ​

Settings for the Gatus container. Will be converted to YAML and passed to the container.

See https://github.com/TwiN/gatus

Type
plaintext
YAML 1.1 value
Declaration
<nps/modules/gatus>