extern/gatus
1
0
Fork 0
mirror of https://github.com/TwiN/gatus.git synced 2024-11-22 07:53:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Uniformize number of newlines between each header

Browse Source
This commit is contained in:
TwiN 2022-10-10 22:05:48 -04:00
parent 7ea34ec8a8
commit d17e893131
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -30,6 +30,7 @@ Have any feedback or questions? [Create a discussion](https://github.com/TwiN/ga
Like this project? Please consider [sponsoring me](https://github.com/sponsors/TwiN). Like this project? Please consider [sponsoring me](https://github.com/sponsors/TwiN).
## Table of Contents ## Table of Contents
- [Why Gatus?](#why-gatus) - [Why Gatus?](#why-gatus)
- [Features](#features) - [Features](#features)
@ -90,6 +91,7 @@ Like this project? Please consider [sponsoring me](https://github.com/sponsors/T
- [High level design overview](#high-level-design-overview) - [High level design overview](#high-level-design-overview)
- [Sponsors](#sponsors) - [Sponsors](#sponsors)
## Why Gatus? ## Why Gatus?
Before getting into the specifics, I want to address the most common question: Before getting into the specifics, I want to address the most common question:
> Why would I use Gatus when I can just use Prometheus’ Alertmanager, Cloudwatch or even Splunk? > Why would I use Gatus when I can just use Prometheus’ Alertmanager, Cloudwatch or even Splunk?
@ -121,6 +123,7 @@ The main features of Gatus are:
![Gatus dashboard dark mode](.github/assets/dashboard-dark.png) ![Gatus dashboard dark mode](.github/assets/dashboard-dark.png)
## Usage ## Usage
By default, the configuration file is expected to be at `config/config.yaml`. By default, the configuration file is expected to be at `config/config.yaml`.
@ -820,6 +823,7 @@ Here's an example of what the notifications look like:
![Teams notifications](.github/assets/teams-alerts.png) ![Teams notifications](.github/assets/teams-alerts.png)
#### Configuring Telegram alerts #### Configuring Telegram alerts
| Parameter | Description | Default | | Parameter | Description | Default |
|:----------------------------------|:-------------------------------------------------------------------------------------------|:---------------------------| |:----------------------------------|:-------------------------------------------------------------------------------------------|:---------------------------|
@ -888,6 +892,7 @@ endpoints:
description: "healthcheck failed" description: "healthcheck failed"
``` ```
#### Configuring custom alerts #### Configuring custom alerts
| Parameter | Description | Default | | Parameter | Description | Default |
|:--------------------------------|:-------------------------------------------------------------------------------------------|:--------------| |:--------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
@ -1048,6 +1053,7 @@ endpoints:
- type: pagerduty - type: pagerduty
``` ```
### Maintenance ### Maintenance
If you have maintenance windows, you may not want to be annoyed by alerts. If you have maintenance windows, you may not want to be annoyed by alerts.
To do that, you'll have to use the maintenance configuration: To do that, you'll have to use the maintenance configuration:
@ -1086,6 +1092,7 @@ maintenance:
| `security.basic` | HTTP Basic configuration | `{}` | | `security.basic` | HTTP Basic configuration | `{}` |
| `security.oidc` | OpenID Connect configuration | `{}` | | `security.oidc` | OpenID Connect configuration | `{}` |
#### Basic #### Basic
| Parameter | Description | Default | | Parameter | Description | Default |
|:----------------------------------------|:-----------------------------------------------------------------------------------|:--------------| |:----------------------------------------|:-----------------------------------------------------------------------------------|:--------------|
@ -1104,6 +1111,7 @@ security:
**WARNING:** Make sure to carefully select to cost of the bcrypt hash. The higher the cost, the longer it takes to compute the hash, **WARNING:** Make sure to carefully select to cost of the bcrypt hash. The higher the cost, the longer it takes to compute the hash,
and basic auth verifies the password against the hash on every request. As of 2022-01-08, I suggest a cost of 8. and basic auth verifies the password against the hash on every request. As of 2022-01-08, I suggest a cost of 8.
#### OIDC #### OIDC
| Parameter | Description | Default | | Parameter | Description | Default |
|:---------------------------------|:---------------------------------------------------------------|:--------------| |:---------------------------------|:---------------------------------------------------------------|:--------------|
@ -1217,7 +1225,6 @@ and [helmfile example](https://github.com/avakarev/gatus-chart#helmfileyaml-exam
Gatus can be deployed on Terraform by using the following module: [terraform-kubernetes-gatus](https://github.com/TwiN/terraform-kubernetes-gatus). Gatus can be deployed on Terraform by using the following module: [terraform-kubernetes-gatus](https://github.com/TwiN/terraform-kubernetes-gatus).
## Running the tests ## Running the tests
```console ```console
go test ./... -mod vendor go test ./... -mod vendor
@ -1570,6 +1577,7 @@ Where:
- `{duration}` is `7d`, `24h` or `1h` - `{duration}` is `7d`, `24h` or `1h`
- `{key}` has the pattern `<GROUP_NAME>_<ENDPOINT_NAME>` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`. - `{key}` has the pattern `<GROUP_NAME>_<ENDPOINT_NAME>` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`.
##### How to change the color thresholds of the response time badge ##### How to change the color thresholds of the response time badge
To change the response time badges' threshold, a corresponding configuration can be added to an endpoint. To change the response time badges' threshold, a corresponding configuration can be added to an endpoint.
The values in the array correspond to the levels [Awesome, Great, Good, Passable, Bad] The values in the array correspond to the levels [Awesome, Great, Good, Passable, Bad]