Mercurial > prosody-modules
annotate mod_muc_cloud_notify/README.markdown @ 5818:d3b69859553a
mod_password_policy: Change error type from 'cancel' to 'modify'
This makes more sense, as the problem relates to the data that has been
entered, and therefore the request could be retried with different data.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Mon, 08 Jan 2024 17:28:39 +0000 |
| parents | 6317a5d8ce2d |
| children |
| rev | line source |
|---|---|
| 3319 | 1 --- |
| 2 labels: | |
| 3 - 'Stage-Alpha' | |
| 4 summary: 'XEP-XXX: Cloud push notifications for MUC' | |
| 5 --- | |
| 6 | |
| 7 # Introduction | |
| 8 | |
| 9 This is an experimental fork of [mod_cloud_notify](https://modules.prosody.im/mod_cloud_notify.html) | |
| 10 which allows a [XEP-0357 Push Notifications App Servers](https://xmpp.org/extensions/xep-0357.html#general-architecture) | |
| 11 to be registered against a MUC domain (normally they're only registered against | |
| 12 your own chat server's domain). | |
| 13 | |
| 14 The goal here is to also enable push notifications also for MUCs. | |
| 15 | |
| 16 In contrast to mod_cloud_notify, this module does NOT integrate with | |
| 17 mod_smacks, because a MUC can't access a remote user's XEP-0198 queue. | |
| 18 | |
| 19 Configuration | |
| 20 ============= | |
| 21 | |
| 22 Option Default Description | |
| 23 ------------------------------------ ----------------- ------------------------------------------------------------------------------------------------------------------- | |
| 24 `push_notification_with_body` `false` Whether or not to send the message body to remote pubsub node. | |
| 25 `push_notification_with_sender` `false` Whether or not to send the message sender to remote pubsub node. | |
| 26 `push_max_errors` `16` How much persistent push errors are tolerated before notifications for the identifier in question are disabled | |
| 27 `push_notification_important_body` `New Message!` The body text to use when the stanza is important (see above), no message body is sent if this is empty | |
| 28 `push_max_devices` `5` The number of allowed devices per user (the oldest devices are automatically removed if this threshold is reached) | |
| 29 | |
| 30 There are privacy implications for enabling these options because | |
| 31 plaintext content and metadata will be shared with centralized servers | |
| 32 (the pubsub node) run by arbitrary app developers. | |
| 33 | |
| 34 ## To test this module: | |
| 35 | |
| 36 The [Converse](http://conversejs.org/) client has support for registering push | |
| 37 "app servers" against a MUC. | |
| 38 | |
|
3330
426447d8f82e
Mention auto_register_muc_nickname setting from Converse
JC Brand <jc@opkode.com>
parents:
3319
diff
changeset
|
39 You specify app servers with the [push_app_servers](https://conversejs.org/docs/html/configuration.html#push-app-servers) |
| 3319 | 40 config setting. |
| 41 | |
|
3375
6317a5d8ce2d
mod_muc_cloud_notify: README updates
JC Brand <jc@opkode.com>
parents:
3330
diff
changeset
|
42 And then you need to set [enable_muc_push](https://conversejs.org/docs/html/configuration.html#enable-muc-push) |
| 3319 | 43 to `true` so that these app servers are also registered against MUC domains. |
| 44 | |
|
3330
426447d8f82e
Mention auto_register_muc_nickname setting from Converse
JC Brand <jc@opkode.com>
parents:
3319
diff
changeset
|
45 Additionally you need to set [auto_register_muc_nickname](https://conversejs.org/docs/html/configuration.html#auto-register-muc-nickname) |
|
426447d8f82e
Mention auto_register_muc_nickname setting from Converse
JC Brand <jc@opkode.com>
parents:
3319
diff
changeset
|
46 to true. |
|
426447d8f82e
Mention auto_register_muc_nickname setting from Converse
JC Brand <jc@opkode.com>
parents:
3319
diff
changeset
|
47 |
|
3375
6317a5d8ce2d
mod_muc_cloud_notify: README updates
JC Brand <jc@opkode.com>
parents:
3330
diff
changeset
|
48 Then, when you enter a MUC, Converse will try to automatically register your nickname |
|
6317a5d8ce2d
mod_muc_cloud_notify: README updates
JC Brand <jc@opkode.com>
parents:
3330
diff
changeset
|
49 on that MUC. |
| 3319 | 50 |
|
3375
6317a5d8ce2d
mod_muc_cloud_notify: README updates
JC Brand <jc@opkode.com>
parents:
3330
diff
changeset
|
51 Note: Converse currently doesn't let you register separate app servers for |
| 3319 | 52 a MUC domain. The same app servers are registered for the MUC domain and your |
| 53 own domain. | |
| 54 | |
| 55 ## To be done: | |
| 56 | |
| 57 We currently don't handle "ghost connections", users who are currently offline | |
| 58 but the XMPP server is not yet aware of this and shows considers them online in | |
| 59 the MUC. | |
| 60 | |
| 61 Prosody already checks for error bounces from undelivered groupchat messages | |
| 62 and then kicks the particular user from the room. | |
| 63 | |
| 64 So these ghost connection users eventually get kicked from the room. | |
| 65 | |
| 66 We now need a module that fires an event when a groupchat messages can't be | |
| 67 delivered to an occupant. The module can look up the undelivered message in MAM | |
| 68 and include it in the event. | |
| 69 | |
| 70 In mod_muc_cloud_notify we can then listen for this event and send out a push | |
| 71 notification. |