mod_http_status/README.md
author Kim Alvefur <zash@zash.se>
Sun, 11 Feb 2024 12:50:53 +0100
changeset 5838 866a49f5aa61
parent 5683 e274431bf4ce
permissions -rw-r--r--
mod_firewall: Fix to find scripts when installed with plugin installer Extra resources are stored in a different path by luarocks, not alongside the code as this code assumed. Thanks eTaurus

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.