Mercurial > prosody-wiki

annotate mod_muc_log_http.wiki @ 493:278feae4f92e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add page
author Kim Alvefur <zash@zash.se>
date Tue, 18 Nov 2014 14:03:36 +0100
parents 4573bb828a4d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
1 #summary Provides a web interface to stored chatroom logs
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
2 #labels Stage-Beta
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
3
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
4 = Introduction =
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
5
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
6 This module provides a built-in web interface to view chatroom logs stored by [mod_muc_log].
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
7
111
291ee152eea9 added a short install description and a note about the default port.
t.ephraim
parents: 101
diff changeset
8 = Installation =
291ee152eea9 added a short install description and a note about the default port.
t.ephraim
parents: 101
diff changeset
9
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
10 Just copy the folder muc_log_http as it is, into the modules folder of your Prosody installation.
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
11
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
12 = Configuration Details =
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
13
222
646476e373af Remove Host "*" references (thanks egon)
MWild1
parents: 135
diff changeset
14 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:
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
15
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
16 {{{
412
4573bb828a4d Component, not global
Kim Alvefur <zash@zash.se>
parents: 411
diff changeset
17 Component "conference.example.com" "muc"
411
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
18 modules_enabled = {
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
19 .....
412
4573bb828a4d Component, not global
Kim Alvefur <zash@zash.se>
parents: 411
diff changeset
20 "muc_log";
4573bb828a4d Component, not global
Kim Alvefur <zash@zash.se>
parents: 411
diff changeset
21 "muc_log_http";
411
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
22 .....
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
23 }
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
24
411
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
25 muc_log_http = { -- These are the defaults
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
26 show_join = true;
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
27 show_presences = true;
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
28 show_status = true;
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
29 theme = "prosody";
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
30 url_base = "muc_log";
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
31 }
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
32 }}}
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
33
411
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
34 *show_join* sets the default for showing joins or leaves.
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
35 *show_status* sets the default for showing status changes.
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
36
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
37 The web interface would then be reachable at the address:
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
38 {{{
412
4573bb828a4d Component, not global
Kim Alvefur <zash@zash.se>
parents: 411
diff changeset
39 http://conference.example.com:5280/muc_log/
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
40 }}}
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
41
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
42
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
43 = TODO =
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
44 * Log bans correctly
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
45 * Quota ~ per day ?!
411
8b4e2a05f450 update mod_muc_log_http for 0.9+
Kim Alvefur <zash@zash.se>
parents: 222
diff changeset
46 * Testing testing :)