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

docs(alerting): Provide better Matrix examples

Browse Source
This commit is contained in:
TwiN 2022-09-19 22:08:39 -04:00
parent f44d4055e6
commit 17c14a7243
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -496,20 +496,20 @@ endpoints:
``` ```
#### Configuring Matrix alerts #### Configuring Matrix alerts
| Parameter | Description | Default | | Parameter | Description | Default |
|:-----------------------------------|:-------------------------------------------------------------------------------------------------|:-----------------------------------| |:-----------------------------------------|:-------------------------------------------------------------------------------------------|:-----------------------------------|
| `alerting.matrix` | Settings for alerts of type `matrix` | `{}` | | `alerting.matrix` | Settings for alerts of type `matrix` | `{}` |
| `alerting.matrix.server-url` | Homeserver URL | `https://matrix-client.matrix.org` | | `alerting.matrix.server-url` | Homeserver URL | `https://matrix-client.matrix.org` |
| `alerting.matrix.access-token` | Bot user access token (see https://webapps.stackexchange.com/q/131056) | Required `""` | | `alerting.matrix.access-token` | Bot user access token (see https://webapps.stackexchange.com/q/131056) | Required `""` |
| `alerting.matrix.internal-room-id` | Internal room ID of room to send alerts to (can be found in Element in Room Settings > Advanced) | Required `""` | | `alerting.matrix.internal-room-id` | Internal room ID of room to send alerts to (can be found in Room Settings > Advanced) | Required `""` |
| `alerting.matrix.default-alert` | Default alert configuration. <br />See [Setting a default alert](#setting-a-default-alert) | N/A | | `alerting.matrix.default-alert` | Default alert configuration. <br />See [Setting a default alert](#setting-a-default-alert) | N/A |
```yaml ```yaml
alerting: alerting:
matrix: matrix:
server-url: "..." server-url: "https://matrix-client.matrix.org"
access-token: "..." access-token: "123456"
internal-room-id: "..." internal-room-id: "!example:matrix.org"
endpoints: endpoints:
- name: website - name: website