Files
gatus/README.md
T

51 lines
1004 B
Markdown
Raw Normal View History

2019-09-14 19:59:05 -04:00
# gatus
[![Docker pulls](https://img.shields.io/docker/pulls/twinproduction/gatus.svg)](https://cloud.docker.com/repository/docker/twinproduction/gatus)
2019-09-04 19:37:13 -04:00
2019-09-14 19:25:59 -04:00
A service health dashboard in Go that is meant to be used as a docker
image with a custom configuration file.
2019-09-10 21:05:57 -04:00
2019-11-11 16:15:35 -05:00
Live example: https://status.twinnation.org/
2019-09-10 21:05:57 -04:00
## Usage
2019-09-04 19:37:13 -04:00
```yaml
services:
- name: twinnation # Name of your service, can be anything
2019-09-04 19:37:13 -04:00
url: https://twinnation.org/actuator/health
2019-09-14 19:25:59 -04:00
interval: 15s # Duration to wait between every status check (opt. default: 10s)
2019-09-04 19:37:13 -04:00
conditions:
- "$STATUS == 200"
- name: github
url: https://api.github.com/healthz
conditions:
- "$STATUS == 200"
```
2019-10-27 21:17:55 -04:00
## Docker
Building the Docker image is done as following:
```
2019-10-27 21:17:55 -04:00
docker build . -t gatus
```
2019-09-14 19:25:59 -04:00
2019-10-27 21:17:55 -04:00
You can then run the container with the following command:
2019-09-14 19:25:59 -04:00
2019-10-27 21:17:55 -04:00
```
docker run -p 8080:8080 --name gatus gatus
```
## Running the tests
2019-09-14 19:25:59 -04:00
```
2019-10-27 21:17:55 -04:00
go test ./... -mod vendor
2019-09-14 19:25:59 -04:00
```
## Using in Production
See the [example](example) folder.