prosody-modules
tip
mod_s2s_keepalive/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_s2s_keepalive/README.md @ 6211:750d64c47ec6 draft default tip

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:31:36 +0700
parent 6053:9b0054873be2
comparison
equal deleted inserted replaced
6210:24316a399978 6211:750d64c47ec6
1 ---
2 labels:
3 - 'Stage-Beta'
4 summary: Keepalive s2s connections
5 ...
6
7 Introduction
8 ============
9
10 This module periodically sends [XEP-0199] ping requests to remote servers to keep your connection alive.
11
12 Configuration
13 =============
14
15 Simply add the module to the `modules_enabled` list like any other module.
16 By default, all current s2s connections will be pinged
17 periodically. To ping only a subset of servers, list these in `keepalive_servers`.
18 The ping interval can be set using `keepalive_interval`.
19
20 If no response to the ping has been received in about 10 minutes (or `keepalive_timeout` seconds) the s2s connections are closed.
21
22 ``` lua
23 modules_enabled = {
24 ...
25 "s2s_keepalive"
26 }
27
28 keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" }
29 keepalive_interval = 90 -- (in seconds, default is 60 )
30 keepalive_timeout = 300 -- (in seconds, default is 593 )
31 ```
32
33 Compatibility
34 =============
35
36 Prosody Version Status
37 ----------------- -----------
38 trunk[^1] Works
39 0.12 Works
40 ----------------- -----------
41
42 [^1]: as of 2024-11-11