Diff

mod_cloud_notify_encrypted/README.md @ 4327:beb3342f1137

mod_cloud_notify_encrypted: New module for Encrypted Push Notifications
author Matthew Wild <mwild1@gmail.com>
date Tue, 12 Jan 2021 15:43:26 +0000
child 4711:46ca47a12770
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_cloud_notify_encrypted/README.md	Tue Jan 12 15:43:26 2021 +0000
@@ -0,0 +1,26 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: 'Support for encrypted payloads in push notifications'
+...
+
+Introduction
+============
+
+This module implements support for a [Encrypted Push Notifications](https://xeps.tigase.net//docs/push-notifications/encrypt/),
+a custom extension to [XEP-0357: Push Notifications](https://xmpp.org/extensions/xep-0357.html).
+
+It is planned that this will evolve to a XEP in the near future.
+
+Details
+=======
+
+Add to modules_enabled, there are no configuration options.
+
+Depends on luaossl which is available in Debian as `lua-luaossl` or via
+`luarocks install luaossl`.
+
+Compatibility
+=============
+
+Not tested, but hopefully works on 0.11.x and later.