view mod_host_status_heartbeat/README.markdown @ 5039:c0d243b27e64

mod_sasl2, mod_sasl_bind2, mod_sasl2_sm: Bump XEP-0388 namespace This is the namespace for the proposed update to XEP-0388. I.e. not even experimental yet... but this is all a work in progress anyway.
author Matthew Wild <mwild1@gmail.com>
date Tue, 13 Sep 2022 20:32:20 +0100
parents 3f75f892a41e
children
line wrap: on
line source

---
labels: Stage-Beta
summary: Host status heartbeat
...

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

This module integrates with [mod\_host\_status\_check] to provide heartbeats at regular intervals.

The only time you will generally want this, is if you are using [mod\_component\_client] to run Prosody as
an external component of another Prosody server that has [mod\_host\_status\_check] loaded and waiting for
heartbeats.

Alternatively you can run this on the same Prosody host as [mod\_http\_host\_status\_check] and it will simply
update a variable periodically to indicate that Prosody and timers are functional.

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

The following configuration options are supported:

```{.lua}
-- The number of seconds to wait between sending heartbeats
status_check_heartbeat_interval = 5

-- Set this to "remote" (the default) if you are using mod_component_client
-- and you want to send a heartbeat to a remote server. Otherwise
-- set it to "local" to send to mod_host_status_check on the same server.
status_check_heartbeat_mode = "remote"
```

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

Works with Prosody 0.9.x and later.