Mercurial > prosody-modules
view mod_push2/README.markdown @ 5907:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parents | 4b052598e435 |
| children |
line wrap: on
line source
--- labels: - Stage-Alpha summary: 'Push 2.0' --- The way forward for push notifications? You are probably looking for `mod_cloud_notify` for now though See also https://hg.prosody.im/prosody-modules/file/tip/mod_push2/push2.markdown Configuration ============= Option Default Description ------------------------------------ ----------------- ------------------------------------------------------------------------------------------------------------------- `contact_uri` xmpp:server.tld Contact information for the server operator (usually as a `mailto:` URI is preferred) `push_max_hibernation_timeout` `259200` (72h) Number of seconds to extend the smacks timeout if no push was triggered yet (default: 72 hours) Internal design notes ===================== App servers are notified about offline messages, messages stored by [mod_mam] or messages waiting in the smacks queue. 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 delayed by a certain amount of seconds configurable with the [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 read timeout or connection close didn't already happen) but also aren't responding to acknowledgement request in a timely manner. This setting thus allows conversations to be smoother under such circumstances. Compatibility ============= **Note:** This module should be used with Lua 5.3 and higher. Requires a slightly patches luaossl right now: https://github.com/wahern/luaossl/pull/214 ------ ----------------------------------------------------------------------------- trunk Works ------ -----------------------------------------------------------------------------