gatus/README.md
TwinProduction c734e32e21 Add example
2019-09-14 19:59:05 -04:00

836 B

gatus

Docker pulls

A service health dashboard in Go that is meant to be used as a docker image with a custom configuration file.

Usage

services:
  - name: twinnation  # Name of your service, can be anything
    url: https://twinnation.org/actuator/health
    interval: 15s # Duration to wait between every status check (opt. default: 10s)
    failure-threshold: 3
    conditions:
      - "$STATUS == 200"
  - name: github
    url: https://api.github.com/healthz
    conditions:
      - "$STATUS == 200"

Running the tests

go test ./... -mod vendor

Building with Docker

docker build . -t gatus

Using in Production

See the example folder.