Software /
code /
prosody-modules
Annotate
mod_sasl2/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 | 6061:26bfcb442138 |
rev | line source |
---|---|
4798 | 1 --- |
2 labels: | |
5089
5b77f4720bfe
mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents:
5064
diff
changeset
|
3 - Stage-Beta |
4798 | 4 summary: "XEP-0388: Extensible SASL Profile" |
5 --- | |
6 | |
6061
26bfcb442138
mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents:
5965
diff
changeset
|
7 Implementation of [XEP-0388: Extensible SASL Profile]. |
5089
5b77f4720bfe
mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents:
5064
diff
changeset
|
8 |
5b77f4720bfe
mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents:
5064
diff
changeset
|
9 ## Configuration |
5b77f4720bfe
mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents:
5064
diff
changeset
|
10 |
5b77f4720bfe
mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents:
5064
diff
changeset
|
11 This module honours the same configuration options as Prosody's existing |
5b77f4720bfe
mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents:
5064
diff
changeset
|
12 [mod_saslauth](https://prosody.im/doc/modules/mod_saslauth). |
5064
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
13 |
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
14 ## Developers |
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
15 |
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
16 mod_sasl2 provides some events you can hook to affect aspects of the |
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
17 authentication process: |
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
18 |
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
19 - `advertise-sasl-features` |
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
20 - `sasl2/c2s/success` |
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
21 - Priority 1000: Session marked as authenticated, success response created (`event.success`) |
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
22 - Priority -1000: Success response sent to client |
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
23 - Priority -1500: Updated <stream-features/> sent to client |
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
24 - `sasl2/c2s/failure` |
7d33178c79f2
mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents:
4798
diff
changeset
|
25 - `sasl2/c2s/error` |
5965
da942a3f3660
mod_sasl2: Clarify that this module requires Prosody trunk
Kim Alvefur <zash@zash.se>
parents:
5089
diff
changeset
|
26 |
da942a3f3660
mod_sasl2: Clarify that this module requires Prosody trunk
Kim Alvefur <zash@zash.se>
parents:
5089
diff
changeset
|
27 # Compatibility |
da942a3f3660
mod_sasl2: Clarify that this module requires Prosody trunk
Kim Alvefur <zash@zash.se>
parents:
5089
diff
changeset
|
28 |
da942a3f3660
mod_sasl2: Clarify that this module requires Prosody trunk
Kim Alvefur <zash@zash.se>
parents:
5089
diff
changeset
|
29 This module requires Prosody **trunk** and is not compatible with 0.12 or older versions. |
da942a3f3660
mod_sasl2: Clarify that this module requires Prosody trunk
Kim Alvefur <zash@zash.se>
parents:
5089
diff
changeset
|
30 |
6061
26bfcb442138
mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents:
5965
diff
changeset
|
31 |
26bfcb442138
mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents:
5965
diff
changeset
|
32 Prosody Version Status |
26bfcb442138
mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents:
5965
diff
changeset
|
33 ----------------------- ---------------- |
26bfcb442138
mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents:
5965
diff
changeset
|
34 trunk as of 2024-11-24 Works |
26bfcb442138
mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents:
5965
diff
changeset
|
35 0.12 Does not work |
26bfcb442138
mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents:
5965
diff
changeset
|
36 ----------------------- ---------------- |