The following files are used to configure MongooseIM:
mongooseim.tomlfor MongooseIM settings,
vm.argsto affect the Erlang VM behaviour (performance tuning, node name),
app.configto change low-level logging parameters and settings of other Erlang applications.
This TOML file contains the configuration options for the MongooseIM server. It is located at
[MongooseIM repo root]/rel/files/ if you are building from source or
[MongooseIM install root]/etc/ if you are using a pre-built version.
The file is divided into the following sections:
- general - Served XMPP domains, log level, server language and some other miscellaneous settings.
- listen - Configured listeners, receiving incoming XMPP and HTTP connections.
- auth - Supported client authentication methods and their options.
- internal_databases - Options for Mnesia and CETS. They are primarily used for clustering.
- outgoing_pools - Outgoing connections to external services, including databases, message queues and HTTP services.
- services - Internal services like an administration API and system metrics.
- modules - XMPP extension modules, which extend the basic functionality provided by XMPP.
- shaper - Traffic shapers that limit the incoming XMPP traffic, providing a safety valve to protect the server.
- acl - Access classes to which connecting users are assigned.
- access - Access rules, specifying the privileges of the defined access classes.
- s2s - Server-to-server connection options, used for XMPP federation.
- host_config - Configuration options for different XMPP domains or host types (groups of domains).
The section names above are links to the detailed documentation of each section.
It is recommended to use the same configuration file for all nodes in the cluster, but there is no protection against using different option values for each node, because it can happen in two cases:
- During a rolling upgrade procedure, when nodes are restarted one by one with new configuration.
- When you need different network-specific parameters (e.g. listening IP addresses) for each node.
This file contains parameters passed directly to the Erlang VM. To configure it, go to
Let's explore the default options.
-sname- Erlang node name. Can be changed to
name, if necessary
-setcookie- Erlang cookie. All nodes in a cluster must use the same cookie value.
+K- Enables kernel polling. It improves the stability when a large number of sockets is opened, but some systems might benefit from disabling it. Might be a subject of individual load testing.
+A 5- Sets the asynchronous threads number. Async threads improve I/O operations efficiency by relieving scheduler threads of IO waits.
+P 10000000- Process count limit. This is a maximum allowed number of processes running per node. In general, it should exceed the tripled estimated online user count.
-env ERL_MAX_PORTS 250000- Open port count. This is a maximum allowed number of ports opened per node. In general, it should exceed the tripled estimated online user count. Keep in mind that increasing this number also increases the memory usage by a constant amount, so finding the right balance for it is important for every project.
-env ERL_FULLSWEEP_AFTER 2- affects garbage collection. Reduces memory consumption (forces often full g.c.) at the expense of CPU usage.
-sasl sasl_error_logger false- MongooseIM's solution for logging is Lager, so SASL error logger is disabled.
A file with Erlang application configuration. To configure it, go to
By default only the following applications can be found there:
logger- check Logger's documentation for more information.
session_lifetime(default specified in the file:
600seconds) - This parameter says for how long should the ssl session remain in the cache for further re-use, should
ssl session resumptionhappen.
Configuring TLS: Certificates & Keys
TLS is configured in one of two ways: some modules need a private key and certificate (chain) in separate files, while others need both in a single file. This is because recent additions use OTP's
ssl library, while older modules use
- Client-to-server connections need both in the same
- Server-to-server connections need both in the same
- BOSH, WebSockets and REST APIs need them in separate files
In order to create private key & certificate bundle, you may simply concatenate them.
More information about configuring TLS for these endpoints is available in the listen section configuration page.