Gatus — Lightweight Health Check Dashboard

Overview

Gatus polls endpoints on an interval, evaluates a list of conditions against each response, shows the results on a built-in status page and fires alerts when an endpoint fails several checks in a row. Everything lives in one YAML file (default path /config/config.yaml, override with GATUS_CONFIG_PATH, which may also be a directory of *.yaml files that are merged). Results are kept in memory by default; sqlite or postgres storage keeps history across restarts.

Instructions

Step 1: Write the configuration

# config.yaml
storage:
  type: sqlite                 # memory (default), sqlite or postgres
  path: /data/gatus.db         # file for sqlite, connection URL for postgres
web:
  port: 8080
metrics: true                  # Prometheus metrics at /metrics