Mercurial > prosody-modules
view mod_http_muc_log/README.markdown @ 3581:dbc67120097f
mod_http_muc_log: Document optimization for storage modules lacking :dates API
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sun, 05 May 2019 14:05:00 +0200 |
parents | 89a3f049689f |
children | 444e2306c99a |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: Provides a web interface to stored chatroom logs ... Introduction ============ This module provides a built-in web interface to view chatroom logs stored by [mod\_mam\_muc]. 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 = { "mam_muc"; "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. ## 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 ``` Compatibility ============= Requires Prosody 0.10 or above and a storage backend with support for stanza archives. See [mod\_storage\_muc\_log] for using legacy data from [mod\_muc\_log].