Diff

mod_message_logging/README.wiki @ 1782:29f3d6b7ad16

Import wiki pages
author Kim Alvefur <zash@zash.se>
date Mon, 24 Aug 2015 16:43:56 +0200
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_message_logging/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,19 @@
+#summary Log/archive all user messages
+#labels Stage-Beta
+
+= Introduction =
+
+Often service administrators need to log their users' messages for reasons such as auditing and compliance. This module simply logs user messages to simple text files, which can be easily searched, archived or removed on a regular basis.
+
+= Usage =
+
+Simply load the module and it will start logging. Reloading Prosody (e.g. with a SIGHUP) will cause it to close any open logs (and re-open them if necessary).
+
+= Configuration =
+
+|| *Option name* || *Description* ||
+|| message_logging_dir || The directory to save message logs in. Default is to create a 'message_logs' subdirectory inside the data directory. ||
+
+= Compatibility =
+
+|| 0.9 || Works ||
\ No newline at end of file