ejabberd Jabber/XMPP server control interface

ejabberdctl [--node node] command [options]

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

node Specifies remote erlang node to connect to. Default value is ejabberd@`hostname -s`.

The command can be any one of the following options:

status

Requests status of the ejabberd server.

stop

Stops the ejabberd server.

restart

Restarts the ejabberd server.

reopen-log

Force the ejabberd server to reopen its log file.

register user server password

Register user user with password password at ejabberd virtual host server.

unregister user server

Unregister user user at ejabberd virtual host server.

backup filepath

Backup user database of the ejabberd server to file filepath.

restore filepath

Restore user database of the ejabberd server from backup file filepath.

install-fallback filepath

Install a backup to filepath as fallback. The fallback will be used to restore the database at the next start-up.

dump filepath

Dump user database of the ejabberd server to text file filepath.

load filepath

Restore user database of the ejabberd server from text file filepath.

import-file filepath

Import user data from jabberd 1.4 spool file filepath. For example, if filepath is .../example.org/user.xml then imported username will be user and it will be imported to virtual server example.org.

import-dir directorypath

Import user data from jabberd 1.4 spool directory directorypath. Directory name should be the name of virtual server to import users.

registered-users

List all registered at the ejabberd server users (at all virtual hosts).

erl(1), ejabberd(8), mnesia(3).

The program documentation is available at http://www.process-one.net/en/projects/ejabberd/. A copy of the documentation can be found at /usr/share/doc/ejabberd/html/guide.html.

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

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.