view mod_muc_log/README.md @ 6319:04c3273cb81f

mod_auth_cyrus: Add empty 'profile' table to SASL handler objects This is for compatibility with Prosody's built-in util.sasl objects. A SASL profile table usually includes methods supported by the backend, which can be used by SASL mechanism handlers to perform operations (such as testing the password). It also optionally contains a 'cb' field with channel binding method handlers. The Cyrus backend doesn't support channel binding, and doesn't have the same concept of auth backend methods (it handles all that internally, and Prosody has no insight or control over it). Thus, we create an empty profile which informs Prosody that the SASL handler does not support any of the auth or channel binding methods. Some features will not work, but they didn't work anyway. This just makes it explicit. This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to always contain a 'profile' field.
author Matthew Wild <mwild1@gmail.com>
date Thu, 04 Sep 2025 10:14:46 +0100
parents ba8f5cdc1676
children
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.