prosody-modules
ecfd7aece33b
mod_push2/README.markdown
Software / code / prosody-modules
File
mod_push2/README.markdown @ 5691:ecfd7aece33b
mod_measure_modules: Report module statuses via OpenMetrics
Someone in the chat asked about a health check endpoint, which reminded
me of mod_http_status, which provides access to module statuses with
full details. After that, this idea came about, which seems natural.
As noted in the README, it could be used to monitor that critical
modules are in fact loaded correctly.
As more modules use the status API, the more useful this module and
mod_http_status becomes.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 06 Oct 2023 18:34:39 +0200 |
| parent | 5687:4b052598e435 |
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 ------ -----------------------------------------------------------------------------
