mirror of
https://github.com/TwiN/gatus.git
synced 2024-11-22 16:03:44 +01:00
docs: Add Keeping your configuration small
section
This commit is contained in:
parent
6a5fec2c55
commit
de9c366777
38
README.md
38
README.md
@ -83,6 +83,7 @@ Like this project? Please consider [sponsoring me](https://github.com/sponsors/T
|
|||||||
- [Reloading configuration on the fly](#reloading-configuration-on-the-fly)
|
- [Reloading configuration on the fly](#reloading-configuration-on-the-fly)
|
||||||
- [Endpoint groups](#endpoint-groups)
|
- [Endpoint groups](#endpoint-groups)
|
||||||
- [Exposing Gatus on a custom port](#exposing-gatus-on-a-custom-port)
|
- [Exposing Gatus on a custom port](#exposing-gatus-on-a-custom-port)
|
||||||
|
- [Keeping your configuration small](#keeping-your-configuration-small)
|
||||||
- [Badges](#badges)
|
- [Badges](#badges)
|
||||||
- [Uptime](#uptime)
|
- [Uptime](#uptime)
|
||||||
- [Health](#health)
|
- [Health](#health)
|
||||||
@ -1513,6 +1514,43 @@ web:
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Keeping your configuration small
|
||||||
|
While not specific to Gatus, you can leverage YAML anchors to create a default configuration.
|
||||||
|
If you have a large configuration file, this should help you keep things clean.
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Example</summary>
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
default-endpoint: &defaults
|
||||||
|
group: core
|
||||||
|
interval: 5m
|
||||||
|
client:
|
||||||
|
insecure: true
|
||||||
|
timeout: 30s
|
||||||
|
conditions:
|
||||||
|
- "[STATUS] == 200"
|
||||||
|
|
||||||
|
endpoints:
|
||||||
|
- name: anchor-example-1
|
||||||
|
<<: *defaults # This will merge the configuration under &defaults with this endpoint
|
||||||
|
url: "https://example.org"
|
||||||
|
|
||||||
|
- name: anchor-example-2
|
||||||
|
<<: *defaults
|
||||||
|
group: example # This will override the group defined in &defaults
|
||||||
|
url: "https://example.com"
|
||||||
|
|
||||||
|
- name: anchor-example-3
|
||||||
|
<<: *defaults
|
||||||
|
url: "https://twin.sh/health"
|
||||||
|
conditions: # This will override the conditions defined in &defaults
|
||||||
|
- "[STATUS] == 200"
|
||||||
|
- "[BODY].status == UP"
|
||||||
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
|
|
||||||
### Badges
|
### Badges
|
||||||
#### Uptime
|
#### Uptime
|
||||||
![Uptime 1h](https://status.twin.sh/api/v1/endpoints/core_blog-external/uptimes/1h/badge.svg)
|
![Uptime 1h](https://status.twin.sh/api/v1/endpoints/core_blog-external/uptimes/1h/badge.svg)
|
||||||
|
Loading…
Reference in New Issue
Block a user