prosody-modules
d194d1012fd3
mod_http_status/README.md
Software / code / prosody-modules
File
mod_http_status/README.md @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| 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.
