gatus

Deploy Gatus (endpoint monitoring and status page) as a Podman quadlet.

Usage

- hosts: all
  roles:
    - role: giftpilz0.container.gatus

Variables

podman_userstr
System user for rootless podman operations.
Default{{ ansible_user }}
gatus_imagestr
Image name without tag.
Defaultdocker.io/twinproduction/gatus
gatus_versionstr
Container image version.
Defaultv5.37.0
gatus_autoupdatebool
Enable podman auto-update for this container.
Defaulttrue
gatus_network_enabledbool
Create and manage the podman network.
Defaulttrue
gatus_network_namestr
Podman network name.
Defaultgatus-internal
gatus_network_driverstr
Podman network driver.
Defaultbridge
gatus_port_map_enabledbool
Expose container ports on the host.
Defaultfalse
gatus_bind_ipstr
Host IP to bind exposed ports to.
Default127.0.0.1
gatus_port_maplist[str]
Host:container port mappings.
Default- 8080:8080
gatus_urlstr
External URL of the status page, used for the OIDC redirect.
Default""
gatus_titlestr
Page title and header.
DefaultHomelab
gatus_traefik_hostslist[str]
Inventory hosts whose traefik_http_services become endpoints.
Default{{ groups['all'] }}
gatus_traefik_excludelist[str]
traefik_http_services names that get no endpoint.
Default[]
gatus_traefik_overridesdict
Endpoint keys for single generated endpoints, keyed by traefik_http_services name.
Default{}
gatus_endpointslist[dict]
Additional Gatus endpoint definitions.
Default[]
gatus_endpoint_defaultsdict
Values for keys missing in generated and additional endpoints.
Default
```
interval: 1m
conditions:
- '[STATUS] < 400'
- '[CERTIFICATE_EXPIRATION] > 336h'
alerts: []
```
gatus_oidc_enabledbool
Require an OIDC login for the status page.
Defaultfalse
gatus_oidc_issuer_urlstr
OIDC issuer URL.
Default""
gatus_oidc_client_idstr
OIDC client ID.
Defaultgatus
gatus_oidc_client_secretstr
OIDC client secret.
Default""
gatus_alertingdict
Gatus alerting providers configuration.
Default{}
gatus_extra_configdict
Merged recursively into the generated config.yaml.
Default{}
gatus_environment_varsdict
Extra environment variables injected into the container.
Default{}
gatus_entrypointstr
Optional container entrypoint override.
Default""
gatus_extra_fileslist[dict]
Arbitrary file entries with src (controller path) or source (target path), dest, optional mount, mode, and template.
Default[]
gatus_extra_dirslist[dict]
Arbitrary directory entries with src (controller directory) or source (target path), dest, optional mount and mode.
Default[]