Diff

mod_message_logging/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
parent 1782:29f3d6b7ad16
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_message_logging/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,34 @@
+---
+labels:
+- 'Stage-Beta'
+summary: 'Log/archive all user messages'
+...
+
+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
+  ----- -------