diff mod_debug_omemo/README.markdown @ 4682:e4e5474420e6

mod_debug_omemo: OMEMO debugging tool
author Matthew Wild <mwild1@gmail.com>
date Mon, 13 Sep 2021 19:24:13 +0100
parents
children ffddf9b29463
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_debug_omemo/README.markdown	Mon Sep 13 19:24:13 2021 +0100
@@ -0,0 +1,33 @@
+---
+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
+  ----- -------