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

---
summary: External Service Discovery
...

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

This module adds support for [XEP-0215: External Service Discovery],
which lets Prosody advertise non-XMPP services.

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

Example services from the XEP:

``` {.lua}
modules_enabled = {
    -- other modules ...
    "extdisco";
}

external_services = {
    ["stun.shakespeare.lit"] = {
        port="9998";
        transport="udp";
        type="stun";
    };
    ["relay.shakespeare.lit"] = {
        password="jj929jkj5sadjfj93v3n";
        port="9999";
        transport="udp";
        type="turn";
        username="nb78932lkjlskjfdb7g8";
    };
    ["192.0.2.1"] = {
        port="8888";
        transport="udp";
        type="stun";
    };
    ["192.0.2.1"] = {
        port="8889";
        password="93jn3bakj9s832lrjbbz";
        transport="udp";
        type="turn";
        username="auu98sjl2wk3e9fjdsl7";
    };
    ["ftp.shakespeare.lit"] = { 
        name="Shakespearean File Server";
        password="guest";
        port="20";
        transport="tcp";
        type="ftp";
        username="guest";
    };
}
```

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

Incompatible with
[mod_turncredentials](https://modules.prosody.im/mod_turncredentials).