view mod_muc_log_http/README.markdown @ 5551:8bfcedd93a72

mod_rest: List all error conditions in OpenAPI spec These are not handled by datamanager but by util.stanza and util.error, so they are not represented in the JSON schema file.
author Kim Alvefur <zash@zash.se>
date Sat, 17 Jun 2023 16:26:33 +0200
parents 79b9bd84b91c
children
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 :)