File: README.md

package info (click to toggle)
ejabberd-contrib 0.2025.01.11~dfsg0-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 3,680 kB
  • sloc: erlang: 11,870; sh: 150; sql: 92; makefile: 56
file content (45 lines) | stat: -rw-r--r-- 1,128 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
mod_message_log - Log one line per message transmission
=======================================================

* Author: Holger Weiss <holger@zedat.fu-berlin.de>


Description
-----------

This module writes a line for each sent or received message to a log file.
Each line mentions the sender's JID and the recipient's JID, and also the
message type (e.g., `"normal"`, `"chat"`, or `"groupchat"`).  Carbon copies are
marked as such.  The log lines look similar to this one:

```
2014-05-25 11:55:04 [outgoing, normal] dan@example.com/Foo -> eve@example.net/Bar
```

After log rotation, you can execute the following command in order to tell
`mod_message_log` to reopen the log file:

```
ejabberdctl reopen_log
```


Configuration
-------------

- `filename`

  Define the filename and path to store the log.
  If the filename option is set to `auto`, it will be set to
  the default ejabberd log path, with the file name `"message.log"`.
  The filename option takes as default value `auto`.


Example Configuration
---------------------

```yaml
modules:
  mod_message_log:
    filename: "/path/to/ejabberd-message.log"
```