Mercurial > prosody-modules

view mod_muc_log_http/README.markdown @ 5907:d194d1012fd3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
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 :)