Mercurial > prosody-modules

annotate mod_s2s_keepalive/README.markdown @ 2079:edec9de0220a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_firewall: Silence warnings about unused arguments [luacheck]
author Kim Alvefur <zash@zash.se>
date Fri, 11 Mar 2016 18:52:36 +0100
parents 6e712ce58edf
children f1ea8044f9f8
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
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
8 This module periodically sends XEP-0199 ping requests to remote servers
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
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
18 modules_enabled = {
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
19 ...
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
20 "s2s_keepalive"
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
21 }
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
22
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
23 keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" }
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
24 keepalive_interval = "300" -- (in seconds, default is 60 )
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
25
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
26 Compatibility
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
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 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
31 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
32 0.8 Works
1901
392e62f518a5 mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff changeset
33 ------- -----------------------