Mercurial > prosody-modules
annotate mod_s2s_keepalive/README.md @ 6319:04c3273cb81f
mod_auth_cyrus: Add empty 'profile' table to SASL handler objects
This is for compatibility with Prosody's built-in util.sasl objects.
A SASL profile table usually includes methods supported by the backend, which
can be used by SASL mechanism handlers to perform operations (such as testing
the password). It also optionally contains a 'cb' field with channel binding
method handlers.
The Cyrus backend doesn't support channel binding, and doesn't have the same
concept of auth backend methods (it handles all that internally, and Prosody
has no insight or control over it).
Thus, we create an empty profile which informs Prosody that the SASL handler
does not support any of the auth or channel binding methods. Some features
will not work, but they didn't work anyway. This just makes it explicit.
This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to
always contain a 'profile' field.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Thu, 04 Sep 2025 10:14:46 +0100 |
| parents | fe0a58b863db |
| children |
| rev | line source |
|---|---|
|
1901
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
1 --- |
|
6025
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
2 labels: |
|
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
3 - 'Stage-Beta' |
|
1901
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
4 summary: Keepalive s2s connections |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
5 ... |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
6 |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
7 Introduction |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
8 ============ |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
9 |
|
6025
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
10 This module periodically sends [XEP-0199] ping requests to remote servers to keep your connection alive. |
|
1901
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
11 |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
12 Configuration |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
13 ============= |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
14 |
|
6025
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
15 Simply add the module to the `modules_enabled` list like any other module. |
|
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
16 By default, all current s2s connections will be pinged |
|
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
17 periodically. To ping only a subset of servers, list these in `keepalive_servers`. |
|
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
18 The ping interval can be set using `keepalive_interval`. |
|
1901
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
19 |
|
6025
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
20 If no response to the ping has been received in about 10 minutes (or `keepalive_timeout` seconds) the s2s connections are closed. |
|
3768
bfc4d495bf2c
mod_s2s_keepalive: Update README to document timeout behavior
Kim Alvefur <zash@zash.se>
parents:
3767
diff
changeset
|
21 |
|
2162
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
22 ``` lua |
|
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
23 modules_enabled = { |
|
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
24 ... |
|
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
25 "s2s_keepalive" |
|
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
26 } |
|
1901
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
27 |
|
2162
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
28 keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" } |
|
3767
7fe10086e124
mod_s2s_keepalive: Update config example (why was the number a string?)
Kim Alvefur <zash@zash.se>
parents:
3729
diff
changeset
|
29 keepalive_interval = 90 -- (in seconds, default is 60 ) |
|
3768
bfc4d495bf2c
mod_s2s_keepalive: Update README to document timeout behavior
Kim Alvefur <zash@zash.se>
parents:
3767
diff
changeset
|
30 keepalive_timeout = 300 -- (in seconds, default is 593 ) |
|
2162
f1ea8044f9f8
mod_s2s_keepalive/README: Give language hints to rendering for syntax hilighting
Kim Alvefur <zash@zash.se>
parents:
1902
diff
changeset
|
31 ``` |
|
1901
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
32 |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
33 Compatibility |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
34 ============= |
|
392e62f518a5
mod_s2s_keepalive: Add README
Michael Töglhofer <michael@toeglhofer.net>
parents:
diff
changeset
|
35 |
|
6025
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
36 Prosody Version Status |
| 6262 | 37 ----------------- ------------------------ |
| 38 trunk Works as of 2025-06-13 | |
| 39 13.0 Works | |
|
6253
502963b86fbc
:multble modules: fix tab-> space
Menel <menel@snikket.de>
parents:
6252
diff
changeset
|
40 0.12 Works |
