Mercurial > prosody-modules

annotate mod_s2s_keepalive/README.md @ 6092:bd3ff802d883

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_anti_spam: Fix another traceback for origin sessions without an IP This is likely to be the case for stanzas originating from local hosts, for example (so not true s2s). It should be safe to bypass the IP check for those.
author Matthew Wild <mwild1@gmail.com>
date Sat, 28 Dec 2024 21:02:08 +0000
parents 9b0054873be2
children 1661f6a74141
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1901
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
1 ---
6025
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
2 labels:
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
3 - 'Stage-Beta'
1901
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
4 summary: Keepalive s2s connections
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
5 ...
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
6
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
7 Introduction
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
8 ============
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
9
6025
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
10 This module periodically sends [XEP-0199] ping requests to remote servers to keep your connection alive.
1901
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
11
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
12 Configuration
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
13 =============
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
14
6025
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
15 Simply add the module to the `modules_enabled` list like any other module.
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
16 By default, all current s2s connections will be pinged
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
17 periodically. To ping only a subset of servers, list these in `keepalive_servers`.
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
18 The ping interval can be set using `keepalive_interval`.
1901
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
19
6025
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
20 If no response to the ping has been received in about 10 minutes (or `keepalive_timeout` seconds) the s2s connections are closed.
3768
bfc4d495bf2c mod_s2s_keepalive: Update README to document timeout behavior
Kim Alvefur <zash@zash.se>
parents: 3767
diff changeset
21
2162
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
22 ``` lua
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
23 modules_enabled = {
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
24 ...
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
25 "s2s_keepalive"
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
26 }
1901
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
27
2162
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
28 keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" }
3767
7fe10086e124 mod_s2s_keepalive: Update config example (why was the number a string?)
Kim Alvefur <zash@zash.se>
parents: 3729
diff changeset
29 keepalive_interval = 90 -- (in seconds, default is 60 )
3768
bfc4d495bf2c mod_s2s_keepalive: Update README to document timeout behavior
Kim Alvefur <zash@zash.se>
parents: 3767
diff changeset
30 keepalive_timeout = 300 -- (in seconds, default is 593 )
2162
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
31 ```
1901
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
32
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
33 Compatibility
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
34 =============
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
35
6025
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
36 Prosody Version Status
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
37 ----------------- -----------
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
38 trunk[^1] Works
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
39 0.12 Works
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
40 ----------------- -----------
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
41
9b0054873be2 mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents: 5975
diff changeset
42 [^1]: as of 2024-11-11