prosody-modules
d194d1012fd3
mod_muc_notifications/README.markdown
Software / code / prosody-modules
File
mod_muc_notifications/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 3498:69219097aa85 |
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`)
