1 .\" Automatically generated by Pandoc 1.15.2
4 .TH "PROSODYCTL" "1" "2015\-12\-23" "" ""
7 prosodyctl \- Manage a Prosody XMPP server
12 prosodyctl\ command\ [\-\-help]
17 prosodyctl is the control tool for the Prosody XMPP server.
18 It may be used to control the server daemon and manage users.
20 prosodyctl needs to be executed with sufficient privileges to perform
22 This typically means executing prosodyctl as the root user.
23 If a user named "prosody" is found then prosodyctl will change to that
24 user before executing its commands.
28 In the following commands users are identified by a Jabber ID, jid, of
29 the usual form: user\@domain.
32 Adds a user with Jabber ID, jid, to the server.
33 You will be prompted to enter the user\[aq]s password.
38 Changes the password of an existing user with Jabber ID, jid.
39 You will be prompted to enter the user\[aq]s new password.
44 Deletes an existing user with Jabber ID, jid, from the server.
49 Although prosodyctl has commands to manage the prosody daemon it is
50 recommended that you utilize your distributions daemon management
51 features if you attained Prosody through a package.
53 To perform daemon control commands prosodyctl needs a pidfile value
54 specified in \f[C]/etc/prosody/prosody.cfg.lua\f[].
55 Failure to do so will cause prosodyctl to complain.
58 Starts the prosody server daemon.
59 If run as root prosodyctl will attempt to change to a user named
60 "prosody" before executing.
61 This operation will block for up to five seconds to wait for the server
67 Stops the prosody server daemon.
68 This operation will block for up to five seconds to wait for the server
74 Restarts the prosody server daemon.
75 Equivalent to running prosodyctl stop followed by prosodyctl start.
80 Signals the prosody server daemon to reload configuration and reopen log
86 Prints the current execution status of the prosody server daemon.
89 .SS Ejabberd Compatibility
91 ejabberd is another XMPP server which provides a comparable control
92 tool, ejabberdctl, to control its server\[aq]s operations.
93 prosodyctl implements some commands which are compatible with
95 For details of how these commands work you should see ejabberdctl(8).
99 register\ user\ server\ password
101 unregister\ user\ server
107 Display help text for the specified command.
112 .B \f[C]/etc/prosody/prosody.cfg.lua\f[]
113 The main prosody configuration file.
114 prosodyctl reads this to determine the process ID file of the prosody
115 server daemon and to determine if a host has been configured.
120 More information may be found online at: <https://prosody.im/>
122 Dwayne Bent <dbb.1@liqd.org>; Kim Alvefur.