Skip to content

Commit efc48b1

Browse files
committed
Improve documentation of install_contrib_modules (processone/ejabberd#4487)
1 parent 0e46a94 commit efc48b1

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

content/admin/configuration/toplevel.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ acme:
176176
`true | false`
177177

178178
Whether to allow installation of third-party modules or not. See
179-
[ejabberd-contrib](../../admin/guide/modules.md#ejabberd-contrib)
179+
[ejabberd-modules](../../admin/guide/modules.md#ejabberd-modules)
180180
documentation section. The default value is `true`.
181181

182182
## allow\_multiple\_connections
@@ -838,9 +838,20 @@ format, the `Options` must be one of the following:
838838

839839
<!-- md:version added in [23.10](../../archive/23.10/index.md) -->
840840

841-
Modules to install from
842-
[ejabberd-contrib](../../admin/guide/modules.md#ejabberd-contrib) at
843-
start time. The default value is an empty list of modules: `[]`.
841+
Modules from
842+
[ejabberd-modules](../../admin/guide/modules.md#ejabberd-modules) to
843+
install automatically at start time. The default value is an empty list
844+
of modules: `[]`.
845+
846+
**Example**:
847+
848+
~~~ yaml
849+
install_contrib_modules:
850+
- mod_tombstones
851+
852+
modules:
853+
mod_tombstones: {}
854+
~~~
844855

845856
## jwt\_auth\_only\_rule
846857

content/admin/guide/modules.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ Once you have placed the modules source code in `ejabberd-modules`, you can:
5454
- [list modules](#list-modules)
5555
- [install a module](#install-module)
5656
- [uninstall a module](#uninstall-module), or upgrade it
57+
- configure [install_contrib_modules](../configuration/toplevel.md#install_contrib_modules)
58+
toplevel option so ejabberd installs the module automatically at start time
5759

5860
## List Modules
5961

0 commit comments

Comments
 (0)