NAME

       ejabberdctl - control interface for the ejabberd Jabber/XMPP server

SYNOPSIS

       ejabberdctl [--no-timeout] [--node nodename] [--version api_version] command [options]

DESCRIPTION

       ejabberdctl  is a front end to the ejabberd Jabber/XMPP server.  It is designed to help the administrator
       control the functioning of the running ejabberd daemon.

       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.

COMMANDS

       To  get  a  list  of  available  commands for the given ejabberd node, simply run ejabberdctl without any
       command.

       Of course the given ejabberd node needs to be up and running for this to succeed.

NOTES

       ejabberdctl 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.

OPTIONS FILE

       ERLANG_NODE
              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
              nodename@hostname.domainname.

       FIREWALL_WINDOW
              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.

FILES

       /etc/default/ejabberd
              Default settings for ejabberdctl which is also run by systemd / the init script

       /etc/ejabberd
              Configuration directory

       /etc/ejabberd/ejabberd.yml
              Main configuration file

       /var/log/ejabberd
              Logfile directory

       /var/lib/ejabberd
              Database spool directory

SEE ALSO

       erl(1), mnesia(3).

       The program documentation is available at http://www.process-one.net/en/projects/ejabberd/.

AUTHORS

       This manual page was adapted by Sergei Golovan <sgolovan@nes.ru> for the Debian system (but may  be  used
       by  others)  from  the ejabberd documentation written by Alexey Shchepin <alexey@sevcom.net>.  Updated by
       Konstantin Khomoutov <flatworm@users.sourceforge.net> and Philipp Huebner <debalance@debian.org>.

       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.