mod_cloud_notify_extensions/README.markdown
author Ben Smith <bens@effortlessis.com>
Tue, 14 May 2024 07:31:34 -0700
changeset 5912 dcea4b4c415d
parent 5547 fed5995180c5
permissions -rw-r--r--
Tweaking documentation to clarify that Oauth2 can be used for VirtualHosts and Component installations.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4709
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     1
---
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     2
summary: "Tigase custom push extensions for iOS"
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     3
labels:
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     4
- 'Stage-Beta'
4712
25fd5e268f90 mod_cloud_notify_extensions: Add depends metadata for plugin installer
Kim Alvefur <zash@zash.se>
parents: 4709
diff changeset
     5
rockspec:
25fd5e268f90 mod_cloud_notify_extensions: Add depends metadata for plugin installer
Kim Alvefur <zash@zash.se>
parents: 4709
diff changeset
     6
  dependencies:
25fd5e268f90 mod_cloud_notify_extensions: Add depends metadata for plugin installer
Kim Alvefur <zash@zash.se>
parents: 4709
diff changeset
     7
	- mod_cloud_notify_encrypted
25fd5e268f90 mod_cloud_notify_extensions: Add depends metadata for plugin installer
Kim Alvefur <zash@zash.se>
parents: 4709
diff changeset
     8
	- mod_cloud_notify_priority_tag
25fd5e268f90 mod_cloud_notify_extensions: Add depends metadata for plugin installer
Kim Alvefur <zash@zash.se>
parents: 4709
diff changeset
     9
	- mod_cloud_notify_filters
4709
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    10
...
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    11
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    12
Introduction
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    13
============
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    14
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    15
This is a meta-module that simply enables all the modules required to support
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    16
Siskin or Snikket iOS on a Prosody server.
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    17
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    18
These are currently:
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    19
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    20
- mod_cloud_notify_encrypted
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    21
- mod_cloud_notify_priority_tag
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    22
- mod_cloud_notify_filters
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    23
5063
5f1120c284c5 mod_cloud_notify_extensions: Add note about dependency
Matthew Wild <mwild1@gmail.com>
parents: 4712
diff changeset
    24
See the individual module pages for more details. In particular,
5f1120c284c5 mod_cloud_notify_extensions: Add note about dependency
Matthew Wild <mwild1@gmail.com>
parents: 4712
diff changeset
    25
mod_cloud_notify_encrypted depends on
5f1120c284c5 mod_cloud_notify_extensions: Add note about dependency
Matthew Wild <mwild1@gmail.com>
parents: 4712
diff changeset
    26
[luaossl](http://25thandclement.com/~william/projects/luaossl.html), which
5f1120c284c5 mod_cloud_notify_extensions: Add note about dependency
Matthew Wild <mwild1@gmail.com>
parents: 4712
diff changeset
    27
must be installed. It is available in Debian via apt as
5f1120c284c5 mod_cloud_notify_extensions: Add note about dependency
Matthew Wild <mwild1@gmail.com>
parents: 4712
diff changeset
    28
[`lua-luaossl`](https://tracker.debian.org/pkg/lua-luaossl) or via
5f1120c284c5 mod_cloud_notify_extensions: Add note about dependency
Matthew Wild <mwild1@gmail.com>
parents: 4712
diff changeset
    29
`luarocks install luaossl`.
4709
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    30
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    31
Note: On MUC services you should also load mod_muc_offline_delivery directly
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    32
under the MUC component in your config file, that is not handled by this
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    33
module.
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    34
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    35
Configuration
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    36
=============
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    37
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    38
There is no configuration for this module, just add it to
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    39
modules\_enabled as normal.
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    40
5547
fed5995180c5 mod_cloud_notify_extensions: Fix Markdown syntax of Compatibility table
Kim Alvefur <zash@zash.se>
parents: 5063
diff changeset
    41
# Compatibility
4709
ace4f251a64b mod_cloud_notify_extensions: Convenience meta-module for Tigase push extensions
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    42
5547
fed5995180c5 mod_cloud_notify_extensions: Fix Markdown syntax of Compatibility table
Kim Alvefur <zash@zash.se>
parents: 5063
diff changeset
    43
  ------- -------------
fed5995180c5 mod_cloud_notify_extensions: Fix Markdown syntax of Compatibility table
Kim Alvefur <zash@zash.se>
parents: 5063
diff changeset
    44
  0.12    Works
fed5995180c5 mod_cloud_notify_extensions: Fix Markdown syntax of Compatibility table
Kim Alvefur <zash@zash.se>
parents: 5063
diff changeset
    45
  0.11    Should work
fed5995180c5 mod_cloud_notify_extensions: Fix Markdown syntax of Compatibility table
Kim Alvefur <zash@zash.se>
parents: 5063
diff changeset
    46
  trunk   Works
fed5995180c5 mod_cloud_notify_extensions: Fix Markdown syntax of Compatibility table
Kim Alvefur <zash@zash.se>
parents: 5063
diff changeset
    47
  ------- -------------