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

docs: Fix typos

Browse Source
This commit is contained in:
TwiN 2022-12-03 21:26:46 -05:00
parent 1aeb045703
commit 9fc8374a4d
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1335,9 +1335,8 @@ By prefixing `endpoints[].url` with `udp:\\`, you can monitor UDP endpoints at a
```yaml ```yaml
endpoints: endpoints:
- name: iper server - name: example
url: "udp://127.0.0.1:12345" url: "udp://example.org:80"
interval: 30s
conditions: conditions:
- "[CONNECTED] == true" - "[CONNECTED] == true"
``` ```
@ -1348,13 +1347,12 @@ Placeholders `[STATUS]` and `[BODY]` as well as the fields `endpoints[].body`, `
This works for UDP based application. This works for UDP based application.
### Monitoring a SCTP endpoint ### Monitoring a SCTP endpoint
By prefixing `endpoints[].url` with `sctp:\\`, you can monitor TCP endpoints at a very basic level: By prefixing `endpoints[].url` with `sctp:\\`, you can monitor Stream Control Transmission Protocol (SCTP) endpoints at a very basic level:
```yaml ```yaml
endpoints: endpoints:
- name: amf - name: example
url: "sctp://127.0.0.1:38412" url: "sctp://127.0.0.1:38412"
interval: 30s
conditions: conditions:
- "[CONNECTED] == true" - "[CONNECTED] == true"
``` ```
@ -1386,7 +1384,6 @@ Defining a `dns` configuration in an endpoint will automatically mark said endpo
endpoints: endpoints:
- name: example-dns-query - name: example-dns-query
url: "8.8.8.8" # Address of the DNS server to use url: "8.8.8.8" # Address of the DNS server to use
interval: 30s
dns: dns:
query-name: "example.com" query-name: "example.com"
query-type: "A" query-type: "A"