Mercurial > prosody-modules

changeset 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 ca7feb293d55
files mod_unified_push/README.md
diffstat 1 files changed, 19 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/mod_unified_push/README.md	Sat Jan 14 17:59:40 2023 +0000
+++ b/mod_unified_push/README.md	Sat Jan 14 18:31:38 2023 +0000
@@ -78,7 +78,25 @@
 servers). For more information on configuring HTTP services in Prosody, see
 [Prosody HTTP documentation](https://prosody.im/doc/http).
 
-### Example configuration
+#### Example configuration
+
+##### Normal method
+
+Just add just add `"unified_push"` to your `modules_enabled` option.
+This is the easiest and **recommended** configuration.
+
+``` {.lua}
+  modules_enabled = {
+    ---
+    "unified_push";
+    ---
+  }
+```
+
+##### Component method
+
+This is an example of how to configure the module as an internal component,
+e.g. on a subdomain or other non-user domain.
 
 This example creates a push notification component called
 'notify.example.com'.