prosody-modules
7b093a9b95ea
mod_muc_archive/README.md

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

Software / code / prosody-modules

File

mod_muc_archive/README.md @ 6043:7b093a9b95ea

mod_report_forward: Fix traceback on error message passed to datetime function If archive:get() returns an error, e.g. because it can't find a message with the given ID, it may return e.g. nil, "item-not-found" or similar where the error condition ends up in reported_message_time, which gets passed to util.datetime, which thus ends up doing math to a string or error object.
author Kim Alvefur <zash@zash.se>
date Wed, 06 Nov 2024 22:25:41 +0100
parent 6003:fe081789f7b5
line wrap: on
line source

---
labels:
- 'Stage-Beta'
summary: Log MUC messages to disk
...

# Introduction

This module logs the conversations of chatrooms running on the server to Prosody's data store.

This is a fork of [mod_muc_log](https://modules.prosody.im/mod_muc_log.html) which uses the newer storage API.
This allows you to also log messages to a SQL backend.

## Changes between mod_muc_archive and mod_muc_log:

- Use newer module storage API so that you can also store in SQL
- Adhere to config option `muc_log_all_rooms` (also used by mod_muc_mam)
- Add affiliation information in the logged stanza
- Remove code that set (and then removed) an "alreadyJoined" dummy element

NOTE: The changes are unlikely to be entirely backwards compatible because the stanza
being logged is no longer wrapped with `<stanza time=...>`.

Details
=======

mod\_muc\_archive 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\_archive to it like so:

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


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

  ------ -----
  0.11   Works
  ------ -----