vbatts/ntfy
1
0
Fork 0
Code Pull requests Activity

Typo

Browse source
This commit is contained in:
binwiederhier 2023-02-27 10:46:48 -05:00
parent c522ee1dd8
commit 52f18d048c
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/config.md
View file

@ -1068,14 +1068,14 @@ 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 `health` field is `false` the ntfy service should be considered as unhealthy.
```json ```json
{"health":true} {"health":true}
``` ```
See [Installalation/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.
## Logging & debugging ## Logging & debugging
By default, ntfy logs to the console (stderr), with an `info` log level, and in a human-readable text format. By default, ntfy logs to the console (stderr), with an `info` log level, and in a human-readable text format.