mod_ping_muc/README.md
changeset 4808 a7c0c70e64b6
child 4906 ed9aa80c989d
equal deleted inserted replaced
4807:f74c7c518bb2 4808:a7c0c70e64b6
       
     1 ---
       
     2 summary: Yet another MUC reliability module
       
     3 rockspec:
       
     4   dependencies:
       
     5   - mod_track_muc_joins
       
     6 labels:
       
     7 - Stage-Alpha
       
     8 ...
       
     9 
       
    10 
       
    11 This module reacts to [server-to-server][doc:s2s] connections closing by
       
    12 performing [XEP-0410: MUC Self-Ping] from the server side to check if
       
    13 users are still connected to MUCs they have joined according
       
    14 [mod_track_muc_joins].  If it can't be confirmed than the user is still
       
    15 joined then their client devices are notified about this allowing them
       
    16 to re-join.
       
    17 
       
    18 # Installing
       
    19 
       
    20 ```
       
    21 prosodyctl install mod_ping_muc
       
    22 ```
       
    23 
       
    24 # Configuring
       
    25 
       
    26 ```lua
       
    27 modules_enabled = {
       
    28 	-- other modules etc
       
    29 	"track_muc_joins",
       
    30 	"ping_muc",
       
    31 }
       
    32 ```
       
    33 
       
    34 # Compatibility
       
    35 
       
    36 Requires prosody **trunk**