prosody-modules
277ccafb4826
mod_http_health/README.md
Software / code / prosody-modules
File
mod_http_health/README.md @ 6037:277ccafb4826
mod_http_oauth2: Fix check for userinfo endpoint handler
It was checking whether the wrong handler exists. It could have made
sense if there was some dependency between them but there isn't.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Thu, 31 Oct 2024 21:49:32 +0100 |
| parent | 5712:09233b625cb9 |
line wrap: on
line source
Simple module adding an endpoint meant to be used for health checks. # Configuration After installing, enable by adding to [`modules_enabled`][doc:modules_enabled] like many other modules: ``` lua -- in the global section modules_enabled = { -- Other globally enabled modules here... "http_health"; -- add } ``` ## Access control By default only access via localhost is allowed. This can be adjusted with `http_health_allow_ips`. The following example shows the default: ``` http_health_allow_ips = { "::1"; "127.0.0.1" } ``` Access can also be granted to one IP range via CIDR notation: ``` http_health_allow_cidr = "172.17.2.0/24" ``` The default for `http_health_allow_cidr` is empty. # Details Adds a `http://your.prosody.example:5280/health` endpoint that returns either HTTP status code 200 when all appears to be good or 500 when any module [status][doc:developers:moduleapi#logging-and-status] has been set to `error`. # See also - [mod_measure_modules] provides module statues via OpenMetrics - [mod_http_status] provides all module status details as JSON via HTTP
