Mercurial > prosody-modules
view mod_admin_web/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 | 73915ac32649 |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: Web administration interface rockspec: build: platforms: unix: type: command build_command: cd admin_web; sh get_deps.sh install_command: | cd admin_web; cp mod_admin_web.lua $(LUADIR); cp -r www_files $(PREFIX); ... Introduction ============ This module provides a basic web administration interface. It currently gives you access to Ad-Hoc commands on any virtual host or component that you are set as an administrator for in the Prosody config file. It also provides a live list of all S2S and C2S connections. Installation ============ 1. Copy the admin\_web directory into a directory Prosody will check for plugins. (cf. [Installing modules](http://prosody.im/doc/installing_modules)) 2. Execute the contained `get_deps.sh` script from within the admin\_web directory. (Requires wget, tar, and a basic shell) Configuration Details ===================== "admin\_web" needs to be added to the modules\_enabled table of the host you want to load this module on. By default the interface will then be reachable under `http://example.com:5280/admin`, or `https://example.com:5281/admin`. The module will automatically enable two other modules if they aren't already: mod\_bosh (used to connect to the server from the web), and mod\_admin\_adhoc (which provides admin commands over XMPP). VirtualHost "example.com" modules_enabled = { ..... "admin_web"; ..... } Compatibility ============= --------- --------------- trunk Works 0.9 Works \<= 0.8 Not supported --------- ---------------
