Software /
code /
prosody
Annotate
man/prosodyctl.markdown @ 13126:d043834f15d2
mod_http: Use RFC 7239 Forwarded header to find original client IP
Prefer over X-Forwarded-* since it has an actual specification.
Main practical difference is that Forwarded may carry more properties
than only the IP address since it is a structured header.
Since we parse it into an array, it is easier to do the logical thing
and iterate backwards trough proxies until an untrusted one is
encountered. Compare the handling of X-Forwarded-For.
The 'secure' field now accounts for the full chain of proxies, which
must be secure all the way to be considered secure.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sat, 03 Jun 2023 17:10:04 +0200 |
parent | 12246:51930f685c16 |
rev | line source |
---|---|
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 --- |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
2 author: |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
3 - Dwayne Bent <dbb.1@liqd.org> |
7033
719f02848c99
man prosodyctl: Add missing 'reload' command
Kim Alvefur <zash@zash.se>
parents:
7032
diff
changeset
|
4 - Kim Alvefur |
12243
73ecfe811526
util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents:
12242
diff
changeset
|
5 date: 2022-02-02 |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
6 section: 1 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
7 title: PROSODYCTL |
7741
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
8 --- |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
9 |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
10 # NAME |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
12 prosodyctl - Manage a Prosody XMPP server |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
13 |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
14 # SYNOPSIS |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
16 prosodyctl command [--help] |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
18 # DESCRIPTION |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
19 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
20 prosodyctl is the control tool for the Prosody XMPP server. It may be |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
21 used to control the server daemon and manage users. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
22 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
23 prosodyctl needs to be executed with sufficient privileges to perform |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
24 its commands. This typically means executing prosodyctl as the root |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
25 user. If a user named "prosody" is found then prosodyctl will change to |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 that user before executing its commands. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
27 |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
28 # COMMANDS |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
29 |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
30 ## User Management |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
31 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
32 In the following commands users are identified by a Jabber ID, jid, of |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
33 the usual form: user@domain. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
34 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
35 adduser jid |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
36 : Adds a user with Jabber ID, jid, to the server. You will be prompted |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
37 to enter the user's password. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
38 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
39 passwd jid |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
40 : Changes the password of an existing user with Jabber ID, jid. You |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
41 will be prompted to enter the user's new password. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
42 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
43 deluser jid |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
44 : Deletes an existing user with Jabber ID, jid, from the server. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
45 |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
46 ## Daemon Management |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
47 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
48 Although prosodyctl has commands to manage the prosody daemon it is |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
49 recommended that you utilize your distributions daemon management |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
50 features if you attained Prosody through a package. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
51 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
52 To perform daemon control commands prosodyctl needs a pidfile value |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
53 specified in `/etc/prosody/prosody.cfg.lua`. Failure to do so will cause |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
54 prosodyctl to complain. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
55 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
56 start |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
57 : Starts the prosody server daemon. If run as root prosodyctl will |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
58 attempt to change to a user named "prosody" before executing. This |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
59 operation will block for up to five seconds to wait for the server |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
60 to execute. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
61 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
62 stop |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
63 : Stops the prosody server daemon. This operation will block for up to |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
64 five seconds to wait for the server to stop executing. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
65 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
66 restart |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
67 : Restarts the prosody server daemon. Equivalent to running prosodyctl |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
68 stop followed by prosodyctl start. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
69 |
7033
719f02848c99
man prosodyctl: Add missing 'reload' command
Kim Alvefur <zash@zash.se>
parents:
7032
diff
changeset
|
70 reload |
719f02848c99
man prosodyctl: Add missing 'reload' command
Kim Alvefur <zash@zash.se>
parents:
7032
diff
changeset
|
71 : Signals the prosody server daemon to reload configuration and reopen |
719f02848c99
man prosodyctl: Add missing 'reload' command
Kim Alvefur <zash@zash.se>
parents:
7032
diff
changeset
|
72 log files. |
719f02848c99
man prosodyctl: Add missing 'reload' command
Kim Alvefur <zash@zash.se>
parents:
7032
diff
changeset
|
73 |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
74 status |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
75 : Prints the current execution status of the prosody server daemon. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
76 |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
77 ## Certificates |
7741
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
78 |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
79 prosodyctl can create self-signed certificates, certificate requests and |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
80 private keys for use with Prosody. Commands are of the form |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
81 `prosodyctl cert subcommand`. Commands take a list of hosts to be |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
82 included in the certificate. |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
83 |
8365
8e079677d724
man prosodyctl: Highlight subcommands
Kim Alvefur <zash@zash.se>
parents:
8205
diff
changeset
|
84 `request hosts` |
7741
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
85 : Create a certificate request (CSR) file for submission to a |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
86 certificate authority. Multiple hosts can be given, sub-domains are |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
87 automatically included. |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
88 |
8365
8e079677d724
man prosodyctl: Highlight subcommands
Kim Alvefur <zash@zash.se>
parents:
8205
diff
changeset
|
89 `generate hosts` |
7741
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
90 : Generate a self-signed certificate. |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
91 |
8365
8e079677d724
man prosodyctl: Highlight subcommands
Kim Alvefur <zash@zash.se>
parents:
8205
diff
changeset
|
92 `key host [size]` |
7741
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
93 : Generate a private key of 'size' bits (defaults to 2048). Invoked |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
94 automatically by 'request' and 'generate' if needed. |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
95 |
8365
8e079677d724
man prosodyctl: Highlight subcommands
Kim Alvefur <zash@zash.se>
parents:
8205
diff
changeset
|
96 `config hosts` |
7741
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
97 : Produce a config file for the list of hosts. Invoked automatically |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
98 by 'request' and 'generate' if needed. |
fd277ee3ac57
man/prosodyctl: Add section about certificate commands
Kim Alvefur <zash@zash.se>
parents:
7034
diff
changeset
|
99 |
8365
8e079677d724
man prosodyctl: Highlight subcommands
Kim Alvefur <zash@zash.se>
parents:
8205
diff
changeset
|
100 `import hosts paths` |
8204
7343ffbc65ea
man prosodyctl: Add text about the `cert import` command
Kim Alvefur <zash@zash.se>
parents:
8171
diff
changeset
|
101 : Copy certificates for hosts into the certificate path and reload |
7343ffbc65ea
man prosodyctl: Add text about the `cert import` command
Kim Alvefur <zash@zash.se>
parents:
8171
diff
changeset
|
102 prosody. |
7343ffbc65ea
man prosodyctl: Add text about the `cert import` command
Kim Alvefur <zash@zash.se>
parents:
8171
diff
changeset
|
103 |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
104 ## Debugging |
7034
27f4d63f136a
man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents:
7033
diff
changeset
|
105 |
27f4d63f136a
man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents:
7033
diff
changeset
|
106 prosodyctl can also show some information about the environment, |
27f4d63f136a
man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents:
7033
diff
changeset
|
107 dependencies and such to aid in debugging. |
27f4d63f136a
man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents:
7033
diff
changeset
|
108 |
8365
8e079677d724
man prosodyctl: Highlight subcommands
Kim Alvefur <zash@zash.se>
parents:
8205
diff
changeset
|
109 `about` |
8205
0a3060592db8
man/prosodyctl.markdown: Reflow
Kim Alvefur <zash@zash.se>
parents:
8204
diff
changeset
|
110 : Shows environment, various paths used by Prosody and installed |
0a3060592db8
man/prosodyctl.markdown: Reflow
Kim Alvefur <zash@zash.se>
parents:
8204
diff
changeset
|
111 dependencies. |
7034
27f4d63f136a
man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents:
7033
diff
changeset
|
112 |
8365
8e079677d724
man prosodyctl: Highlight subcommands
Kim Alvefur <zash@zash.se>
parents:
8205
diff
changeset
|
113 `check [what]` |
7034
27f4d63f136a
man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents:
7033
diff
changeset
|
114 : Performs various sanity checks on the configuration, DNS setup and |
27f4d63f136a
man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents:
7033
diff
changeset
|
115 configured TLS certificates. `what` can be one of `config`, `dns` |
12246
51930f685c16
man/prosodyctl: Complete list of 'check' variants
Kim Alvefur <zash@zash.se>
parents:
12245
diff
changeset
|
116 `certs`, `disabled` and `connectivity` to run only that check. |
7034
27f4d63f136a
man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents:
7033
diff
changeset
|
117 |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
118 ## Ejabberd Compatibility |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
119 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
120 ejabberd is another XMPP server which provides a comparable control |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
121 tool, ejabberdctl, to control its server's operations. prosodyctl |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
122 implements some commands which are compatible with ejabberdctl. For |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
123 details of how these commands work you should see ejabberdctl(8). |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
124 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
125 register user server password |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
126 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
127 unregister user server |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
128 |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
129 # OPTIONS |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
130 |
7742
18aad564cbc5
man/prosodyctl: Mention --config
Kim Alvefur <zash@zash.se>
parents:
7741
diff
changeset
|
131 `--config filename` |
18aad564cbc5
man/prosodyctl: Mention --config
Kim Alvefur <zash@zash.se>
parents:
7741
diff
changeset
|
132 : Use the specified config file instead of the default. |
18aad564cbc5
man/prosodyctl: Mention --config
Kim Alvefur <zash@zash.se>
parents:
7741
diff
changeset
|
133 |
8171
746d73347937
man prosodyctl: Mention the --root flag
Kim Alvefur <zash@zash.se>
parents:
7742
diff
changeset
|
134 `--root` |
12245
dfa3cac981bc
man/prosodyctl: Clarify description of --root
Kim Alvefur <zash@zash.se>
parents:
12244
diff
changeset
|
135 : Don't drop root privileges (e.g. when invoked with sudo). |
8171
746d73347937
man prosodyctl: Mention the --root flag
Kim Alvefur <zash@zash.se>
parents:
7742
diff
changeset
|
136 |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
137 `--help` |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
138 : Display help text for the specified command. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
139 |
12243
73ecfe811526
util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents:
12242
diff
changeset
|
140 `--verbose` |
73ecfe811526
util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents:
12242
diff
changeset
|
141 : Increase log level to show debug messages. |
73ecfe811526
util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents:
12242
diff
changeset
|
142 |
73ecfe811526
util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents:
12242
diff
changeset
|
143 `--quiet` |
73ecfe811526
util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents:
12242
diff
changeset
|
144 : Reduce log level to only show errors. |
73ecfe811526
util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents:
12242
diff
changeset
|
145 |
12244
858d40d675ee
util.startup: Teach prosodyctl to be completely --silent
Kim Alvefur <zash@zash.se>
parents:
12243
diff
changeset
|
146 `--silent` |
858d40d675ee
util.startup: Teach prosodyctl to be completely --silent
Kim Alvefur <zash@zash.se>
parents:
12243
diff
changeset
|
147 : Disable logging completely, leaving only command output. |
858d40d675ee
util.startup: Teach prosodyctl to be completely --silent
Kim Alvefur <zash@zash.se>
parents:
12243
diff
changeset
|
148 |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
149 # FILES |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
150 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
151 `/etc/prosody/prosody.cfg.lua` |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
152 : The main prosody configuration file. prosodyctl reads this to |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
153 determine the process ID file of the prosody server daemon and to |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
154 determine if a host has been configured. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
155 |
12242
202319a990e7
man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents:
8365
diff
changeset
|
156 # ONLINE |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
157 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
158 More information may be found online at: <https://prosody.im/> |