prosody-modules
750d64c47ec6
mod_muc_log/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_muc_log/README.md @ 6211:750d64c47ec6 draft default tip

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:31:36 +0700
parent 6197:ba8f5cdc1676
comparison
equal deleted inserted replaced
6210:24316a399978 6211:750d64c47ec6
1 ---
2 labels:
3 - 'Stage-Obsolete'
4 summary: Log chatroom messages to disk
5 ...
6
7 ::: {.alert .alert-danger}
8 This module was an early and obsolete way to record group chat logs.
9
10 For a modern approach, use [mod_muc_mam][doc:modules:mod_muc_mam].
11
12 For converting legacy logs stored by this module, see [mod_storage_muc_log], it can be used with [mod_migrate] or [prosody-migrator][doc:migrator].
13 :::
14
15 Introduction
16 ============
17
18 This module logs the conversation of chatrooms running on the server to
19 Prosody's data store. To view them you will need a module such as
20 [mod\_muc\_log\_http](mod_muc_log_http.html).
21
22 Details
23 =======
24
25 mod\_muc\_log must be loaded individually for the components that need
26 it. Assuming you have a MUC component already running on
27 conference.example.org then you can add muc\_log to it like so:
28
29 Component "conference.example.org" "muc"
30 modules_enabled = {
31 "muc_log";
32 }
33
34 Logging is not enabled by default. In 0.9+ logging can be enabled per
35 room in the room config form.
36
37 To enable logging in older versions, or to enable logging by default for
38 all rooms, set
39
40 muc_log_by_default = true -- Log all rooms by default
41
42 Compatibility
43 =============
44
45 Does **not** work with currently supported versions of Prosody.