Software / code / prosody-modules
Annotate
mod_s2s_keepalive/README.markdown @ 3628:2444fb3b05b7
mod_csi_muc_priorities: Signal unimportance (thanks tmolitor)
The short version of this module would be `return priorities[room]`,
but the `false` case got lost somewhere along the way.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Thu, 04 Jul 2019 08:46:26 +0200 |
| parent | 3065:49254b9cc751 |
| child | 3723:427879b46061 |
| rev | line source |
|---|---|
|
1901
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
1 --- |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
2 summary: Keepalive s2s connections |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
3 ... |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
4 |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
5 Introduction |
|
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 |
|
2162
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
8 This module periodically sends [XEP-0199] ping requests to remote servers |
|
1901
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
9 to keep your connection alive. |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
10 |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
11 Configuration |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
12 ============= |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
13 |
|
3065
49254b9cc751
mod_s2s_keepalive/README: Clarify options (fixes #675)
Kim Alvefur <zash@zash.se>
parents:
2162
diff
changeset
|
14 Simply add the module to the `modules_enabled` list like any other |
|
49254b9cc751
mod_s2s_keepalive/README: Clarify options (fixes #675)
Kim Alvefur <zash@zash.se>
parents:
2162
diff
changeset
|
15 module. By default, all current s2s connections will be pinged |
|
49254b9cc751
mod_s2s_keepalive/README: Clarify options (fixes #675)
Kim Alvefur <zash@zash.se>
parents:
2162
diff
changeset
|
16 periodically. To ping only a subset of servers, list these in |
|
49254b9cc751
mod_s2s_keepalive/README: Clarify options (fixes #675)
Kim Alvefur <zash@zash.se>
parents:
2162
diff
changeset
|
17 `keepalive_servers`. The ping interval can be set using |
|
49254b9cc751
mod_s2s_keepalive/README: Clarify options (fixes #675)
Kim Alvefur <zash@zash.se>
parents:
2162
diff
changeset
|
18 `keepalive_interval`. |
|
1901
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
19 |
|
2162
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
20 ``` lua |
|
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
21 modules_enabled = { |
|
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
22 ... |
|
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
23 "s2s_keepalive" |
|
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
24 } |
|
1901
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
25 |
|
2162
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
26 keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" } |
|
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
27 keepalive_interval = "300" -- (in seconds, default is 60 ) |
|
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
28 ``` |
|
1901
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
29 |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
30 Compatibility |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
31 ============= |
|
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 ------- ----------------------- |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
34 0.10 Works |
|
1902
6e712ce58edf
mod_s2s_keepalive/README: Update to say it works with 0.8
Kim Alvefur <zash@zash.se>
parents:
1901
diff
changeset
|
35 0.9 Works |
|
6e712ce58edf
mod_s2s_keepalive/README: Update to say it works with 0.8
Kim Alvefur <zash@zash.se>
parents:
1901
diff
changeset
|
36 0.8 Works |
|
1901
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
37 ------- ----------------------- |
