view mod_http_host_status_check/README.markdown @ 3005:902ecd6400bd

mod_mam_muc/README: Clarify that only v0.5 of XEP-0313 is supported when used with Prosody 0.10.x
author Kim Alvefur <zash@zash.se>
date Tue, 17 Apr 2018 14:00:40 +0200
parents 2a16a6c67288
children 694b62d8a82f
line wrap: on
line source

---
labels: Stage-Beta
summary: HTTP Host Status Check
...

Introduction
============

This module exposes serves over HTTP the information collected by [mod\_host\_status\_check] and
[mod\_host\_status\_heartbeat] in a convenient format for automated monitoring tools.

Configuration
=============

[mod\_http\_status\_check] relies on Prosodys HTTP server and mod\_http for
serving HTTP requests. See [Prosodys HTTP server
documentation][doc:http] for information about how to
configure ports, HTTP Host names etc.

Simply add this module to modules\_enabled for the host you would like to serve it from.

There is a single configuration option:

``` {.lua}
    -- The maximum number of seconds that a host can go without sending a heartbeat,
    -- before we mark it as TIMEOUT (default: 5)
    status_check_heartbeat_threshold = 5;
```

Compatibility
=============

Works with Prosody 0.9.x and later.