Annotate

mod_list_active/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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 Description
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 ===========
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3
2638
33f7ca7bdc86 mod_list_active: Add README
Kim Alvefur <zash@zash.se>
parents: 2190
diff changeset
4 This module lists those users, who **have** used their account in a
33f7ca7bdc86 mod_list_active: Add README
Kim Alvefur <zash@zash.se>
parents: 2190
diff changeset
5 defined time-frame, basically the inverse of [mod_list_inactive].
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 Dependencies
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8 ============
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9
2190
0c01444f8bc2 mod_list_inactive/README: Describe what the dependency does
Kim Alvefur <zash@zash.se>
parents: 2189
diff changeset
10 [mod_lastlog] must be enabled to collect the data used by this module.
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12 Usage
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13 =====
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14
2638
33f7ca7bdc86 mod_list_active: Add README
Kim Alvefur <zash@zash.se>
parents: 2190
diff changeset
15 prosodyctl mod_list_active example.com time [format]
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16
2189
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
17 Time is a number followed by 'day', 'week', 'month' or 'year'
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
18
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
19 Formats are:
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20
2189
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
21 --------- ------------------------------------------------
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
22 default `user@example.com`
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
23 event `user@example.com last action`
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
24 --------- ------------------------------------------------
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
25
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
26 Example
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
27 =======
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
28
2638
33f7ca7bdc86 mod_list_active: Add README
Kim Alvefur <zash@zash.se>
parents: 2190
diff changeset
29 prosodyctl mod_list_active example.com 1year
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
30
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
31 Help
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
32 ====
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
33
2638
33f7ca7bdc86 mod_list_active: Add README
Kim Alvefur <zash@zash.se>
parents: 2190
diff changeset
34 prosodyctl mod_list_active