view mod_http_host_status_check/README.markdown @ 5223:8b2a36847912

mod_http_oauth2: Support HTTP Basic auth on token endpoint This is described in RFC 6749 section 2.3.1 and draft-ietf-oauth-v2-1-07 2.3.1 as the recommended way to transmit the client's credentials. The older spec even calls it the "client password", but the new spec clarifies that this is just another term for the client secret.
author Matthew Wild <mwild1@gmail.com>
date Tue, 07 Mar 2023 15:27:50 +0000
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.