view mod_host_status_heartbeat/README.markdown @ 3715:f03a023cd523

mod_http_muc_log: Compose page title from room data More flexible than composing the title from name and date in the controller. Also opens the door to using other room data fields.
author Kim Alvefur <zash@zash.se>
date Sun, 13 Oct 2019 16:16:14 +0200
parents 3f75f892a41e
children 694b62d8a82f
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.