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