twin-gatus/README.md

# gatus

[![Docker pulls](https://img.shields.io/docker/pulls/twinproduction/gatus.svg)](https://cloud.docker.com/repository/docker/twinproduction/gatus)

**Status:** IN PROGRESS

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


## Usage

```yaml
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)
    conditions:
      - "$STATUS == 200"
  - name: github
    url: https://api.github.com/healthz
    conditions:
      - "$STATUS == 200"
```


## Docker

Building the Docker image is done as following:

```
docker build . -t gatus
```

You can then run the container with the following command:

```
docker run -p 8080:8080 --name gatus gatus
```


## Running the tests

```
go test ./... -mod vendor
```


## Using in Production

See the [example](example) folder.
Add example 2019-09-14 23:59:05 +00:00			`# gatus`

			`[![Docker pulls](https://img.shields.io/docker/pulls/twinproduction/gatus.svg)](https://cloud.docker.com/repository/docker/twinproduction/gatus)`
Add watchdog package 2019-09-04 23:37:13 +00:00
Add status in README.md 2019-09-22 02:39:28 +00:00			`Status: IN PROGRESS`

Add Dockerfile 2019-09-14 23:25:59 +00:00			`A service health dashboard in Go that is meant to be used as a docker`
			`image with a custom configuration file.`
Add ugly rough draft 2019-09-11 01:05:57 +00:00

Implement interval + Add timestamp to Result struct 2019-09-09 01:07:08 +00:00			`## Usage`
Add watchdog package 2019-09-04 23:37:13 +00:00
			```yaml
			`services:`
Implement interval + Add timestamp to Result struct 2019-09-09 01:07:08 +00:00			`- name: twinnation # Name of your service, can be anything`
Add watchdog package 2019-09-04 23:37:13 +00:00			`url: https://twinnation.org/actuator/health`
Add Dockerfile 2019-09-14 23:25:59 +00:00			`interval: 15s # Duration to wait between every status check (opt. default: 10s)`
Add watchdog package 2019-09-04 23:37:13 +00:00			`conditions:`
			`- "$STATUS == 200"`
Implement interval + Add timestamp to Result struct 2019-09-09 01:07:08 +00:00			`- name: github`
			`url: https://api.github.com/healthz`
			`conditions:`
			`- "$STATUS == 200"`
			```


Minor update 2019-10-28 01:17:55 +00:00			`## Docker`

			`Building the Docker image is done as following:`
Implement interval + Add timestamp to Result struct 2019-09-09 01:07:08 +00:00
			```
Minor update 2019-10-28 01:17:55 +00:00			`docker build . -t gatus`
Implement interval + Add timestamp to Result struct 2019-09-09 01:07:08 +00:00			```
Add Dockerfile 2019-09-14 23:25:59 +00:00
Minor update 2019-10-28 01:17:55 +00:00			`You can then run the container with the following command:`
Add Dockerfile 2019-09-14 23:25:59 +00:00
Minor update 2019-10-28 01:17:55 +00:00			```
			`docker run -p 8080:8080 --name gatus gatus`
			```


			`## Running the tests`
Add Dockerfile 2019-09-14 23:25:59 +00:00
			```
Minor update 2019-10-28 01:17:55 +00:00			`go test ./... -mod vendor`
Add Dockerfile 2019-09-14 23:25:59 +00:00			```


			`## Using in Production`

			`See the [example](example) folder.`