view mod_s2s_keepalive/README.markdown @ 5446:dd7bddc87f98

mod_http_oauth2: Fix inclusion of role in refreshed access tokens `refresh_token_info` does not carry the role, and due to behavior prior to prosody trunk rev a1ba503610ed it would have reverted to the users' default role. After that it instead issues a token without role which is thus not usable with e.g. mod_rest
author Kim Alvefur <zash@zash.se>
date Thu, 11 May 2023 21:37:35 +0200
parents bfc4d495bf2c
children
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
  ------- -----------------------