man/prosodyctl.man

   1 .\" Automatically generated by Pandoc 1.15.2
   2 .\"
   3 .hy
   4 .TH "PROSODYCTL" "1" "2015\-12\-23" "" ""
   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 Debugging
  90 .PP
  91 prosodyctl can also show some information about the environment,
  92 dependencies and such to aid in debugging.
  93 .TP
  94 .B about
  95 Shows environment, various paths used by Prosody and installed
  96 dependencies.
  97 .RS
  98 .RE
  99 .TP
 100 .B check [what]
 101 Performs various sanity checks on the configuration, DNS setup and
 102 configured TLS certificates.
 103 \f[C]what\f[] can be one of \f[C]config\f[], \f[C]dns\f[] and
 104 \f[C]certs\f[] to run only that check.
 105 .RS
 106 .RE
 107 .SS Ejabberd Compatibility
 108 .PP
 109 ejabberd is another XMPP server which provides a comparable control
 110 tool, ejabberdctl, to control its server\[aq]s operations.
 111 prosodyctl implements some commands which are compatible with
 112 ejabberdctl.
 113 For details of how these commands work you should see ejabberdctl(8).
 114 .IP
 115 .nf
 116 \f[C]
 117 register\ user\ server\ password
 118
 119 unregister\ user\ server
 120 \f[]
 121 .fi
 122 .SH OPTIONS
 123 .TP
 124 .B \f[C]\-\-help\f[]
 125 Display help text for the specified command.
 126 .RS
 127 .RE
 128 .SH FILES
 129 .TP
 130 .B \f[C]/etc/prosody/prosody.cfg.lua\f[]
 131 The main prosody configuration file.
 132 prosodyctl reads this to determine the process ID file of the prosody
 133 server daemon and to determine if a host has been configured.
 134 .RS
 135 .RE
 136 .SH ONLINE
 137 .PP
 138 More information may be found online at: <https://prosody.im/>
 139 .SH AUTHORS
 140 Dwayne Bent <dbb.1@liqd.org>; Kim Alvefur.