ejabberdctl - control interface for the ejabberd Jabber/XMPP server
] [--node nodename
is a front end to the ejabberd Jabber/XMPP server. It is
designed to help the administrator control the functioning of the running
This command must be run either by a superuser or by the user ejabberd
otherwise it will fail to start or to connect to the ejabberd instance. Using
sudo also works.
To get a list of available commands for the given ejabberd node, simply run
without any command.
Of course the given ejabberd node needs to be up and running for this to
does not do anything by itself except for connecting to the
running ejabberd instance and telling it about the action requested by the
user. Hence all the ejabberdctl
's operations involving writing or
reading files or directories are actually performed by the server process
which runs with the uid and gid of the user and group "ejabberd".
This must be taken into account when requesting such operations to be done.
- Use specified string as Erlang node of ejabberd
server to connect. It overrides default ejabberd node name. The
string may take one of the following forms: nodename,
nodename@hostname or email@example.com.
- Use the specified range of ports to communicate with the
other Erlang nodes (namely, with the target Erlang node running ejabberd).
This can be useful when the system running the target node has restricted
firewall setup allowing only a certain range of ports to be used by the
Erlang nodes for communication; in this case, you should specify that
range of ports in the FIREWALL_WINDOW setting.
- Default settings for ejabberdctl which is also run by
systemd / the init script
- Configuration directory
- Main configuration file
- Logfile directory
- Database spool directory
The program documentation is available at
This manual page was adapted by Sergei Golovan <firstname.lastname@example.org> for the
system (but may be used by others) from the ejabberd
documentation written by Alexey Shchepin <email@example.com>. Updated by
Konstantin Khomoutov <firstname.lastname@example.org> and Philipp
Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU General Public License, Version 2 any later version published
by the Free Software Foundation.
On Debian systems, the complete text of the GNU General Public License can be
found in /usr/share/common-licenses/GPL-2.