mod_muc_log_http/README.markdown

   1 ---
   2 labels:
   3 - 'Stage-Beta'
   4 summary: Provides a web interface to stored chatroom logs
   5 ...
   6
   7 Introduction
   8 ============
   9
  10 This module provides a built-in web interface to view chatroom logs
  11 stored by [mod\_muc\_log](mod_muc_log.html).
  12
  13 Installation
  14 ============
  15
  16 Just copy the folder muc\_log\_http as it is, into the modules folder of
  17 your Prosody installation.
  18
  19 Configuration Details
  20 =====================
  21
  22 Example configuration:
  23
  24         Component "conference.example.com" "muc"
  25         modules_enabled = {
  26             .....
  27             "muc_log";
  28             "muc_log_http";
  29             .....
  30         }
  31
  32         muc_log_http = { -- These are the defaults
  33             show_join = true;
  34             show_presences = true;
  35             show_status = true;
  36             theme = "prosody";
  37             url_base = "muc_log";
  38         }
  39
  40 **show\_join** sets the default for showing joins or leaves.
  41 **show\_status** sets the default for showing status changes.
  42
  43 The web interface would then be reachable at the address:
  44
  45     http://conference.example.com:5280/muc_log/
  46
  47 TODO
  48 ====
  49
  50 -   Log bans correctly
  51 -   Quota \~ per day ?!
  52 -   Testing testing :)