view mod_muc_log_http.wiki @ 371:bdac3ad25bce

mod_dwd: Add wiki page
author Kim Alvefur <zash@zash.se>
date Fri, 28 Jun 2013 18:35:40 +0200
parents 646476e373af
children 8b4e2a05f450
line wrap: on
line source

#summary Provides a web interface to stored chatroom logs
#labels Stage-Beta

= Introduction =

This module provides a built-in web interface to view chatroom logs stored by [mod_muc_log].

= Installation =

Just copy the folder muc_log_http as it is, into the modules folder of your Prosody installation.

= Configuration Details =

You need to add muc_log_http to your global modules_enabled, and the configuration options similarly must be put into your global (server-wide) options section:

{{{
   modules_enabled = {
       .....
       "muc_log_http";
       .....
   }

   muc_log_http = {
       http_port = 5290; -- default is 5290
       showJoin = false; -- default is true
       showStatus = false; -- default is true
       theme = "prosody"; -- default is theme "prosody"
   }
}}}

*showJoin* sets the default for showing joins or leaves.
*showStatus* sets the default for showing status changes.

The web interface would then be reachable at the address:
{{{
http://example.com:5290/muc_log/
}}}


= TODO =
  * Log bans correctly
  * Let the admin choose to enable logging via room config
  * Quota ~ per day ?!
  * Testing testing :)