Mercurial > prosody-modules

comparison mod_unified_push/README.md @ 5157:9032143bad08

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_unified_push: Update docs to recommend loading on normal hosts
author Matthew Wild <mwild1@gmail.com>
date Sat, 14 Jan 2023 18:31:38 +0000
parents a8df4d2447d0
children
comparison
equal deleted inserted replaced
5156:a8df4d2447d0 5157:9032143bad08
76 76
77 This module exposes a HTTP endpoint (to receive push notifications from app 77 This module exposes a HTTP endpoint (to receive push notifications from app
78 servers). For more information on configuring HTTP services in Prosody, see 78 servers). For more information on configuring HTTP services in Prosody, see
79 [Prosody HTTP documentation](https://prosody.im/doc/http). 79 [Prosody HTTP documentation](https://prosody.im/doc/http).
80 80
81 ### Example configuration 81 #### Example configuration
82
83 ##### Normal method
84
85 Just add just add `"unified_push"` to your `modules_enabled` option.
86 This is the easiest and **recommended** configuration.
87
88 ``` {.lua}
89 modules_enabled = {
90 ---
91 "unified_push";
92 ---
93 }
94 ```
95
96 ##### Component method
97
98 This is an example of how to configure the module as an internal component,
99 e.g. on a subdomain or other non-user domain.
82 100
83 This example creates a push notification component called 101 This example creates a push notification component called
84 'notify.example.com'. 102 'notify.example.com'.
85 103
86 The 'http_host' line instructs Prosody to expose this module's HTTP services 104 The 'http_host' line instructs Prosody to expose this module's HTTP services