prosody-modules
7cc0f68b8715
mod_unified_push/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_unified_push/README.md @ 5128:7cc0f68b8715

mod_unified_push: Experimenal Unified Push provider
author Matthew Wild <mwild1@gmail.com>
date Thu, 05 Jan 2023 17:28:06 +0000
child 5138:4511e90d1d08
comparison
equal deleted inserted replaced
5127:be859bfdd44e 5128:7cc0f68b8715
1 ---
2 labels:
3 - Stage-Alpha
4 summary: "Unified Push provider"
5 ---
6
7 This module implements a [Unified Push](https://unifiedpush.org/) Provider
8 that uses XMPP to talk to a Push Distributor (e.g. [Conversations](http://codeberg.org/iNPUTmice/Conversations)).
9
10 For a server-independent external component, or details about the protocol,
11 see [the 'up' project](https://codeberg.org/inputmice/up).
12
13 This module and the protocol it implements is at an experimental prototype
14 stage.
15
16 Note that this module is **not related** to XEP-0357 push notifications for
17 XMPP. It does not send push notifications to disconnected XMPP clients. For
18 that, see [mod_cloud_notify](https://modules.prosody.im/mod_cloud_notify).
19
20 ## Configuration
21
22 | Name | Description | Default |
23 |-------------------------------|--------------------------------------------------------|-----------------------|
24 | unified_push_secret | A random secret string (32+ bytes), used for auth | |
25 | unified_push_registration_ttl | Maximum lifetime of a push registration (seconds) | `86400` (1 day) |
26
27 A random push secret can be generated with the command
28 `openssl rand -base64 32`. Changing the secret will invalidate all existing
29 push registrations.
30
31 ## Compatibility
32
33 Requires Prosody trunk (not compatible with 0.12).