Software /
code /
prosody-modules
File
mod_http_status/README.md @ 5757:cef8bce2d71b
luacheck: Add new module API methods from trunk
See
* trunk rev 4d4f9e42bcf8
* trunk rev 65fb0d7a2312
* trunk rev c9ef35fab0b1
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 27 Nov 2023 07:10:06 +0100 |
parent | 5702:e274431bf4ce |
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.