File

mod_cloud_notify: Readme: fix links and labels that were removed in the last commit diff --git a/mod_cloud_notify/README.md b/mod_cloud_notify/README.md --- a/mod_cloud_notify/README.md +++ b/mod_cloud_notify/README.md @@ -1,3 +1,9 @@ +---- +-labels: +-- 'Stage-Beta' +-summary: 'XEP-0357: Cloud push notifications' +---- + # Introduction This module enables support for sending "push notifications" to clients @@ -32,15 +38,15 @@ notification to your device. When your d it will display it or wake up the app so it can connect to XMPP and receive any pending messages. -This protocol is described for developers in \[XEP-0357: Push -Notifications\]. +This protocol is described for developers in [XEP-0357: Push +Notifications]. -For this module to work reliably, you must have \[mod_smacks\], -\[mod_mam\] and \[mod_carbons\] also enabled on your server. +For this module to work reliably, you must have [mod_smacks], +[mod_mam] and [mod_carbons] also enabled on your server. Some clients, notably Siskin and Snikket iOS need some additional extensions that are not currently defined in a standard XEP. To support -these clients, see \[mod_cloud_notify_extensions\]. +these clients, see [mod_cloud_notify_extensions]. # Configuration @@ -58,18 +64,18 @@ these clients, see \[mod_cloud_notify_ex # Internal design notes App servers are notified about offline messages, messages stored by -\[mod_mam\] or messages waiting in the smacks queue. The business rules +[mod_mam] or messages waiting in the smacks queue. The business rules outlined [here](//mail.jabber.org/pipermail/standards/2016-February/030925.html) are all honored[^2]. -To cooperate with \[mod_smacks\] this module consumes some events: +To cooperate with [mod_smacks] this module consumes some events: `smacks-ack-delayed`, `smacks-hibernation-start` and `smacks-hibernation-end`. These events allow this module to send out notifications for messages received while the session is hibernated by -\[mod_smacks\] or even when smacks acknowledgements for messages are +[mod_smacks] or even when smacks acknowledgements for messages are delayed by a certain amount of seconds configurable with the -\[mod_smacks\] setting `smacks_max_ack_delay`. +[mod_smacks] setting `smacks_max_ack_delay`. The `smacks_max_ack_delay` setting allows to send out notifications to clients which aren't already in smacks hibernation state (because the

# Account based MUC joining

Normally when joining a MUC groupchat, it is each individual client that
joins. This means their presence in the group is tied to the session,
which can be short-lived or unstable, especially in the case of mobile
clients.

This has a few problems. For one, for every message to the groupchat, a
copy is sent to each joined client. This means that at the account
level, each message would pass by once for each client that is joined,
making it difficult to archive these messages in the users personal
archive.

A potentially better approach would be that the user account itself is
the entity that joins the groupchat. Since the account is an entity that
lives in the server itself, and the server tends to be online on a good
connection most of the time, this may improve the experience and
simplify some problems.

This is one of the essential changes in the MIX architecture, which is
being designed to replace MUC.

`mod_minimix` is an experiment meant to determine if things can be
improved without replacing the entire MUC standard. It works by
pretending to each client that nothing is different and that they are
joining MUCs directly, but behind the scenes, it arranges it such that
only the account itself joins each groupchat. Which sessions have joined
which groups are kept track of. Groupchat messages are then forked to
those sessions, similar to how normal chat messages work.

## Known issues

-   You can never leave.
-   You will never see anyone leave.
-   Being kicked is not handled.

## Unknown issues

-   Probably many.

## TODO

-   Integrate with bookmarks
-   tracking outgoing presence
-   leaving rooms
-   nickname management
-   bookmark sync

# Compatibility

Briefly tested with Prosody trunk (as of this writing).