Mercurial > prosody-modules
annotate mod_s2s_keepalive/README.md @ 6083:ffd0184cd478
mod_compliance_latest: New module that depends on and therefore loads the latest compliance tester mod.
diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md
new file mode 100644
--- /dev/null
+++ b/mod_compliance_latest/README.md
@@ -0,0 +1,25 @@
+---
+summary: XMPP Compliance Suites self-test
+labels:
+- Stage-Beta
+rockspec:
+ dependencies:
+ - mod_compliance_2023
+...
+
+# Introduction
+
+This module will always require and load to the lastest compliance tester we have in the community modules.
+Currently this is [mod_compliance_2023].
+
+# Configuration
+
+Just load this module as any other module and it will automatically install [mod_compliance_2023] if you use the Prosody plugin installer.
+See the linked module for further details.
+
+# Compatibility
+
+ Prosody-Version Status
+ --------------- ----------------------
+ trunk Works as of 2024-12-22
+ 0.12 Works
diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua
new file mode 100644
--- /dev/null
+++ b/mod_compliance_latest/mod_compliance_latest.lua
@@ -0,0 +1,1 @@
+module:depends("compliance_2023");
| author | Menel <menel@snikket.de> |
|---|---|
| date | Sun, 22 Dec 2024 18:12:42 +0100 |
| parents | 9b0054873be2 |
| children | 1661f6a74141 |
| 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 |
|
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
37 ----------------- ----------- |
|
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
38 trunk[^1] Works |
|
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
39 0.12 Works |
|
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
40 ----------------- ----------- |
|
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
41 |
|
9b0054873be2
mod_s2s_keepalive: Update Compability slSection and Label
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
42 [^1]: as of 2024-11-11 |
