Mercurial > prosody-modules
diff mod_muc_log_http/README.markdown @ 1803:4d73a1a6ba68
Convert all wiki pages to Markdown
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 28 Aug 2015 18:03:58 +0200 |
parents | mod_muc_log_http/README.wiki@29f3d6b7ad16 |
children | 79b9bd84b91c |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_muc_log_http/README.markdown Fri Aug 28 18:03:58 2015 +0200 @@ -0,0 +1,52 @@ +--- +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.md). + +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 :)