File

mod_muc_log/README.md @ 6207:a1a33f0f6f6e

mod_http_oauth2: Reorder HTTP handler (noop) More in the order they might be used, related paths together.
author Kim Alvefur <zash@zash.se>
date Sun, 16 Mar 2025 21:56:25 +0100
parent 6197:ba8f5cdc1676
line wrap: on
line source

---
labels:
- 'Stage-Obsolete'
summary: Log chatroom messages to disk
...

::: {.alert .alert-danger}
This module was an early and obsolete way to record group chat logs.

For a modern approach, use [mod_muc_mam][doc:modules:mod_muc_mam].

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].
:::

Introduction
============

This module logs the conversation of chatrooms running on the server to
Prosody's data store. To view them you will need a module such as
[mod\_muc\_log\_http](mod_muc_log_http.html).

Details
=======

mod\_muc\_log must be loaded individually for the components that need
it. Assuming you have a MUC component already running on
conference.example.org then you can add muc\_log to it like so:

    Component "conference.example.org" "muc"
       modules_enabled = {
          "muc_log";
       }

Logging is not enabled by default. In 0.9+ logging can be enabled per
room in the room config form.

To enable logging in older versions, or to enable logging by default for
all rooms, set

    muc_log_by_default = true -- Log all rooms by default

Compatibility
=============

Does **not** work with currently supported versions of Prosody.