Software / code / prosody-modules
Annotate
mod_http_debug/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 | 5490:91564b57e595 |
| rev | line source |
|---|---|
| 5489 | 1 --- |
| 2 summary: HTTP module returning info about requests for debugging | |
| 3 --- | |
| 4 | |
| 5 This module returns some info about HTTP requests as Prosody sees them | |
| 6 from an endpoint like `http://xmpp.example.net:5281/debug`. This can be | |
| 7 used to validate [reverse-proxy configuration][doc:http] and similar use | |
| 8 cases. | |
| 9 | |
| 10 # Example | |
| 11 | |
| 12 ``` | |
| 13 $ curl -sSf https://xmpp.example.net:5281/debug | json_pp | |
| 14 { | |
| 15 "body" : "", | |
| 16 "headers" : { | |
| 17 "accept" : "*/*", | |
| 18 "host" : "xmpp.example.net:5281", | |
| 19 "user_agent" : "curl/7.74.0" | |
| 20 }, | |
| 21 "httpversion" : "1.1", | |
| 22 "id" : "jmFROQKoduU3", | |
| 23 "ip" : "127.0.0.1", | |
| 24 "method" : "GET", | |
| 25 "path" : "/debug", | |
| 26 "secure" : true, | |
| 27 "url" : { | |
| 28 "path" : "/debug" | |
| 29 } | |
| 30 } | |
| 31 ``` | |
|
5490
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
32 |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
33 # Configuration |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
34 |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
35 HTTP Methods handled can be configured via the `http_debug_methods` |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
36 setting. By default, the most common methods are already enabled. |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
37 |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
38 ```lua |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
39 http_debug_methods = { "GET"; "HEAD"; "DELETE"; "OPTIONS"; "PATCH"; "POST"; "PUT" }; |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
40 ``` |