Skip to content

Commit 559d8d6

Browse files
committed
mod_unified_push: Update README about default configuration
1 parent b658b2c commit 559d8d6

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

mod_unified_push/README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
- Copyright (C) 2025 itd
55

66
This module adds Unified Push support compatible with Conversations.
7+
When the module is enabled, the server can be added as a Unified Push distributor
8+
in the settings of Conversations, using the same domain used for the JID.
79

810
ejabberd newer than 25.04 is required,
911
as it requires an updated version of the
@@ -12,23 +14,31 @@ that includes the improvements from the file `xmpp_spec.patch`.
1214
Or you can
1315
[apply the patch yourself](https://github.com/processone/xmpp/issues/9#issue-205855303)
1416

17+
1518
## Configuration
1619

17-
To use this module, load `mod_unified_push` in the `modules` section of the config file and add `/up: mod_unified_push` to a listen directive:
20+
When you install this module, it's enabled by default on port 5283, see `conf/mod_unified_push.yml`
21+
22+
If you want to customize that configuration,
23+
remove all lines in the file `mod_unified_push.yml` (don't remove the file itself),
24+
and now you can configure the module in your main `ejabberd.yml` configuration file,
25+
for example:
1826

1927
```
28+
listen:
2029
-
2130
port: 5443
2231
ip: "::"
2332
module: ejabberd_http
2433
tls: true
25-
protocol_options: 'TLS_OPTIONS'
2634
request_handlers:
2735
/api: mod_http_api
2836
/bosh: mod_bosh
37+
/up: mod_unified_push
2938
/upload: mod_http_upload
3039
/ws: ejabberd_http_ws
31-
/up: mod_unified_push
32-
```
3340
34-
Once the config has been reloaded, the server can be added as a Unified Push distributor in the settings of Conversations, using the same domain used for the JID.
41+
modules:
42+
mod_unified_push: {}
43+
...
44+
```

0 commit comments

Comments
 (0)