prosody-modules
d872a1cd8c1d
mod_muc_notifications/README.markdown
Software / code / prosody-modules
File
mod_muc_notifications/README.markdown @ 5389:d872a1cd8c1d
mod_http_oauth2: Specify that 'contacts' items are emails in client registration
Not enforced, but good for documentation.
> Array of strings representing ways to contact people responsible for
> this client, typically email addresses.
"typically" isn't a great word in a specification, so one could persume
this may be e.g. URLs like https://example.com/contact-us or so as well.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sun, 30 Apr 2023 15:20:05 +0200 |
| 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`)
