changeset 55:4604930cc085

mod_muclogging initial wiki
author t.ephraim
date Fri, 16 Oct 2009 21:46:37 +0000
parents 3530fa4b114c
children 844b878a31f9
files mod_muclogging.wiki
diffstat 1 files changed, 36 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muclogging.wiki	Fri Oct 16 21:46:37 2009 +0000
@@ -0,0 +1,36 @@
+#summary Module which logs muc conversations to a file
+#labels Stage-Alpha
+
+= Introduction =
+
+This module logs the conversation of muc running on this server to a daily changing file.
+There is a file per room.
+
+= Details =
+
+To enable it, you will need to configure a logFolder at the muc component, which should log.
+e.g.
+{{{
+Component "rooms.example.com" "muc"
+     logFolder = "/var/log/prosody/rooms"
+}}}
+
+In this folder will then created files in form of YearMonthDay_RoomJid.log
+e.g.:
+{{{
+091015_foobar@rooms.example.com.log
+}}}
+
+The content of the logfile are the presence and message stanza's which depend to this room.
+They are wrapped around by a <stanza> tag with an additional time attribute.
+That should make it possible to create nice output in every way.
+e.g.:
+{{{
+<stanza time="23:41:14"><message type='groupchat' from='foobar@rooms.example.com/ephraim' id='aae4a' xmlns='jabber:client'>
+<body>test</body>
+<nick xmlns='http://jabber.org/protocol/nick'>Ephraim</nick>
+</message></stanza>
+}}}
+
+= TODO =
+ * create a simple php script to format the log so the output is more human readable