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

---
labels:
- 'Stage-Alpha'
summary: Adds support for flash socket policy
...

Introduction
============

This Prosody plugin adds support for flash socket policies. When
connecting with a flash client (from a webpage, not an exe) to prosody
the flash client requests for an xml "file" on port 584 or the
connecting port (5222 in the case of default xmpp). Responding on port
584 is tricky because it requires root priviliges to set up a socket on
a port \< 1024.

This plugins filters the incoming data from the flash client. So when
the client connects with prosody it immediately sends a xml request
string (`<policy-file-request/>\0`). Prosody responds with a flash
cross-domain-policy. See
http://www.adobe.com/devnet/flashplayer/articles/socket\_policy\_files.html
for more information.

Usage
=====

Add "flash\_policy" to your modules\_enabled list.

Configuration
=============

  --------------------- --------------------------------------------------------------------------------
  crossdomain\_file     Optional. The path to a file containing an cross-domain-policy in xml format.
  crossdomain\_string   Optional. A cross-domain-policy as string. Should include the xml declaration.
  --------------------- --------------------------------------------------------------------------------

Both configuration options are optional. If both are not specified a
cross-domain-policy with "`<allow-access-from domain="*" />`" is used as
default.

Compatibility
=============

  ----- -------
  0.7   Works
  ----- -------

Caveats/Todos/Bugs
==================

-   The assumption is made that the first packet received will always
    contain the policy request data, and all of it. This isn't robust
    against fragmentation, but on the other hand I highly doubt you'll
    be seeing that with such a small packet.
-   Only tested by me on a single server :)