Mercurial > prosody-modules
annotate mod_auth_http_async/README.md @ 6084: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 |
| parents | fe081789f7b5 |
| children | 7b693a5539ad |
| rev | line source |
|---|---|
|
1933
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
1 --- |
|
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
2 labels: |
|
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
3 - Stage-Alpha |
|
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
4 ... |
|
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
5 |
| 1888 | 6 Introduction |
| 7 ============ | |
| 8 | |
| 9 This is an experimental authentication module that does an asynchronous | |
| 10 HTTP call to verify username and password. | |
| 11 | |
| 12 Details | |
| 13 ======= | |
| 14 | |
| 15 When a user attempts to authenticate to Prosody, this module takes the | |
| 16 username and password and does a HTTP GET request with [Basic | |
| 17 authentication][rfc7617] to the configured `http_auth_url`. | |
| 18 | |
| 19 Configuration | |
| 20 ============= | |
| 21 | |
|
1933
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
22 ``` lua |
| 1888 | 23 VirtualHost "example.com" |
| 24 authentication = "http_async" | |
| 25 http_auth_url = "http://example.com/auth" | |
| 26 ``` | |
| 27 | |
|
1933
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
28 Compatibility |
|
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
29 ============= |
|
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
30 |
|
2121
4916c1b6517f
Update READMEs to indicate that async requires trunk (dropped from prosody 0.10)
Kim Alvefur <zash@zash.se>
parents:
1933
diff
changeset
|
31 Requires Prosody trunk |
