prosody-modules
9b0054873be2
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 @ 6053:9b0054873be2

mod_s2s_keepalive: Update Compability slSection and Label
author Menel <menel@snikket.de>
date Mon, 11 Nov 2024 23:27:53 +0100
parent 6003:fe081789f7b5
comparison
equal deleted inserted replaced
6052:451ec67f2dd3 6053:9b0054873be2
1 --- 1 ---
2 labels:
3 - 'Stage-Beta'
2 summary: Keepalive s2s connections 4 summary: Keepalive s2s connections
3 ... 5 ...
4 6
5 Introduction 7 Introduction
6 ============ 8 ============
7 9
8 This module periodically sends [XEP-0199] ping requests to remote servers 10 This module periodically sends [XEP-0199] ping requests to remote servers to keep your connection alive.
9 to keep your connection alive.
10 11
11 Configuration 12 Configuration
12 ============= 13 =============
13 14
14 Simply add the module to the `modules_enabled` list like any other 15 Simply add the module to the `modules_enabled` list like any other module.
15 module. By default, all current s2s connections will be pinged 16 By default, all current s2s connections will be pinged
16 periodically. To ping only a subset of servers, list these in 17 periodically. To ping only a subset of servers, list these in `keepalive_servers`.
17 `keepalive_servers`. The ping interval can be set using 18 The ping interval can be set using `keepalive_interval`.
18 `keepalive_interval`.
19 19
20 If no response to the ping has been received in about 10 minutes (or 20 If no response to the ping has been received in about 10 minutes (or `keepalive_timeout` seconds) the s2s connections are closed.
21 `keepalive_timeout` seconds) the s2s connections are closed.
22 21
23 ``` lua 22 ``` lua
24 modules_enabled = { 23 modules_enabled = {
25 ... 24 ...
26 "s2s_keepalive" 25 "s2s_keepalive"
32 ``` 31 ```
33 32
34 Compatibility 33 Compatibility
35 ============= 34 =============
36 35
37 ------- ----------------------- 36 Prosody Version Status
38 0.11 Works 37 ----------------- -----------
39 0.10 Works 38 trunk[^1] Works
40 0.9 Works 39 0.12 Works
41 ------- ----------------------- 40 ----------------- -----------
41
42 [^1]: as of 2024-11-11