Mercurial > prosody-modules
annotate mod_log_messages_sql/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 |
| rev | line source |
|---|---|
|
2406
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
1 # Introduction |
|
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
2 |
|
3438
b74c86d137c9
mod_log_messages_sql/README: Add pointer towards mod_mam + mod_readonly
Kim Alvefur <zash@zash.se>
parents:
2406
diff
changeset
|
3 ::: {.alert .alert-danger} |
|
b74c86d137c9
mod_log_messages_sql/README: Add pointer towards mod_mam + mod_readonly
Kim Alvefur <zash@zash.se>
parents:
2406
diff
changeset
|
4 Consider using [mod_mam][doc:modules:mod_mam] together with |
|
b74c86d137c9
mod_log_messages_sql/README: Add pointer towards mod_mam + mod_readonly
Kim Alvefur <zash@zash.se>
parents:
2406
diff
changeset
|
5 [mod_readonly] instead. |
|
b74c86d137c9
mod_log_messages_sql/README: Add pointer towards mod_mam + mod_readonly
Kim Alvefur <zash@zash.se>
parents:
2406
diff
changeset
|
6 ::: |
|
b74c86d137c9
mod_log_messages_sql/README: Add pointer towards mod_mam + mod_readonly
Kim Alvefur <zash@zash.se>
parents:
2406
diff
changeset
|
7 |
| 2323 | 8 This module logs messages to a SQL database. |
| 9 | |
| 10 SQL connection options are configured in a `message_log_sql` option, | |
| 11 which has the same syntax as the `sql` option for | |
| 12 [mod_storage_sql][doc:modules:mod_storage_sql]. | |
| 13 | |
|
2406
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
14 # Usage |
|
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
15 |
| 2323 | 16 You will need to create the following table in the configured database: |
| 17 | |
| 18 ``` sql | |
| 19 CREATE TABLE `prosodyarchive` ( | |
| 20 `host` TEXT, | |
| 21 `user` TEXT, | |
| 22 `store` TEXT, | |
| 23 `id` INTEGER PRIMARY KEY AUTOINCREMENT, | |
| 24 `when` INTEGER, | |
| 25 `with` TEXT, | |
| 26 `resource` TEXT, | |
| 27 `stanza` TEXT); | |
| 28 ``` | |
|
2406
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
29 |
|
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
30 # Compatibility |
|
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
31 |
|
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
32 Does *NOT* work with 0.10 due to a conflict with the new archiving |
|
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
33 support in `mod_storage_sql`ยท |
