Mercurial > prosody-modules

changeset 3065:49254b9cc751

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_s2s_keepalive/README: Clarify options (fixes #675)
author Kim Alvefur <zash@zash.se>
date Tue, 29 May 2018 05:04:52 +0200
parents ce61f1826f1f
children cefc375d0929
files mod_s2s_keepalive/README.markdown
diffstat 1 files changed, 5 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/mod_s2s_keepalive/README.markdown	Tue May 29 04:36:56 2018 +0200
+++ b/mod_s2s_keepalive/README.markdown	Tue May 29 05:04:52 2018 +0200
@@ -11,9 +11,11 @@
 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.
+Simply add the module to the `modules_enabled` list like any other
+module. By default, all current s2s connections will be pinged
+periodically. To ping only a subset of servers, list these in
+`keepalive_servers`. The ping interval can be set using
+`keepalive_interval`.
 
 ``` lua
 modules_enabled = {