Mercurial > prosody-modules
view mod_muc_mention_notifications/README.markdown @ 5907: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 |
parents | 149ec3abf09e |
children |
line wrap: on
line source
# Configuring This module lets Prosody notify users when they're mentioned in a MUC, even if they're not currently present in it. Users need to be explicitly mentioned via XEP-0372 references. In anonymous and semi-anonymous rooms, the mentioned user needs to have their nickname registered in the MUC so that Prosody can get the real JID from the referenced nickname. NOTE: this module is not compatible with mod_block_strangers because the latter will block the notification messages from the MUC (since they're not "groupchat" messages). ## Enabling ``` {.lua} Component "rooms.example.net" "muc" modules_enabled = { "muc_mention_notifications"; } ``` ## Settings |Name |Description |Default | |-----|------------|--------| |muc_mmn_notify_unaffiliated_users| Notify mentioned users even if they are not members of the room they were mentioned in | false |