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

Copyright of the assets included in the assets/ folder:

generic.svg:

	(C) Matthew Wild 2020
	Distributed under the MIT license of the prosody-modules project.
	Derived from the XMPP logo of the XMPP Standards Foundation:
	Source: https://en.wikipedia.org/wiki/XMPP#/media/File:XMPP_logo.svg
	License (MIT): https://opensource.org/licenses/mit-license.php

gajim.svg:

	Source: https://dev.gajim.org/gajim/gajim/-/blob/master/gajim/data/icons/hicolor/scalable/apps/org.gajim.Gajim.svg
	License (GPLv3): https://dev.gajim.org/gajim/gajim/-/blob/master/COPYING

dino.svg:

	Source: https://github.com/dino/dino/blob/3a00177a51e48d6bafc1e67bab26bc510e6400d8/main/data/icons/im.dino.Dino.svg
	License (GPLv3): https://github.com/dino/dino/blob/3a00177a51e48d6bafc1e67bab26bc510e6400d8/LICENSE

conversations.svg:

	Source: https://github.com/iNPUTmice/Conversations/blob/master/art/ic_launcher.svg
	License (CC-BY-SA 4.0): https://github.com/iNPUTmice/Conversations/blob/master/art/LICENSE

siskin-im.png:

	Source: https://github.com/tigase/siskin-im/blob/master/SiskinIM%20-%20Share/Assets.xcassets/AppIcon.appiconset/IMG_1607_3-120.png
	License (GPLv3): https://github.com/tigase/siskin-im/blob/master/COPYING

beagle-im.png:

	Source: https://github.com/tigase/beagle-im/blob/master/BeagleIM/Assets.xcassets/AppIcon.appiconset/IMG_0720_256-1.png
	License (GPLv3): https://github.com/tigase/beagle-im/blob/master/LICENSE

yaxim.svg:

	Source: https://github.com/yaxim-org/yaxim/blob/master/asset-graphics/yak/yak-front-grass.svg
	License (GPLv3): https://github.com/yaxim-org/yaxim/blob/master/LICENSE.txt