prosody-modules
06fbbd45ba75
mod_cloud_notify/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_cloud_notify/README.md @ 6302:06fbbd45ba75

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
author Menel <menel@snikket.de>
date Fri, 13 Jun 2025 10:44:37 +0200
parent 6301:fa45ae704b79
child 6303:d73cae8d80ce
comparison
equal deleted inserted replaced
6301:fa45ae704b79 6302:06fbbd45ba75
1 ----
2 -labels:
3 -- 'Stage-Beta'
4 -summary: 'XEP-0357: Cloud push notifications'
5 ----
6
1 # Introduction 7 # Introduction
2 8
3 This module enables support for sending "push notifications" to clients 9 This module enables support for sending "push notifications" to clients
4 that need it, typically those running on certain mobile devices. 10 that need it, typically those running on certain mobile devices.
5 11
30 then connect to your device's OS vendor and ask them to forward the 36 then connect to your device's OS vendor and ask them to forward the
31 notification to your device. When your device receives the notification, 37 notification to your device. When your device receives the notification,
32 it will display it or wake up the app so it can connect to XMPP and 38 it will display it or wake up the app so it can connect to XMPP and
33 receive any pending messages. 39 receive any pending messages.
34 40
35 This protocol is described for developers in \[XEP-0357: Push 41 This protocol is described for developers in [XEP-0357: Push
36 Notifications\]. 42 Notifications].
37 43
38 For this module to work reliably, you must have \[mod_smacks\], 44 For this module to work reliably, you must have [mod_smacks],
39 \[mod_mam\] and \[mod_carbons\] also enabled on your server. 45 [mod_mam] and [mod_carbons] also enabled on your server.
40 46
41 Some clients, notably Siskin and Snikket iOS need some additional 47 Some clients, notably Siskin and Snikket iOS need some additional
42 extensions that are not currently defined in a standard XEP. To support 48 extensions that are not currently defined in a standard XEP. To support
43 these clients, see \[mod_cloud_notify_extensions\]. 49 these clients, see [mod_cloud_notify_extensions].
44 50
45 # Configuration 51 # Configuration
46 52
47 Option Default Description 53 Option Default Description
48 -------------------------------------- ---------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 54 -------------------------------------- ---------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
56 (\*) There are privacy implications for enabling these options.[^1] 62 (\*) There are privacy implications for enabling these options.[^1]
57 63
58 # Internal design notes 64 # Internal design notes
59 65
60 App servers are notified about offline messages, messages stored by 66 App servers are notified about offline messages, messages stored by
61 \[mod_mam\] or messages waiting in the smacks queue. The business rules 67 [mod_mam] or messages waiting in the smacks queue. The business rules
62 outlined 68 outlined
63 [here](//mail.jabber.org/pipermail/standards/2016-February/030925.html) 69 [here](//mail.jabber.org/pipermail/standards/2016-February/030925.html)
64 are all honored[^2]. 70 are all honored[^2].
65 71
66 To cooperate with \[mod_smacks\] this module consumes some events: 72 To cooperate with [mod_smacks] this module consumes some events:
67 `smacks-ack-delayed`, `smacks-hibernation-start` and 73 `smacks-ack-delayed`, `smacks-hibernation-start` and
68 `smacks-hibernation-end`. These events allow this module to send out 74 `smacks-hibernation-end`. These events allow this module to send out
69 notifications for messages received while the session is hibernated by 75 notifications for messages received while the session is hibernated by
70 \[mod_smacks\] or even when smacks acknowledgements for messages are 76 [mod_smacks] or even when smacks acknowledgements for messages are
71 delayed by a certain amount of seconds configurable with the 77 delayed by a certain amount of seconds configurable with the
72 \[mod_smacks\] setting `smacks_max_ack_delay`. 78 [mod_smacks] setting `smacks_max_ack_delay`.
73 79
74 The `smacks_max_ack_delay` setting allows to send out notifications to 80 The `smacks_max_ack_delay` setting allows to send out notifications to
75 clients which aren't already in smacks hibernation state (because the 81 clients which aren't already in smacks hibernation state (because the
76 read timeout or connection close didn't already happen) but also aren't 82 read timeout or connection close didn't already happen) but also aren't
77 responding to acknowledgement request in a timely manner. This setting 83 responding to acknowledgement request in a timely manner. This setting