view mod_s2s_keepalive/README.markdown @ 2400:bd3a1df128a4

Add documentation for mod_block_outgoing
author Michael Vetter <jubalh@openmailbox.org>
date Sat, 26 Nov 2016 00:34:05 +0100
parents f1ea8044f9f8
children 49254b9cc751
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 and specify your
desired servers in `keepalive_servers`. Optionally you can configure
the ping interval.

``` lua
modules_enabled = {
    ...
    "s2s_keepalive"
}

keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" }
keepalive_interval = "300" -- (in seconds, default is 60 )
```

Compatibility
=============

  ------- -----------------------
  0.10    Works
  0.9     Works
  0.8     Works
  ------- -----------------------