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

---
rockspec:
  build:
    copy_directories:
    - templates
  dependencies:
  - mod_http_libjs
summary: JSXC demo
---

Try out JSXC easily by serving it from Prosodys built-in HTTP server.

Uses [mod_http_libjs] to serve jQuery, on Debian you can `apt install
libjs-jquery`.

# Configuration

mod_jsxc can be set up to either use resources from a separate HTTP
server or serve resources from Prosody's built-in HTTP server.

## Using CDN

`jsxc_cdn`
:   String. Base URL where JSXC resources are served from. Defaults to
    empty string.

`jsxc_version`
:   String. Concatenated with the CDN URL. Defaults to empty string.

## Local resources

Download a JSXC release archive and unpack it somewhere on your server.

`jsxc_resources`
:   String. Path to the `dist` directory containing JSXC resources on
the local file system. Disabled by default.

## Other options

`jquery_url`
:   String. URL or relative path to jQuery. Defaults to
    `"/share/jquery/jquery.min.js"` which will work with
    [mod_http_libjs].