mirrors/gatus
1
0
Fork 0
mirror of https://github.com/TwiN/gatus.git synced 2026-04-27 20:35:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Document remote.client configuration (#1637)

Browse Source 
chore(docs): Document remote.client configuration

Document remote.client configuration for ticket #64.
This commit is contained in:
SurDaft - Jack Stupple
2026-04-23 03:40:37 +01:00
committed by GitHub
parent bc433161d6
commit 447c7ad321
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -2842,12 +2842,13 @@ This is an experimental feature. It may be removed or updated in a breaking mann
there are known issues with this feature. If you'd like to provide some feedback, please write a comment in [#64](https://github.com/TwiN/gatus/issues/64).
Use at your own risk.
| Parameter | Description | Default |
|:-----------------------------------|:---------------------------------------------|:--------------|
| `remote` | Remote configuration | `{}` |
| `remote.instances` | List of remote instances | Required `[]` |
| `remote.instances.endpoint-prefix` | String to prefix all endpoint names with | `""` |
| `remote.instances.url` | URL from which to retrieve endpoint statuses | Required `""` |
| Parameter | Description | Default |
|:-----------------------------------|:-----------------------------------------------|:--------------|
| `remote` | Remote configuration | `{}` |
| `remote.instances` | List of remote instances | Required `[]` |
| `remote.instances.endpoint-prefix` | String to prefix all endpoint names with | `""` |
| `remote.instances.url` | URL from which to retrieve endpoint statuses | Required `""` |
| `remote.client` | [Client configuration](#client-configuration). | `{}` |
```yaml
remote: