Mercurial > prosody-modules
view mod_http_status/README.md @ 6317:7b693a5539ad
mod_auth_http_async: Update documentation
The required async APIs were included in 0.10.0, but at the time of this
writing we only consider 0.12.x and later supported.
The fallback sync API would have made it work with even earlier
versions, but I don't remember specifically and it doesn't matter.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Tue, 02 Sep 2025 21:32:01 +0200 |
| parents | e274431bf4ce |
| children |
line wrap: on
line source
Prosody 0.12 added an API allowing modules to report their status. This module allows reading these statuses via HTTP for use in monitoring. ``` $ curl http://prosody.localhost:5280/status { "example.com" : { "c2s" : { "message" : "Loaded", "type" : "core" } } } ``` # Configuration By default only access via localhost is allowed. This can be adjusted with `http_status_allow_ips`. The following example shows the default: ``` http_status_allow_ips = { "::1"; "127.0.0.1" } ``` Access can also be granted to one IP range via CIDR notation: ``` http_status_allow_cidr = "172.17.2.0/24" ``` The default for `http_status_allow_cidr` is empty.
