File

mod_muc_log_http/README.markdown @ 5691:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parent 1821:79b9bd84b91c
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\_muc\_log](mod_muc_log.html).

Installation
============

Just copy the folder muc\_log\_http as it is, into the modules folder of
your Prosody installation.

Configuration Details
=====================

Example configuration:

        Component "conference.example.com" "muc"
        modules_enabled = {
            .....
            "muc_log";
            "muc_log_http";
            .....
        }

        muc_log_http = { -- These are the defaults
            show_join = true;
            show_presences = true;
            show_status = true;
            theme = "prosody";
            url_base = "muc_log";
        }

**show\_join** sets the default for showing joins or leaves.
**show\_status** sets the default for showing status changes.

The web interface would then be reachable at the address:

    http://conference.example.com:5280/muc_log/

TODO
====

-   Log bans correctly
-   Quota \~ per day ?!
-   Testing testing :)