Mercurial > prosody-modules

changeset 1901:392e62f518a5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_s2s_keepalive: Add README
author Michael Töglhofer <michael@toeglhofer.net>
date Sun, 11 Oct 2015 17:23:28 +0200
parents 41ebdb331b94
children 6e712ce58edf
files mod_s2s_keepalive/README.markdown
diffstat 1 files changed, 31 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_s2s_keepalive/README.markdown	Sun Oct 11 17:23:28 2015 +0200
@@ -0,0 +1,31 @@
+---
+summary: Keepalive s2s connections
+...
+
+Introduction
+============
+
+This module periodically sends XEP-0199 ping requests to remote servers
+to keep your connection alive.
+
+Configuration
+=============
+
+Simply add the module to the `modules_enabled` list and specify your
+desired servers in `keepalive_servers`. Optionally you can configure
+the ping interval.
+
+    modules_enabled = {
+        ...
+        "s2s_keepalive"
+    }
+
+    keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" }
+    keepalive_interval = "300" -- (in seconds, default is 60 )
+
+Compatibility
+=============
+
+  ------- -----------------------
+  0.10    Works
+  ------- -----------------------