2007-10-17 04:33:19 +02:00
|
|
|
#
|
2009-04-22 15:45:57 +02:00
|
|
|
# In this file you can configure options that are passed by ejabberdctl
|
2007-12-02 22:13:25 +01:00
|
|
|
# to the erlang runtime system when starting ejabberd
|
|
|
|
#
|
2007-10-17 04:33:19 +02:00
|
|
|
|
2009-04-22 15:45:57 +02:00
|
|
|
#' POLL: Kernel polling ([true|false])
|
2007-10-17 04:33:19 +02:00
|
|
|
#
|
2007-12-02 22:13:25 +01:00
|
|
|
# The kernel polling option requires support in the kernel.
|
2009-04-22 15:45:57 +02:00
|
|
|
# Additionally, you need to enable this feature while compiling Erlang.
|
2007-10-17 04:33:19 +02:00
|
|
|
#
|
2008-01-01 11:53:05 +01:00
|
|
|
# Default: true
|
2007-12-02 22:13:25 +01:00
|
|
|
#
|
2008-01-01 11:53:05 +01:00
|
|
|
#POLL=true
|
2007-10-17 04:33:19 +02:00
|
|
|
|
2009-04-22 15:45:57 +02:00
|
|
|
#.
|
|
|
|
#' ERL_MAX_PORTS: Maximum number of simultaneously open Erlang ports
|
2007-12-02 22:13:25 +01:00
|
|
|
#
|
2009-04-22 15:45:57 +02:00
|
|
|
# ejabberd consumes two or three ports for every connection, either
|
2021-01-11 20:18:28 +01:00
|
|
|
# from a client or from another XMPP server. So take this into
|
2007-12-06 22:42:47 +01:00
|
|
|
# account when setting this limit.
|
2007-12-02 22:13:25 +01:00
|
|
|
#
|
2018-06-23 19:01:21 +02:00
|
|
|
# Default: 65536 (or 8196 on Windows)
|
2007-12-02 22:13:25 +01:00
|
|
|
# Maximum: 268435456
|
|
|
|
#
|
2018-06-23 19:01:21 +02:00
|
|
|
#ERL_MAX_PORTS=65536
|
2007-10-17 04:33:19 +02:00
|
|
|
|
2009-04-22 15:45:57 +02:00
|
|
|
#.
|
|
|
|
#' FIREWALL_WINDOW: Range of allowed ports to pass through a firewall
|
2008-04-01 11:07:29 +02:00
|
|
|
#
|
2021-01-11 20:18:28 +01:00
|
|
|
# If ejabberd is configured to run in cluster, and a firewall is blocking ports,
|
2009-04-22 15:45:57 +02:00
|
|
|
# it's possible to make Erlang use a defined range of port (instead of dynamic
|
|
|
|
# ports) for node communication.
|
2008-04-01 11:07:29 +02:00
|
|
|
#
|
|
|
|
# Default: not defined
|
|
|
|
# Example: 4200-4210
|
|
|
|
#
|
|
|
|
#FIREWALL_WINDOW=
|
|
|
|
|
2011-02-16 23:53:29 +01:00
|
|
|
#.
|
|
|
|
#' INET_DIST_INTERFACE: IP address where this Erlang node listens other nodes
|
|
|
|
#
|
|
|
|
# This communication is used by ejabberdctl command line tool,
|
|
|
|
# and in a cluster of several ejabberd nodes.
|
|
|
|
#
|
2014-07-22 14:35:31 +02:00
|
|
|
# Default: 0.0.0.0
|
2011-02-16 23:53:29 +01:00
|
|
|
#
|
2013-06-18 15:56:28 +02:00
|
|
|
#INET_DIST_INTERFACE=127.0.0.1
|
2011-02-16 23:53:29 +01:00
|
|
|
|
2011-05-31 12:26:44 +02:00
|
|
|
#.
|
2022-05-26 18:35:14 +02:00
|
|
|
#' ERL_DIST_PORT: Port number for Erlang distribution
|
|
|
|
#
|
|
|
|
# For Erlang distribution, clustering and ejabberdctl usage, the
|
|
|
|
# Erlang VM listens in a random TCP port number, and the Erlang Port
|
|
|
|
# Mapper Daemon (EPMD) is spawned and used to determine this port
|
|
|
|
# number.
|
|
|
|
#
|
|
|
|
# ERL_DIST_PORT can define this port number. In that case, EPMD is
|
|
|
|
# not spawned during ejabberd startup, and ERL_EPMD_ADDRESS is
|
|
|
|
# ignored. ERL_DIST_PORT must be set to the same port number during
|
|
|
|
# ejabberd startup and when calling ejabberdctl. This feature
|
|
|
|
# requires at least Erlang/OTP 23.1.
|
|
|
|
#
|
|
|
|
# Default: not defined
|
|
|
|
#
|
|
|
|
#ERL_DIST_PORT=5210
|
|
|
|
|
|
|
|
#.
|
|
|
|
#' ERL_EPMD_ADDRESS: IP addresses where EPMD listens for connections
|
2011-05-31 12:26:44 +02:00
|
|
|
#
|
|
|
|
# This environment variable may be set to a comma-separated
|
2022-05-26 18:35:14 +02:00
|
|
|
# list of IP addresses, in which case the EPMD daemon
|
2011-05-31 12:26:44 +02:00
|
|
|
# will listen only on the specified address(es) and on the
|
|
|
|
# loopback address (which is implicitly added to the list if it
|
|
|
|
# has not been specified). The default behaviour is to listen on
|
|
|
|
# all available IP addresses.
|
|
|
|
#
|
|
|
|
# Default: 0.0.0.0
|
|
|
|
#
|
|
|
|
#ERL_EPMD_ADDRESS=127.0.0.1
|
|
|
|
|
2009-04-22 15:45:57 +02:00
|
|
|
#.
|
2010-02-03 16:04:56 +01:00
|
|
|
#' ERL_PROCESSES: Maximum number of Erlang processes
|
2007-10-17 04:33:19 +02:00
|
|
|
#
|
|
|
|
# Erlang consumes a lot of lightweight processes. If there is a lot of activity
|
2009-04-22 15:45:57 +02:00
|
|
|
# on ejabberd so that the maximum number of processes is reached, people will
|
2011-03-17 12:15:31 +01:00
|
|
|
# experience greater latency times. As these processes are implemented in
|
2007-10-17 04:33:19 +02:00
|
|
|
# Erlang, and therefore not related to the operating system processes, you do
|
|
|
|
# not have to worry about allowing a huge number of them.
|
|
|
|
#
|
2018-06-23 19:01:21 +02:00
|
|
|
# Default: 262144
|
2007-12-02 22:13:25 +01:00
|
|
|
# Maximum: 268435456
|
|
|
|
#
|
2018-06-23 19:01:21 +02:00
|
|
|
#ERL_PROCESSES=262144
|
2007-10-17 04:33:19 +02:00
|
|
|
|
2009-04-22 15:45:57 +02:00
|
|
|
#.
|
|
|
|
#' ERL_MAX_ETS_TABLES: Maximum number of ETS and Mnesia tables
|
2007-10-17 04:33:19 +02:00
|
|
|
#
|
|
|
|
# The number of concurrent ETS and Mnesia tables is limited. When the limit is
|
|
|
|
# reached, errors will appear in the logs:
|
2007-12-02 22:13:25 +01:00
|
|
|
# ** Too many db tables **
|
2007-10-17 04:33:19 +02:00
|
|
|
# You can safely increase this limit when starting ejabberd. It impacts memory
|
|
|
|
# consumption but the difference will be quite small.
|
2007-12-02 22:13:25 +01:00
|
|
|
#
|
2018-06-23 19:01:21 +02:00
|
|
|
# Default: 2053
|
2007-12-02 22:13:25 +01:00
|
|
|
#
|
2018-06-23 19:01:21 +02:00
|
|
|
#ERL_MAX_ETS_TABLES=2053
|
2007-10-17 04:33:19 +02:00
|
|
|
|
2009-04-22 15:45:57 +02:00
|
|
|
#.
|
2009-05-16 00:10:53 +02:00
|
|
|
#' ERL_OPTIONS: Additional Erlang options
|
|
|
|
#
|
2023-07-18 15:31:10 +02:00
|
|
|
# The next variable allows to specify additional options passed to
|
2023-11-15 14:16:53 +01:00
|
|
|
# all commands using erlang interpreter. This applies to starting
|
|
|
|
# ejabberd server itself but also auxiliary commands like for example
|
|
|
|
# starting debug shell. See erl(1) for list of commands that can be
|
|
|
|
# used here.
|
2009-05-16 00:10:53 +02:00
|
|
|
#
|
|
|
|
# It might be useful to add "-pa /usr/local/lib/ejabberd/ebin" if you
|
|
|
|
# want to add local modules in this path.
|
|
|
|
#
|
|
|
|
# Default: ""
|
|
|
|
#
|
|
|
|
#ERL_OPTIONS=""
|
|
|
|
|
2023-07-18 15:31:10 +02:00
|
|
|
#.
|
|
|
|
#' EJABBERD_OPTS: Additional Erlang options to start ejabberd
|
|
|
|
#
|
|
|
|
# The next variable allows to specify additional options passed to erlang while
|
|
|
|
# starting ejabberd. Some useful options are -noshell, -detached, -heart. When
|
|
|
|
# ejabberd is started from an init.d script options -noshell and -detached are
|
|
|
|
# added implicitly. See erl(1) for more info.
|
|
|
|
#
|
2023-11-15 14:16:53 +01:00
|
|
|
# For example you can use value "-heart -env HEART_BEAT_TIMEOUT 120 -env ERL_CRASH_DUMP_SECONDS 60"
|
|
|
|
#
|
2023-07-18 15:31:10 +02:00
|
|
|
# Default: ""
|
|
|
|
#
|
|
|
|
#EJABBERD_OPTS=""
|
|
|
|
|
2009-05-16 00:10:53 +02:00
|
|
|
#.
|
|
|
|
#' ERLANG_NODE: Erlang node name
|
|
|
|
#
|
2007-10-17 04:33:19 +02:00
|
|
|
# The next variable allows to explicitly specify erlang node for ejabberd
|
|
|
|
# It can be given in different formats:
|
|
|
|
# ERLANG_NODE=ejabberd
|
2007-12-02 22:13:25 +01:00
|
|
|
# Lets erlang add hostname to the node (ejabberd uses short name in this case)
|
2007-10-17 04:33:19 +02:00
|
|
|
# ERLANG_NODE=ejabberd@hostname
|
2007-12-02 22:13:25 +01:00
|
|
|
# Erlang uses node name as is (so make sure that hostname is a real
|
|
|
|
# machine hostname or you'll not be able to control ejabberd)
|
2007-10-17 04:33:19 +02:00
|
|
|
# ERLANG_NODE=ejabberd@hostname.domainname
|
2009-04-22 15:45:57 +02:00
|
|
|
# The same as previous, but erlang will use long hostname
|
2007-12-02 22:13:25 +01:00
|
|
|
# (see erl (1) manual for details)
|
2007-10-17 04:33:19 +02:00
|
|
|
#
|
2011-06-28 00:31:13 +02:00
|
|
|
# Default: ejabberd@localhost
|
2008-01-01 11:53:05 +01:00
|
|
|
#
|
2011-06-28 00:31:13 +02:00
|
|
|
#ERLANG_NODE=ejabberd@localhost
|
2009-04-22 15:45:57 +02:00
|
|
|
|
2009-08-24 23:21:04 +02:00
|
|
|
#.
|
|
|
|
#' EJABBERD_PID_PATH: ejabberd PID file
|
|
|
|
#
|
|
|
|
# Indicate the full path to the ejabberd Process identifier (PID) file.
|
|
|
|
# If this variable is defined, ejabberd writes the PID file when starts,
|
|
|
|
# and deletes it when stops.
|
|
|
|
# Remember to create the directory and grant write permission to ejabberd.
|
|
|
|
#
|
|
|
|
# Default: don't write PID file
|
|
|
|
#
|
|
|
|
#EJABBERD_PID_PATH=/var/run/ejabberd/ejabberd.pid
|
|
|
|
|
2015-02-10 00:15:06 +01:00
|
|
|
#.
|
|
|
|
#' EJABBERD_CONFIG_PATH: ejabberd configuration file
|
|
|
|
#
|
|
|
|
# Specify the full path to the ejabberd configuration file. If the file name has
|
2015-03-04 17:18:57 +01:00
|
|
|
# yml or yaml extension, it is parsed as a YAML file; otherwise, Erlang syntax is
|
2015-02-10 00:15:06 +01:00
|
|
|
# expected.
|
|
|
|
#
|
|
|
|
# Default: $ETC_DIR/ejabberd.yml
|
|
|
|
#
|
|
|
|
#EJABBERD_CONFIG_PATH=/etc/ejabberd/ejabberd.yml
|
|
|
|
|
2015-03-11 14:14:28 +01:00
|
|
|
#.
|
|
|
|
#' CONTRIB_MODULES_PATH: contributed ejabberd modules path
|
|
|
|
#
|
|
|
|
# Specify the full path to the contributed ejabberd modules. If the path is not
|
|
|
|
# defined, ejabberd will use ~/.ejabberd-modules in home of user running ejabberd.
|
|
|
|
#
|
|
|
|
# Default: $HOME/.ejabberd-modules
|
|
|
|
#
|
|
|
|
#CONTRIB_MODULES_PATH=/opt/ejabberd-modules
|
|
|
|
|
2015-10-26 22:46:58 +01:00
|
|
|
#.
|
|
|
|
#' CONTRIB_MODULES_CONF_DIR: configuration directory for contributed modules
|
|
|
|
#
|
|
|
|
# Specify the full path to the configuration directory for contributed ejabberd
|
|
|
|
# modules. In order to configure a module named mod_foo, a mod_foo.yml file can
|
|
|
|
# be created in this directory. This file will then be used instead of the
|
|
|
|
# default configuration file provided with the module.
|
|
|
|
#
|
|
|
|
# Default: $CONTRIB_MODULES_PATH/conf
|
|
|
|
#
|
|
|
|
#CONTRIB_MODULES_CONF_DIR=/etc/ejabberd/modules
|
|
|
|
|
2009-05-16 00:10:53 +02:00
|
|
|
#.
|
|
|
|
#'
|
2009-04-22 15:45:57 +02:00
|
|
|
# vim: foldmarker=#',#. foldmethod=marker:
|