Mercurial > prosody-modules

view mod_message_logging/README.markdown @ 1865:db8b256f51ff

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_admin_web,mod_carbons,mod_csi_compat,mod_mam_muc,mod_tcpproxy: Explicitly return true
author Kim Alvefur <zash@zash.se>
date Mon, 21 Sep 2015 20:03:08 +0200
parents 4d73a1a6ba68
children
line wrap: on
line source

---
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
  ----- -------