gatus - Nix Podman Stacks

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: boolean

Default: false

Example: true

Declared by:

<nix-podman-stacks/modules/gatus>

nps.stacks.gatus.containers.gatus

Alias of services.podman.containers.gatus.

Type: submodule

Declared by:

<nix-podman-stacks/modules/gatus>

nps.stacks.gatus.containers.gatus-db

Alias of services.podman.containers.gatus-db.

Type: submodule

Declared by:

<nix-podman-stacks/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: absolute path

Declared by:

<nix-podman-stacks/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: one of “sqlite”, “postgres”

Default: "sqlite"

Declared by:

<nix-podman-stacks/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: string

Default: "gatus"

Declared by:

<nix-podman-stacks/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: YAML 1.1 value

Default:

{
  client = {
    insecure = true;
    timeout = "10s";
  };
  conditions = [
    "[STATUS] >= 200"
    "[STATUS] < 300"
  ];
  group = "core";
  interval = "5m";
}

Declared by:

<nix-podman-stacks/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: attribute set of (null or boolean or signed integer or string or absolute path or (submodule))

Default: { }

Example:

{
  FOO = "bar";
  SOME_SECRET = {
    fromFile = "/run/secrets/secret_name";
  };
}

Declared by:

<nix-podman-stacks/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: list of absolute path

Default: [ ]

Declared by: