prosody-modules
4c0e3fe57e92
mod_http_muc_log/README.md
Software / code / prosody-modules
File
mod_http_muc_log/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 |
| child | 6211:750d64c47ec6 |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: Provides a web interface to stored chatroom logs rockspec: build: copy_directories: - res - static ... Introduction ============ This module provides a built-in web interface to view chatroom logs stored by [mod\_muc\_mam]. Installation ============ Same as any other module, be sure to include the HTML template `http_muc_log.html` alongside `mod_http_muc_log.lua`. Configuration ============= For example: ``` lua Component "conference.example.com" "muc" modules_enabled = { "muc_mam"; "http_muc_log"; } storage = { muc_log = "sql"; -- for example } ``` The web interface would then be reachable at the address: http://conference.example.com:5280/muc_log/ See [the page about Prosodys HTTP server][doc:http] for info about the address. ## Styling The default HTML template lives in `http_muc_log.html` in the same directory as the module, but can be changed by setting `http_muc_log_template` to point to a different file. The same template, with different input is used for every view. The module uses [util.interpolation][doc:developers:util:interpolation] for rendering templates, with the pattern `"%b{}"` and HTML / XML escaping enabled. ## Default view To link to the latest day instead of calendar from the room listing page: ```lua http_muc_log_default_view = "latest" ``` ## Inline images Inline images can optionally be shown. This is disabled by default for privacy reasons. ``` {.lua} http_muc_log_show_images = true ``` ## Calendar optimization The calendar view relies on an optional part of the Prosody archive storage API that provides a list of every valid date. If this is unavailable then the module queries for the first and the last messages and assumes that every date between those is valid. This may lead to many empty pages in case the logs are sparse. This optimization can be turned off, to get a more accurate calendar view, but it will likely be very slow. ``` {.lua} http_muc_log_lazy_calendar = false ``` ## Pinned chatrooms The room list page is normally sorted by address, rooms having a description before those that don't. To override this, or pin certain rooms to the top: ``` lua http_muc_log_list_order = { "general@channels.example.com", "support@channels.example.com", } ``` Compatibility ============= Requires Prosody 0.11 or later and a storage backend with support for stanza archives. See [mod\_storage\_muc\_log] for using legacy data from [mod\_muc\_log].
