Mercurial > prosody-modules

annotate mod_s2s_keepalive/README.markdown @ 2608:362ca94192ee

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_smacks: Add resumed session to event "smacks-hibernation-end" Older versions of this event only have the "intermediate" session in event.session (the one used to resume the existing session), but not the resumed one. This adds event.resumed which contains the resumed one alongside to event.session.
author tmolitor <thilo@eightysoft.de>
date Sat, 11 Mar 2017 01:37:28 +0100
parents f1ea8044f9f8
children 49254b9cc751
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 ---
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
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
14 Simply add the module to the `modules_enabled` list and specify your
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
15 desired servers in `keepalive_servers`. Optionally you can configure
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
16 the ping interval.
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
17
2162
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
18 ``` lua
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
19 modules_enabled = {
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
20 ...
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
21 "s2s_keepalive"
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
22 }
1901
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
23
2162
f1ea8044f9f8 mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents: 1902
diff changeset
24 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
25 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
26 ```
1901
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
27
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
28 Compatibility
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
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 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
33 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
34 0.8 Works
1901
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
35 ------- -----------------------