extern/gatus
1
0
Fork 0
mirror of https://github.com/TwiN/gatus.git synced 2025-01-09 07:28:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add quick start spoiler

Browse Source
This commit is contained in:
TwinProduction 2021-06-02 18:57:16 -04:00
parent f6f1ecf623
commit eaf395738d
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -16,6 +16,15 @@ checks can be paired with alerting via Slack, PagerDuty, Discord and even Twilio
I personally deploy it in my Kubernetes cluster and let it monitor the status of my I personally deploy it in my Kubernetes cluster and let it monitor the status of my
core applications: https://status.twinnation.org/ core applications: https://status.twinnation.org/
<details>
<summary><b>Quick start</b></summary>
```
docker run -p 8080:8080 --name gatus twinproduction/gatus
```
For more details, see [Usage](#usage)
</details>
## Table of Contents ## Table of Contents
@ -121,6 +130,8 @@ This example would look like this:
Note that you can also use environment variables in the configuration file (e.g. `$DOMAIN`, `${DOMAIN}`) Note that you can also use environment variables in the configuration file (e.g. `$DOMAIN`, `${DOMAIN}`)
If you want to test it locally, see [Docker](#docker).
## Configuration ## Configuration
@ -631,8 +642,13 @@ See [example/kubernetes-with-auto-discovery](example/kubernetes-with-auto-discov
## Docker ## Docker
To run Gatus locally with Docker:
```
docker run -p 8080:8080 --name gatus twinproduction/gatus
```
Other than using one of the examples provided in the `examples` folder, you can also try it out locally by Other than using one of the examples provided in the `examples` folder, you can also try it out locally by
creating a configuration file - we'll call it `config.yaml` for this example - and running the following creating a configuration file, we'll call it `config.yaml` for this example, and running the following
command: command:
``` ```
docker run -p 8080:8080 --mount type=bind,source="$(pwd)"/config.yaml,target=/config/config.yaml --name gatus twinproduction/gatus docker run -p 8080:8080 --mount type=bind,source="$(pwd)"/config.yaml,target=/config/config.yaml --name gatus twinproduction/gatus