Software / code / prosody-modules
Annotate
mod_muc_mention_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 | 4314:149ec3abf09e |
| rev | line source |
|---|---|
|
4280
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
1 # Configuring |
|
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
2 |
|
4314
149ec3abf09e
mod_muc_mention_notifications: Add description in readme
JC Brand <jc@opkode.com>
parents:
4307
diff
changeset
|
3 This module lets Prosody notify users when they're mentioned in a MUC, even if they're not currently present in it. |
|
149ec3abf09e
mod_muc_mention_notifications: Add description in readme
JC Brand <jc@opkode.com>
parents:
4307
diff
changeset
|
4 |
|
149ec3abf09e
mod_muc_mention_notifications: Add description in readme
JC Brand <jc@opkode.com>
parents:
4307
diff
changeset
|
5 Users need to be explicitly mentioned via XEP-0372 references. |
|
149ec3abf09e
mod_muc_mention_notifications: Add description in readme
JC Brand <jc@opkode.com>
parents:
4307
diff
changeset
|
6 |
|
149ec3abf09e
mod_muc_mention_notifications: Add description in readme
JC Brand <jc@opkode.com>
parents:
4307
diff
changeset
|
7 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. |
|
149ec3abf09e
mod_muc_mention_notifications: Add description in readme
JC Brand <jc@opkode.com>
parents:
4307
diff
changeset
|
8 |
|
149ec3abf09e
mod_muc_mention_notifications: Add description in readme
JC Brand <jc@opkode.com>
parents:
4307
diff
changeset
|
9 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). |
|
149ec3abf09e
mod_muc_mention_notifications: Add description in readme
JC Brand <jc@opkode.com>
parents:
4307
diff
changeset
|
10 |
|
4280
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
11 ## Enabling |
|
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
12 |
|
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
13 ``` {.lua} |
|
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
14 Component "rooms.example.net" "muc" |
|
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
15 modules_enabled = { |
|
4307
af7297e49885
muc_mention_notifications: Rename module
JC Brand <jc@opkode.com>
parents:
4280
diff
changeset
|
16 "muc_mention_notifications"; |
|
4280
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
17 } |
|
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
18 ``` |
|
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
19 |
|
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
20 ## Settings |
|
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
21 |
|
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
22 |Name |Description |Default | |
|
278f2998ce49
mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff
changeset
|
23 |-----|------------|--------| |
|
4307
af7297e49885
muc_mention_notifications: Rename module
JC Brand <jc@opkode.com>
parents:
4280
diff
changeset
|
24 |muc_mmn_notify_unaffiliated_users| Notify mentioned users even if they are not members of the room they were mentioned in | false | |
