Software /
code /
prosody-modules
File
mod_welcome_page/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 | 6003:fe081789f7b5 |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: 'Serve a welcome page to users' rockspec: dependencies: - mod_http_libjs build: copy_directories: - html ... Introduction ============ This module serves a welcome page to users, and allows them to create an account invite via the web on invite-only servers. The page template and policy of when to allow account creation are both possible to override. This module is part of the suite of modules that implement invite-based account registration for Prosody. The other modules are: - mod_invites - mod_invites_adhoc - mod_invites_page - mod_invites_register - mod_invites_register_web - mod_register_apps For details and a full overview, start with the mod_invites documentation. Configuration ======= `welcome_page_template_path` : The path to a directory containing the page templates and assets. See the module source for the example template. `welcome_page_variables` : Optional variables to pass to the template, available as `{var.name}` `welcome_page_open_registration` : Whether to allow account creation in the absence of any other plugin overriding the policy. Defaults to `false` unless `registration_invite_only` is set to `false`.