astra/ntfy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update config.md

Browse source 
Field is "healthy", not "health"
This commit is contained in:
Octelly 2023-09-29 17:50:27 +02:00 • committed by GitHub
parent e2b5f4a9fb
commit af037b9d70
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/config.md
View file

@ -1180,10 +1180,10 @@ and [here](https://easyengine.io/tutorials/nginx/block-wp-login-php-bruteforce-a
## Health checks ## Health checks
A preliminary health check API endpoint is exposed at `/v1/health`. The endpoint returns a `json` response in the format shown below. A preliminary health check API endpoint is exposed at `/v1/health`. The endpoint returns a `json` response in the format shown below.
If a non-200 HTTP status code is returned or if the returned `health` field is `false` the ntfy service should be considered as unhealthy. If a non-200 HTTP status code is returned or if the returned `healthy` field is `false` the ntfy service should be considered as unhealthy.
```json ```json
{"health":true} {"healthy":true}
``` ```
See [Installation for Docker](install.md#docker) for an example of how this could be used in a `docker-compose` environment. See [Installation for Docker](install.md#docker) for an example of how this could be used in a `docker-compose` environment.