mod_s2s_keepalive: Update README to document timeout behavior
authorKim Alvefur <zash@zash.se>
Sat, 21 Dec 2019 18:50:36 +0100
changeset 3772 bfc4d495bf2c
parent 3771 7fe10086e124
child 3773 ce1a32aa8bca
mod_s2s_keepalive: Update README to document timeout behavior
mod_s2s_keepalive/README.markdown
--- a/mod_s2s_keepalive/README.markdown	Sat Dec 21 18:47:39 2019 +0100
+++ b/mod_s2s_keepalive/README.markdown	Sat Dec 21 18:50:36 2019 +0100
@@ -17,6 +17,9 @@
 `keepalive_servers`. The ping interval can be set using
 `keepalive_interval`.
 
+If no response to the ping has been received in about 10 minutes (or
+`keepalive_timeout` seconds) the s2s connections are closed.
+
 ``` lua
 modules_enabled = {
     ...
@@ -25,6 +28,7 @@
 
 keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" }
 keepalive_interval = 90 -- (in seconds, default is 60 )
+keepalive_timeout = 300 -- (in seconds, default is 593 )
 ```
 
 Compatibility