prosodyctl man page

prosodyctl — Manage a Prosody XMPP server


prosodyctl command [--help]


prosodyctl is the control tool for the Prosody XMPP server. It may be used to control the server daemon and manage users.

prosodyctl needs to be executed with sufficient privileges to perform its commands. This typically means executing prosodyctl as the root user. If a user named "prosody" is found then prosodyctl will change to that user before executing its commands.


User Management

In the following commands users are identified by a Jabber ID, jid, of the usual form: user@domain.

adduser jid
Adds a user with Jabber ID, jid, to the server. You will be prompted to enter the user's password.
passwd jid
Changes the password of an existing user with Jabber ID, jid. You will be prompted to enter the user's new password.
deluser jid
Deletes an existing user with Jabber ID, jid, from the server.

Daemon Management

Although prosodyctl has commands to manage the prosody daemon it is recommended that you utilize your distributions daemon management features if you attained Prosody through a package.

To perform daemon control commands prosodyctl needs a pidfile value specified in /etc/prosody/prosody.cfg.lua. Failure to do so will cause prosodyctl to complain.

Starts the prosody server daemon. If run as root prosodyctl will attempt to change to a user named "prosody" before executing. This operation will block for up to five seconds to wait for the server to execute.
Stops the prosody server daemon. This operation will block for up to five seconds to wait for the server to stop executing.
Restarts the prosody server daemon. Equivalent to running prosodyctl stop followed by prosodyctl start.
Prints the current execution status of the prosody server daemon.

Ejabberd Compatibility

ejabberd is another XMPP server which provides a comparable control tool, ejabberdctl, to control its server's operations. prosodyctl implements some commands which are compatible with ejabberdctl. For details of how these commands work you should see ejabberdctl(8).

register user server password

unregister user server


Display help text for the specified command.


The main prosody configuration file. prosodyctl reads this to determine the process ID file of the prosody server daemon and to determine if a host has been configured.


More information may be found online at: http://prosody.im/


Dwayne Bent <dbb.1@liqd.org>