mod_s2s_keepalive/README.markdown
changeset 2166 f1ea8044f9f8
parent 1906 6e712ce58edf
child 3069 49254b9cc751
equal deleted inserted replaced
2165:95a9f2d234da 2166:f1ea8044f9f8
     3 ...
     3 ...
     4 
     4 
     5 Introduction
     5 Introduction
     6 ============
     6 ============
     7 
     7 
     8 This module periodically sends XEP-0199 ping requests to remote servers
     8 This module periodically sends [XEP-0199] ping requests to remote servers
     9 to keep your connection alive.
     9 to keep your connection alive.
    10 
    10 
    11 Configuration
    11 Configuration
    12 =============
    12 =============
    13 
    13 
    14 Simply add the module to the `modules_enabled` list and specify your
    14 Simply add the module to the `modules_enabled` list and specify your
    15 desired servers in `keepalive_servers`. Optionally you can configure
    15 desired servers in `keepalive_servers`. Optionally you can configure
    16 the ping interval.
    16 the ping interval.
    17 
    17 
    18     modules_enabled = {
    18 ``` lua
    19         ...
    19 modules_enabled = {
    20         "s2s_keepalive"
    20     ...
    21     }
    21     "s2s_keepalive"
       
    22 }
    22 
    23 
    23     keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" }
    24 keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" }
    24     keepalive_interval = "300" -- (in seconds, default is 60 )
    25 keepalive_interval = "300" -- (in seconds, default is 60 )
       
    26 ```
    25 
    27 
    26 Compatibility
    28 Compatibility
    27 =============
    29 =============
    28 
    30 
    29   ------- -----------------------
    31   ------- -----------------------