Skip to content

Commit 5e2b2b7

Browse files
committed
Explain install-rel and man page
1 parent cf37347 commit 5e2b2b7

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

content/admin/install/source.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,7 @@ make help
183183
There are several ways to install and run ejabberd after it's compiled from source code:
184184
185185
- [system install](#system-install)
186+
- [system install a release](#system-install-release)
186187
- building a [production](#production-release) release
187188
- building a [development](#production-release) release
188189
- don't install at all, just [start](#start) with `make relive`
@@ -230,6 +231,26 @@ The created files and directories depend on the options provided to [`./configur
230231
- `ejabberd.log`: ejabberd service log
231232
- `erlang.log`: Erlang/OTP system log
232233

234+
### System Install Release
235+
236+
<!-- md:version added in [24.02](../../archive/24.02/index.md) -->
237+
238+
This builds a [production release](#production-release),
239+
and then performs a [system install](#system-install) of that release,
240+
obtaining a result similar to the one mentioned in the previous section.
241+
242+
Simply run:
243+
244+
``` sh
245+
make install-rel
246+
```
247+
248+
The benefits of `install-rel` over `install`:
249+
250+
- this uses OTP release code from rebar/rebar3/mix, and consequently requires less code in our `Makefile.in` file
251+
- `uninstall-rel` correctly deletes all the library files
252+
- the `*.beam` files are smaller as debug information is stripped
253+
233254
### Production Release
234255

235256
<!-- md:version improved in [21.07](../../archive/21.07/index.md) -->
@@ -340,6 +361,19 @@ make
340361

341362
Check also the guide for [Installing ejabberd development environment on OSX](../../developer/install-osx.md)
342363

364+
### man
365+
366+
ejabberd includes a man page which documents the toplevel and modules options,
367+
the same information that is published in the
368+
[Top-Level Options](../../configuration/toplevel.md) and
369+
[Modules Options](../../configuration/modules.md) sections.
370+
371+
The man file can be read locally with:
372+
373+
``` sh
374+
man -l man/ejabberd.yml.5
375+
```
376+
343377
### rebar with old Erlang
344378

345379
The ejabberd source code package includes `rebar` and `rebar3` binaries

0 commit comments

Comments
 (0)