man/prosodyctl.man

   1 .\" Automatically generated by Pandoc 1.19.2.1
   2 .\"
   3 .TH "PROSODYCTL" "1" "2017\-09\-02" "" ""
   4 .hy
   5 .SH NAME
   6 .PP
   7 prosodyctl \- Manage a Prosody XMPP server
   8 .SH SYNOPSIS
   9 .IP
  10 .nf
  11 \f[C]
  12 prosodyctl\ command\ [\-\-help]
  13 \f[]
  14 .fi
  15 .SH DESCRIPTION
  16 .PP
  17 prosodyctl is the control tool for the Prosody XMPP server.
  18 It may be used to control the server daemon and manage users.
  19 .PP
  20 prosodyctl needs to be executed with sufficient privileges to perform
  21 its commands.
  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.
  25 .SH COMMANDS
  26 .SS User Management
  27 .PP
  28 In the following commands users are identified by a Jabber ID, jid, of
  29 the usual form: user\@domain.
  30 .TP
  31 .B adduser jid
  32 Adds a user with Jabber ID, jid, to the server.
  33 You will be prompted to enter the user\[aq]s password.
  34 .RS
  35 .RE
  36 .TP
  37 .B passwd jid
  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.
  40 .RS
  41 .RE
  42 .TP
  43 .B deluser jid
  44 Deletes an existing user with Jabber ID, jid, from the server.
  45 .RS
  46 .RE
  47 .SS Daemon Management
  48 .PP
  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.
  52 .PP
  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.
  56 .TP
  57 .B start
  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
  62 to execute.
  63 .RS
  64 .RE
  65 .TP
  66 .B stop
  67 Stops the prosody server daemon.
  68 This operation will block for up to five seconds to wait for the server
  69 to stop executing.
  70 .RS
  71 .RE
  72 .TP
  73 .B restart
  74 Restarts the prosody server daemon.
  75 Equivalent to running prosodyctl stop followed by prosodyctl start.
  76 .RS
  77 .RE
  78 .TP
  79 .B reload
  80 Signals the prosody server daemon to reload configuration and reopen log
  81 files.
  82 .RS
  83 .RE
  84 .TP
  85 .B status
  86 Prints the current execution status of the prosody server daemon.
  87 .RS
  88 .RE
  89 .SS Certificates
  90 .PP
  91 prosodyctl can create self\-signed certificates, certificate requests
  92 and private keys for use with Prosody.
  93 Commands are of the form \f[C]prosodyctl\ cert\ subcommand\f[].
  94 Commands take a list of hosts to be included in the certificate.
  95 .TP
  96 .B \f[C]request\ hosts\f[]
  97 Create a certificate request (CSR) file for submission to a certificate
  98 authority.
  99 Multiple hosts can be given, sub\-domains are automatically included.
 100 .RS
 101 .RE
 102 .TP
 103 .B \f[C]generate\ hosts\f[]
 104 Generate a self\-signed certificate.
 105 .RS
 106 .RE
 107 .TP
 108 .B \f[C]key\ host\ [size]\f[]
 109 Generate a private key of \[aq]size\[aq] bits (defaults to 2048).
 110 Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if
 111 needed.
 112 .RS
 113 .RE
 114 .TP
 115 .B \f[C]config\ hosts\f[]
 116 Produce a config file for the list of hosts.
 117 Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if
 118 needed.
 119 .RS
 120 .RE
 121 .TP
 122 .B \f[C]import\ hosts\ paths\f[]
 123 Copy certificates for hosts into the certificate path and reload
 124 prosody.
 125 .RS
 126 .RE
 127 .SS Debugging
 128 .PP
 129 prosodyctl can also show some information about the environment,
 130 dependencies and such to aid in debugging.
 131 .TP
 132 .B \f[C]about\f[]
 133 Shows environment, various paths used by Prosody and installed
 134 dependencies.
 135 .RS
 136 .RE
 137 .TP
 138 .B \f[C]check\ [what]\f[]
 139 Performs various sanity checks on the configuration, DNS setup and
 140 configured TLS certificates.
 141 \f[C]what\f[] can be one of \f[C]config\f[], \f[C]dns\f[] and
 142 \f[C]certs\f[] to run only that check.
 143 .RS
 144 .RE
 145 .SS Ejabberd Compatibility
 146 .PP
 147 ejabberd is another XMPP server which provides a comparable control
 148 tool, ejabberdctl, to control its server\[aq]s operations.
 149 prosodyctl implements some commands which are compatible with
 150 ejabberdctl.
 151 For details of how these commands work you should see ejabberdctl(8).
 152 .IP
 153 .nf
 154 \f[C]
 155 register\ user\ server\ password
 156
 157 unregister\ user\ server
 158 \f[]
 159 .fi
 160 .SH OPTIONS
 161 .TP
 162 .B \f[C]\-\-config\ filename\f[]
 163 Use the specified config file instead of the default.
 164 .RS
 165 .RE
 166 .TP
 167 .B \f[C]\-\-root\f[]
 168 Don\[aq]t drop root privileges.
 169 .RS
 170 .RE
 171 .TP
 172 .B \f[C]\-\-help\f[]
 173 Display help text for the specified command.
 174 .RS
 175 .RE
 176 .SH FILES
 177 .TP
 178 .B \f[C]/etc/prosody/prosody.cfg.lua\f[]
 179 The main prosody configuration file.
 180 prosodyctl reads this to determine the process ID file of the prosody
 181 server daemon and to determine if a host has been configured.
 182 .RS
 183 .RE
 184 .SH ONLINE
 185 .PP
 186 More information may be found online at: <https://prosody.im/>
 187 .SH AUTHORS
 188 Dwayne Bent <dbb.1@liqd.org>; Kim Alvefur.