Mercurial > prosody-modules

view mod_debug_omemo/README.markdown @ 5668:ecfd7aece33b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
parents ffddf9b29463
children
line wrap: on
line source

---
summary: "Generate OMEMO debugging links"
labels:
- 'Stage-Alpha'
...

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

This module allows you to view advanced information about OMEMO-encrypted messages,
and can be helpful to diagnose decryption problems.

It generates a link to itself and adds this link to the plaintext contents of
encrypted messages. This will be shown by clients that do not support OMEMO,
or are unable to decrypt the message.

This module depends on a working HTTP setup in Prosody, and honours the [usual
HTTP configuration options](https://prosody.im/doc/http).

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

There is no configuration for this module, just add it to
modules\_enabled as normal.

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

  ----- -------
  0.11  Hopefully works
  trunk Works
  ----- -------