view mod_muc_notifications/README.markdown @ 4491:35381608d323

mod_s2s_auth_dane: Fix traceback in DANE-TA check because unpack() moved It moved into the table package in Lua 5.2, error happens when compat is disabled or gone (ie 5.3+). This happened in DANE-TA, which is disabled by default.
author Kim Alvefur <zash@zash.se>
date Wed, 03 Mar 2021 11:51:39 +0100
parents 69219097aa85
children
line wrap: on
line source

---
labels:
- 'Stage-alpha'
summary: 'Notify of MUC messages to not present members'
...

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

This module listens to MUC messages and sends a notification to the
MUC members not present in the MUC at that moment.

By default, the notification will be a message with a simple text as body.

By sending this "out-of-MUC" notification, not-joined members will be able to
know that new messages are available.

Usage
=====

First copy the module to the prosody plugins directory.

Then add "muc\_notifications" to your modules\_enabled list in your
MUC component:

```{.lua}
Component "conference.example.org" "muc"
modules_enabled = {
	"muc_notifications",
}
```

You may also want to enable "offline\_hints" module so the notification messages
sent by this module are not added to the offline storage for later delivery.

Configuration
=============

  Option                      Description
  --------------------------- ----------------------------------------------------------------------------------------------
  muc\_notification\_invite   If set to `true`, the notification sent will take the form of a MUC invite. (default: `false`)