Skip to content

Commit c7d5a6f

Browse files
committed
README: Document default configuration and default port numbers
1 parent 559d8d6 commit c7d5a6f

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ To use an ejabberd module coming from this repository:
2828
- Run `ejabberdctl module_uninstall <module>` to remove a module from
2929
ejabberd.
3030

31-
3231
For developers
3332
--------------
3433

@@ -68,6 +67,28 @@ The following organization has been set up for the development:
6867
function pre_uninstall/0 in the main one listing the other ones.
6968
See mod_statsdx as an example.
7069

70+
Default configuration
71+
---------------------
72+
73+
Some modules include default configuration files like `conf/MODULE.yml`,
74+
this way the module is enabled automatically and you don't need to setup anything else.
75+
76+
But maybe that default configuration does not suit your needs and you prefer to
77+
configure the module yourself in your `ejabberd.yml` configuration file.
78+
In that case, remove all the lines in the corresponding `conf/MODULE.yml` file,
79+
and then you can configure manually in your `ejabberd.yml` file.
80+
81+
Please notice: if you remove the file `conf/MODULE.yml` completely,
82+
ejabberd may copy the default one again when you upgrade the module in the future.
83+
84+
Some modules with default configuration listen in specific port numbers:
85+
- 5282: mod_muc_log_http
86+
- 5283: mod_unified_push
87+
- 5284: mod_webpresence
88+
- 5285: mod_rest
89+
- 5286: mod_http_redirect (not enabled by default)
90+
- 5289: mod_prometheus
91+
- 8080: atom_pubsub
7192

7293
Broken modules
7394
--------------

0 commit comments

Comments
 (0)