Mercurial > prosody-modules

view mod_s2s_keepalive/README.md @ 6319:04c3273cb81f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_auth_cyrus: Add empty 'profile' table to SASL handler objects This is for compatibility with Prosody's built-in util.sasl objects. A SASL profile table usually includes methods supported by the backend, which can be used by SASL mechanism handlers to perform operations (such as testing the password). It also optionally contains a 'cb' field with channel binding method handlers. The Cyrus backend doesn't support channel binding, and doesn't have the same concept of auth backend methods (it handles all that internally, and Prosody has no insight or control over it). Thus, we create an empty profile which informs Prosody that the SASL handler does not support any of the auth or channel binding methods. Some features will not work, but they didn't work anyway. This just makes it explicit. This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to always contain a 'profile' field.
author Matthew Wild <mwild1@gmail.com>
date Thu, 04 Sep 2025 10:14:46 +0100
parents fe0a58b863db
children
line wrap: on
line source

---
labels:
- 'Stage-Beta'
summary: Keepalive s2s connections
...

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

This module periodically sends [XEP-0199] ping requests to remote servers to keep your connection alive.

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

Simply add the module to the `modules_enabled` list like any other module. 
By default, all current s2s connections will be pinged
periodically. To ping only a subset of servers, list these in `keepalive_servers`.
The ping interval can be set using `keepalive_interval`.

If no response to the ping has been received in about 10 minutes (or `keepalive_timeout` seconds) the s2s connections are closed.

``` lua
modules_enabled = {
    ...
    "s2s_keepalive"
}

keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" }
keepalive_interval = 90 -- (in seconds, default is 60 )
keepalive_timeout = 300 -- (in seconds, default is 593 )
```

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

  Prosody Version   Status
  ----------------- ------------------------
  trunk             Works as of 2025-06-13
  13.0              Works
  0.12              Works