Simple module adding an endpoint meant to be used for health checks.


After installing, enable by adding to modules_enabled like many other modules:

-- 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"; "" }

Access can also be granted to one IP range via CIDR notation:

http_health_allow_cidr = ""

The default for http_health_allow_cidr is empty.


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 has been set to error.

See also


With the plugin installer in Prosody 0.12 you can use:

sudo prosodyctl install --server= mod_http_health

For earlier versions see the documentation for installing 3rd party modules