Mercurial > prosody-modules
diff mod_message_logging/README.md @ 5975:fe081789f7b5
All community modules: Unify file extention of Markdown files to .md
| author | Menel <menel@snikket.de> |
|---|---|
| date | Tue, 22 Oct 2024 10:26:01 +0200 |
| parents | mod_message_logging/README.markdown@4d73a1a6ba68 |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_message_logging/README.md Tue Oct 22 10:26:01 2024 +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 + ----- -------
