Software /
code /
prosody-modules
File
mod_s2s_keepalive/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
author | Ben Smith <bens@effortlessis.com> |
---|---|
date | Mon, 13 May 2024 13:25:13 -0700 |
parent | 3768:bfc4d495bf2c |
line wrap: on
line source
--- 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 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`. 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 = { ... "s2s_keepalive" } 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 ============= ------- ----------------------- 0.11 Works 0.10 Works 0.9 Works ------- -----------------------