3 - 'Dwayne Bent <dbb.1@liqd.org>'
13 prosodyctl - Manage a Prosody XMPP server
18 prosodyctl command [--help]
23 prosodyctl is the control tool for the Prosody XMPP server. It may be
24 used to control the server daemon and manage users.
26 prosodyctl needs to be executed with sufficient privileges to perform
27 its commands. This typically means executing prosodyctl as the root
28 user. If a user named "prosody" is found then prosodyctl will change to
29 that user before executing its commands.
37 In the following commands users are identified by a Jabber ID, jid, of
38 the usual form: user@domain.
41 : Adds a user with Jabber ID, jid, to the server. You will be prompted
42 to enter the user's password.
45 : Changes the password of an existing user with Jabber ID, jid. You
46 will be prompted to enter the user's new password.
49 : Deletes an existing user with Jabber ID, jid, from the server.
54 Although prosodyctl has commands to manage the prosody daemon it is
55 recommended that you utilize your distributions daemon management
56 features if you attained Prosody through a package.
58 To perform daemon control commands prosodyctl needs a pidfile value
59 specified in `/etc/prosody/prosody.cfg.lua`. Failure to do so will cause
60 prosodyctl to complain.
63 : Starts the prosody server daemon. If run as root prosodyctl will
64 attempt to change to a user named "prosody" before executing. This
65 operation will block for up to five seconds to wait for the server
69 : Stops the prosody server daemon. This operation will block for up to
70 five seconds to wait for the server to stop executing.
73 : Restarts the prosody server daemon. Equivalent to running prosodyctl
74 stop followed by prosodyctl start.
77 : Signals the prosody server daemon to reload configuration and reopen
81 : Prints the current execution status of the prosody server daemon.
86 prosodyctl can also show some information about the environment,
87 dependencies and such to aid in debugging.
90 : Shows environment, various paths used by Prosody and
91 installed dependencies.
94 : Performs various sanity checks on the configuration, DNS setup and
95 configured TLS certificates. `what` can be one of `config`, `dns`
96 and `certs` to run only that check.
98 Ejabberd Compatibility
99 ----------------------
101 ejabberd is another XMPP server which provides a comparable control
102 tool, ejabberdctl, to control its server's operations. prosodyctl
103 implements some commands which are compatible with ejabberdctl. For
104 details of how these commands work you should see ejabberdctl(8).
106 register user server password
108 unregister user server
114 : Display help text for the specified command.
119 `/etc/prosody/prosody.cfg.lua`
120 : The main prosody configuration file. prosodyctl reads this to
121 determine the process ID file of the prosody server daemon and to
122 determine if a host has been configured.
127 More information may be found online at: <https://prosody.im/>