How to build
To compile MongooseIM you need:
- GNU Make
- Libexpat 1.95 or higher
- Erlang/OTP 17.5 or higher
- Reltool 0.6.6 or higher
- OpenSSL 0.9.8 or higher, for STARTTLS, SASL and SSL encryption
- Zlib 1.2.3 or higher for Stream Compression support (XEP-0138). Optional.
Compiling on UNIX-like systems
To compile MongooseIM, go to the main repo directory
$REPO and execute the command (
$ stands for the shell prompt):
$ ./rebar3 compile
To generate full MongooseIM release (with mysql, pgsql or other deps):
$ make rel
If more advanced release is required (with some specific db support only, f.e. mysql or pgsql) or you want to set
user for the installation script please refer to the release configuration page in our documentation.
make rel commands will generate a self-contained OTP system image in the project's
The contents of that directory are as follows:
bin- startup/administration scripts,
etc- configuration files,
lib- MongooseIM binary, header and runtime files,
var- spool directory,
log- log file directory,
releases- release files directory.
To run MongooseIM from the project tree after compiling it, change to
There you can use the
mongooseim command line administration script to start and stop MongooseIM. For example, this command will start the server:
$ bin/mongooseim start
You can also run the server in interactive mode:
$ bin/mongooseim live
There's also a tool called
mongooseimctl allowing you to perform some operations on a running instance, e.g.:
$ bin/mongooseimctl status MongooseIM node mongooseim@localhost: operating system pid: 86026 Erlang VM status: started (of: starting | started | stopping) boot script status: started version: 1.6.2-61-g48b8332 uptime: 1:12:46 logs: log/ejabberd.log
Building the testing target and running tests
For testing purposes there's a different make target available:
$ make devrel
which will generate releases
$REPO/_build/ and prepare them for testing and generating coverage reports.
To run the tests (from project's root directory, i.e.