2 # In this file you can configure options that are passed by ejabberdctl
3 # to the erlang runtime system when starting ejabberd
6 #' POLL: Kernel polling ([true|false])
8 # The kernel polling option requires support in the kernel.
9 # Additionally, you need to enable this feature while compiling Erlang.
16 #' SMP: SMP support ([enable|auto|disable])
18 # Explanation in Erlang/OTP documentation:
19 # enable: starts the Erlang runtime system with SMP support enabled.
20 # This may fail if no runtime system with SMP support is available.
21 # auto: starts the Erlang runtime system with SMP support enabled if it
22 # is available and more than one logical processor are detected.
23 # disable: starts a runtime system without SMP support.
30 #' ERL_MAX_PORTS: Maximum number of simultaneously open Erlang ports
32 # ejabberd consumes two or three ports for every connection, either
33 # from a client or from another Jabber server. So take this into
34 # account when setting this limit.
42 #' FIREWALL_WINDOW: Range of allowed ports to pass through a firewall
44 # If Ejabberd is configured to run in cluster, and a firewall is blocking ports,
45 # it's possible to make Erlang use a defined range of port (instead of dynamic
46 # ports) for node communication.
48 # Default: not defined
54 #' INET_DIST_INTERFACE: IP address where this Erlang node listens other nodes
56 # This communication is used by ejabberdctl command line tool,
57 # and in a cluster of several ejabberd nodes.
61 #INET_DIST_INTERFACE=127.0.0.1
64 #' ERL_EPMD_ADDRESS: IP addresses where epmd listens for connections
66 # IMPORTANT: This option works only in Erlang/OTP R14B03 and newer.
68 # This environment variable may be set to a comma-separated
69 # list of IP addresses, in which case the epmd daemon
70 # will listen only on the specified address(es) and on the
71 # loopback address (which is implicitly added to the list if it
72 # has not been specified). The default behaviour is to listen on
73 # all available IP addresses.
77 #ERL_EPMD_ADDRESS=127.0.0.1
80 #' ERL_PROCESSES: Maximum number of Erlang processes
82 # Erlang consumes a lot of lightweight processes. If there is a lot of activity
83 # on ejabberd so that the maximum number of processes is reached, people will
84 # experience greater latency times. As these processes are implemented in
85 # Erlang, and therefore not related to the operating system processes, you do
86 # not have to worry about allowing a huge number of them.
94 #' ERL_MAX_ETS_TABLES: Maximum number of ETS and Mnesia tables
96 # The number of concurrent ETS and Mnesia tables is limited. When the limit is
97 # reached, errors will appear in the logs:
98 # ** Too many db tables **
99 # You can safely increase this limit when starting ejabberd. It impacts memory
100 # consumption but the difference will be quite small.
104 #ERL_MAX_ETS_TABLES=1400
107 #' ERL_OPTIONS: Additional Erlang options
109 # The next variable allows to specify additional options passed to erlang while
110 # starting ejabberd. Some useful options are -noshell, -detached, -heart. When
111 # ejabberd is started from an init.d script options -noshell and -detached are
112 # added implicitly. See erl(1) for more info.
114 # It might be useful to add "-pa /usr/local/lib/ejabberd/ebin" if you
115 # want to add local modules in this path.
122 #' ERLANG_NODE: Erlang node name
124 # The next variable allows to explicitly specify erlang node for ejabberd
125 # It can be given in different formats:
126 # ERLANG_NODE=ejabberd
127 # Lets erlang add hostname to the node (ejabberd uses short name in this case)
128 # ERLANG_NODE=ejabberd@hostname
129 # Erlang uses node name as is (so make sure that hostname is a real
130 # machine hostname or you'll not be able to control ejabberd)
131 # ERLANG_NODE=ejabberd@hostname.domainname
132 # The same as previous, but erlang will use long hostname
133 # (see erl (1) manual for details)
135 # Default: ejabberd@localhost
137 #ERLANG_NODE=ejabberd@localhost
140 #' EJABBERD_PID_PATH: ejabberd PID file
142 # Indicate the full path to the ejabberd Process identifier (PID) file.
143 # If this variable is defined, ejabberd writes the PID file when starts,
144 # and deletes it when stops.
145 # Remember to create the directory and grant write permission to ejabberd.
147 # Default: don't write PID file
149 #EJABBERD_PID_PATH=/var/run/ejabberd/ejabberd.pid
152 #' EJABBERD_CONFIG_PATH: ejabberd configuration file
154 # Specify the full path to the ejabberd configuration file. If the file name has
155 # yml or yaml extension, it is parsed as a YAML file; otherwise, Erlang syntax is
158 # Default: $ETC_DIR/ejabberd.yml
160 #EJABBERD_CONFIG_PATH=/etc/ejabberd/ejabberd.yml
163 #' CONTRIB_MODULES_PATH: contributed ejabberd modules path
165 # Specify the full path to the contributed ejabberd modules. If the path is not
166 # defined, ejabberd will use ~/.ejabberd-modules in home of user running ejabberd.
168 # Default: $HOME/.ejabberd-modules
170 #CONTRIB_MODULES_PATH=/opt/ejabberd-modules
173 #' CONTRIB_MODULES_CONF_DIR: configuration directory for contributed modules
175 # Specify the full path to the configuration directory for contributed ejabberd
176 # modules. In order to configure a module named mod_foo, a mod_foo.yml file can
177 # be created in this directory. This file will then be used instead of the
178 # default configuration file provided with the module.
180 # Default: $CONTRIB_MODULES_PATH/conf
182 #CONTRIB_MODULES_CONF_DIR=/etc/ejabberd/modules
186 # vim: foldmarker=#',#. foldmethod=marker: