prosody
202319a990e7
man/prosodyctl.man

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

Comparison

man/prosodyctl.man @ 12242:202319a990e7

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