Software /
code /
prosody-modules
Annotate
mod_s2s_idle_timeout/README.md @ 6112:4c0e3fe57e92
mod_compliance_latest: Gracefull error logging on missing dependency.
diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md
--- a/mod_compliance_latest/README.md
+++ b/mod_compliance_latest/README.md
@@ -9,13 +9,15 @@ rockspec:
# 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].
+This meta-module will always `require` (and therefore auto-load) the lastest compliance tester we have in the community modules.
+Currently this is [mod_compliance_2023]. See the linked module for further details.
+
+If you do not use the *Prosody plugin installer* this module will likely have limited value to you.
+You can also just install the current compliance tester manually.
# 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.
+Just load this module as any other module and it will automatically install and load [mod_compliance_2023] if you use the *Prosody plugin installer*.
# Compatibility
diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua
--- a/mod_compliance_latest/mod_compliance_latest.lua
+++ b/mod_compliance_latest/mod_compliance_latest.lua
@@ -1,1 +1,6 @@
-module:depends("compliance_2023");
+local success, err = pcall(function() module:depends("compliance_2023") end)
+
+if not success then
+ module:log("error", "Error, can't load module: mod_compliance_2023. Is this module downloaded in a folder readable by prosody?")
+ return 1, "Error: Couldn't load dependency mod_compliance_2023."
+end
author | Menel <menel@snikket.de> |
---|---|
date | Mon, 23 Dec 2024 12:58:03 +0100 |
parent | 6054:d39ddf13ff0a |
rev | line source |
---|---|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
1 --- |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
2 labels: |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
3 - 'Stage-Stable' |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
4 summary: 'Close idle server-to-server connections' |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
5 ... |
1782 | 6 |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
7 Introduction |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
8 ============ |
1782 | 9 |
6052
451ec67f2dd3
mod_s2s_idle_timeout: Reword README
Menel <menel@snikket.de>
parents:
6051
diff
changeset
|
10 By default prosody does not close s2s |
451ec67f2dd3
mod_s2s_idle_timeout: Reword README
Menel <menel@snikket.de>
parents:
6051
diff
changeset
|
11 connections. This module changes that |
6054
d39ddf13ff0a
mod_s2s_idle_timeout: Reword Readme
Menel <menel@snikket.de>
parents:
6052
diff
changeset
|
12 behaviour by introducing an idle timeout. |
6052
451ec67f2dd3
mod_s2s_idle_timeout: Reword README
Menel <menel@snikket.de>
parents:
6051
diff
changeset
|
13 It will close server-to-server connections |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
14 after they have been silent for a while. |
1782 | 15 |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
16 Configuration |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
17 ============= |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
18 |
6052
451ec67f2dd3
mod_s2s_idle_timeout: Reword README
Menel <menel@snikket.de>
parents:
6051
diff
changeset
|
19 The default timeout is 300 seconds (5 minutes). |
451ec67f2dd3
mod_s2s_idle_timeout: Reword README
Menel <menel@snikket.de>
parents:
6051
diff
changeset
|
20 To change this simply put in the config: |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
21 |
6052
451ec67f2dd3
mod_s2s_idle_timeout: Reword README
Menel <menel@snikket.de>
parents:
6051
diff
changeset
|
22 s2s_idle_timeout = 180 -- time in seconds |
1782 | 23 |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
24 Compatibility |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
25 ============= |
1782 | 26 |
6051
8ea02e737098
mod_s2s_idle_timeout: Update Compability section of README.md
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
27 Prosody Version Status |
8ea02e737098
mod_s2s_idle_timeout: Update Compability section of README.md
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
28 ----------------- ----------- |
8ea02e737098
mod_s2s_idle_timeout: Update Compability section of README.md
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
29 trunk[^1] Works |
8ea02e737098
mod_s2s_idle_timeout: Update Compability section of README.md
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
30 0.12 Works |
8ea02e737098
mod_s2s_idle_timeout: Update Compability section of README.md
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
31 ----------------- ----------- |
8ea02e737098
mod_s2s_idle_timeout: Update Compability section of README.md
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
32 |
8ea02e737098
mod_s2s_idle_timeout: Update Compability section of README.md
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
33 [^1]: as of 2024-10-22 |