diff mod_cloud_notify_extensions/README.md @ 5975:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parents mod_cloud_notify_extensions/README.markdown@acd39d33170e
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_cloud_notify_extensions/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,47 @@
+---
+summary: "Tigase custom push extensions for iOS"
+labels:
+- 'Stage-Beta'
+rockspec:
+  dependencies:
+	- mod_cloud_notify_encrypted
+	- mod_cloud_notify_priority_tag
+	- mod_cloud_notify_filters
+...
+
+Introduction
+============
+
+This is a meta-module that simply enables all the modules required to support
+Siskin or Snikket iOS on a Prosody server.
+
+These are currently:
+
+- [mod_cloud_notify_encrypted]
+- [mod_cloud_notify_priority_tag]
+- [mod_cloud_notify_filters]
+
+See the individual module pages for more details. In particular,
+mod_cloud_notify_encrypted depends on
+[luaossl](http://25thandclement.com/~william/projects/luaossl.html), which
+must be installed. It is available in Debian via apt as
+[`lua-luaossl`](https://tracker.debian.org/pkg/lua-luaossl) or via
+`luarocks install luaossl`.
+
+Note: On MUC services you should also load mod_muc_offline_delivery directly
+under the MUC component in your config file, that is not handled by this
+module.
+
+Configuration
+=============
+
+There is no configuration for this module, just add it to
+modules\_enabled as normal.
+
+# Compatibility
+
+  ------- -------------
+  0.12    Works
+  0.11    Should work
+  trunk   Works
+  ------- -------------