mod_message_logging/README.markdown
changeset 1807 4d73a1a6ba68
parent 1786 29f3d6b7ad16
equal deleted inserted replaced
1806:0ab737feada6 1807:4d73a1a6ba68
       
     1 ---
       
     2 labels:
       
     3 - 'Stage-Beta'
       
     4 summary: 'Log/archive all user messages'
       
     5 ...
       
     6 
       
     7 Introduction
       
     8 ============
       
     9 
       
    10 Often service administrators need to log their users' messages for
       
    11 reasons such as auditing and compliance. This module simply logs user
       
    12 messages to simple text files, which can be easily searched, archived or
       
    13 removed on a regular basis.
       
    14 
       
    15 Usage
       
    16 =====
       
    17 
       
    18 Simply load the module and it will start logging. Reloading Prosody
       
    19 (e.g. with a SIGHUP) will cause it to close any open logs (and re-open
       
    20 them if necessary).
       
    21 
       
    22 Configuration
       
    23 =============
       
    24 
       
    25   Option name             Description
       
    26   ----------------------- -----------------------------------------------------------------------------------------------------------------------
       
    27   message\_logging\_dir   The directory to save message logs in. Default is to create a 'message\_logs' subdirectory inside the data directory.
       
    28 
       
    29 Compatibility
       
    30 =============
       
    31 
       
    32   ----- -------
       
    33   0.9   Works
       
    34   ----- -------