Software /
code /
prosody-modules
Annotate
mod_atom/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 |
rev | line source |
---|---|
3257 | 1 # Introduction |
2 | |
3 This module exposes users [microblogging][xep277] on Prosodys built-in HTTP server. | |
4 | |
3574
f478e325529e
mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents:
3257
diff
changeset
|
5 # Usage |
f478e325529e
mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents:
3257
diff
changeset
|
6 |
f478e325529e
mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents:
3257
diff
changeset
|
7 With default HTTP settings, the microblog of `user@example.com` would be |
f478e325529e
mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents:
3257
diff
changeset
|
8 seen at `https://example.com:5281/atom/user`. |
f478e325529e
mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents:
3257
diff
changeset
|
9 |
3257 | 10 # Configuration |
11 | |
12 The module itself has no options. However it uses the access control | |
13 mechanisms in PubSub, so users must reconfigure their microblogging node | |
14 to allow access, by setting `access_model` to `open`. | |
15 E.g. Gajim has UI for this, look for "Personal Events" → "Configure | |
16 services". | |
17 |