1PROSODYCTL(1)                                                    PROSODYCTL(1)
2
3
4

NAME

6       prosodyctl - Manage a Prosody XMPP server
7

SYNOPSIS

9              prosodyctl command [--help]
10

DESCRIPTION

12       prosodyctl  is the control tool for the Prosody XMPP server.  It may be
13       used to control the server daemon and manage users.
14
15       prosodyctl needs to be executed with sufficient privileges  to  perform
16       its  commands.   This  typically means executing prosodyctl as the root
17       user.  If a user named “prosody” is found then prosodyctl  will  change
18       to that user before executing its commands.
19

COMMANDS

21   User Management
22       In  the following commands users are identified by a Jabber ID, jid, of
23       the usual form: user@domain.
24
25       adduser jid
26              Adds a user with Jabber ID, jid, to the  server.   You  will  be
27              prompted to enter the user’s password.
28
29       passwd jid
30              Changes  the  password  of an existing user with Jabber ID, jid.
31              You will be prompted to enter the user’s new password.
32
33       deluser jid
34              Deletes an existing user with Jabber ID, jid, from the server.
35
36   Daemon Management
37       Although prosodyctl has commands to manage the  prosody  daemon  it  is
38       recommended  that you utilize your distributions daemon management fea‐
39       tures if you attained Prosody through a package.
40
41       To perform daemon control commands prosodyctl  needs  a  pidfile  value
42       specified in /etc/prosody/prosody.cfg.lua.  Failure to do so will cause
43       prosodyctl to complain.
44
45       start  Starts the prosody server daemon.  If  run  as  root  prosodyctl
46              will  attempt to change to a user named “prosody” before execut‐
47              ing.  This operation will block for up to five seconds  to  wait
48              for the server to execute.
49
50       stop   Stops  the prosody server daemon.  This operation will block for
51              up to five seconds to wait for the server to stop executing.
52
53       restart
54              Restarts the  prosody  server  daemon.   Equivalent  to  running
55              prosodyctl stop followed by prosodyctl start.
56
57       reload Signals  the  prosody  server daemon to reload configuration and
58              reopen log files.
59
60       status Prints the current execution status of the prosody  server  dae‐
61              mon.
62
63   Certificates
64       prosodyctl  can  create  self-signed certificates, certificate requests
65       and private keys for use  with  Prosody.   Commands  are  of  the  form
66       prosodyctl  cert  subcommand.   Commands take a list of hosts to be in‐
67       cluded in the certificate.
68
69       request hosts
70              Create a certificate request (CSR) file for submission to a cer‐
71              tificate  authority.   Multiple  hosts can be given, sub-domains
72              are automatically included.
73
74       generate hosts
75              Generate a self-signed certificate.
76
77       key host [size]
78              Generate a private key of `size' bits (defaults to  2048).   In‐
79              voked automatically by `request' and `generate' if needed.
80
81       config hosts
82              Produce  a config file for the list of hosts.  Invoked automati‐
83              cally by `request' and `generate' if needed.
84
85       import hosts paths
86              Copy certificates for hosts into the certificate path and reload
87              prosody.
88
89   Debugging
90       prosodyctl can also show some information about the environment, depen‐
91       dencies and such to aid in debugging.
92
93       about  Shows environment, various paths used by Prosody  and  installed
94              dependencies.
95
96       check [what]
97              Performs  various  sanity checks on the configuration, DNS setup
98              and configured TLS certificates.  what can be one of config, dns
99              certs, disabled and connectivity to run only that check.
100
101   Ejabberd Compatibility
102       ejabberd  is  another  XMPP  server which provides a comparable control
103       tool, ejabberdctl, to control its server’s operations.  prosodyctl  im‐
104       plements  some commands which are compatible with ejabberdctl.  For de‐
105       tails of how these commands work you should see ejabberdctl(8).
106
107              register user server password
108
109              unregister user server
110

OPTIONS

112       --config filename
113              Use the specified config file instead of the default.
114
115       --root Don’t drop root privileges (e.g. when invoked with sudo).
116
117       --help Display help text for the specified command.
118
119       --verbose
120              Increase log level to show debug messages.
121
122       --quiet
123              Reduce log level to only show errors.
124
125       --silent
126              Disable logging completely, leaving only command output.
127

FILES

129       /etc/prosody/prosody.cfg.lua
130              The main prosody configuration file.  prosodyctl reads  this  to
131              determine  the  process ID file of the prosody server daemon and
132              to determine if a host has been configured.
133

ONLINE

135       More information may be found online at: <https://prosody.im/>
136

AUTHORS

138       Dwayne Bent <dbb.1@liqd.org>; Kim Alvefur.
139
140
141
142                                  2022-02-02                     PROSODYCTL(1)