Mercurial > prosody-modules

comparison mod_muc_notifications/README.md @ 5975:fe081789f7b5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parents mod_muc_notifications/README.markdown@69219097aa85
children
comparison
equal deleted inserted replaced
5974:5a65a632d5b9 5975:fe081789f7b5
1 ---
2 labels:
3 - 'Stage-alpha'
4 summary: 'Notify of MUC messages to not present members'
5 ...
6
7 Introduction
8 ============
9
10 This module listens to MUC messages and sends a notification to the
11 MUC members not present in the MUC at that moment.
12
13 By default, the notification will be a message with a simple text as body.
14
15 By sending this "out-of-MUC" notification, not-joined members will be able to
16 know that new messages are available.
17
18 Usage
19 =====
20
21 First copy the module to the prosody plugins directory.
22
23 Then add "muc\_notifications" to your modules\_enabled list in your
24 MUC component:
25
26 ```{.lua}
27 Component "conference.example.org" "muc"
28 modules_enabled = {
29 "muc_notifications",
30 }
31 ```
32
33 You may also want to enable "offline\_hints" module so the notification messages
34 sent by this module are not added to the offline storage for later delivery.
35
36 Configuration
37 =============
38
39 Option Description
40 --------------------------- ----------------------------------------------------------------------------------------------
41 muc\_notification\_invite If set to `true`, the notification sent will take the form of a MUC invite. (default: `false`)