prosody-modules
fe081789f7b5
mod_push2/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_push2/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 5687:mod_push2/README.markdown@4b052598e435
child 6033:8cb37a497e4c
comparison
equal deleted inserted replaced
6002:5a65a632d5b9 6003:fe081789f7b5
1 ---
2 labels:
3 - Stage-Alpha
4 summary: 'Push 2.0'
5 ---
6
7 The way forward for push notifications? You are probably looking for
8 `mod_cloud_notify` for now though
9
10 See also https://hg.prosody.im/prosody-modules/file/tip/mod_push2/push2.markdown
11
12 Configuration
13 =============
14
15 Option Default Description
16 ------------------------------------ ----------------- -------------------------------------------------------------------------------------------------------------------
17 `contact_uri` xmpp:server.tld Contact information for the server operator (usually as a `mailto:` URI is preferred)
18 `push_max_hibernation_timeout` `259200` (72h) Number of seconds to extend the smacks timeout if no push was triggered yet (default: 72 hours)
19
20 Internal design notes
21 =====================
22
23 App servers are notified about offline messages, messages stored by [mod_mam]
24 or messages waiting in the smacks queue.
25
26 To cooperate with [mod_smacks] this module consumes some events:
27 `smacks-ack-delayed`, `smacks-hibernation-start` and `smacks-hibernation-end`.
28 These events allow this module to send out notifications for messages received
29 while the session is hibernated by [mod_smacks] or even when smacks
30 acknowledgements for messages are delayed by a certain amount of seconds
31 configurable with the [mod_smacks] setting `smacks_max_ack_delay`.
32
33 The `smacks_max_ack_delay` setting allows to send out notifications to clients
34 which aren't already in smacks hibernation state (because the read timeout or
35 connection close didn't already happen) but also aren't responding to acknowledgement
36 request in a timely manner. This setting thus allows conversations to be smoother
37 under such circumstances.
38
39 Compatibility
40 =============
41
42 **Note:** This module should be used with Lua 5.3 and higher.
43
44 Requires a slightly patches luaossl right now: https://github.com/wahern/luaossl/pull/214
45
46 ------ -----------------------------------------------------------------------------
47 trunk Works
48 ------ -----------------------------------------------------------------------------