prosody
202319a990e7
man/prosodyctl.markdown

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

Software / code / prosody

Comparison

man/prosodyctl.markdown @ 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 --- 1 ---
2 author: 2 author:
3 - 'Dwayne Bent <dbb.1@liqd.org>' 3 - Dwayne Bent <dbb.1@liqd.org>
4 - Kim Alvefur 4 - Kim Alvefur
5 date: '2017-09-02' 5 date: 2017-09-02
6 section: 1 6 section: 1
7 title: PROSODYCTL 7 title: PROSODYCTL
8 --- 8 ---
9 9
10 NAME 10 # NAME
11 ====
12 11
13 prosodyctl - Manage a Prosody XMPP server 12 prosodyctl - Manage a Prosody XMPP server
14 13
15 SYNOPSIS 14 # SYNOPSIS
16 ========
17 15
18 prosodyctl command [--help] 16 prosodyctl command [--help]
19 17
20 DESCRIPTION 18 # DESCRIPTION
21 ===========
22 19
23 prosodyctl is the control tool for the Prosody XMPP server. It may be 20 prosodyctl is the control tool for the Prosody XMPP server. It may be
24 used to control the server daemon and manage users. 21 used to control the server daemon and manage users.
25 22
26 prosodyctl needs to be executed with sufficient privileges to perform 23 prosodyctl needs to be executed with sufficient privileges to perform
27 its commands. This typically means executing prosodyctl as the root 24 its commands. This typically means executing prosodyctl as the root
28 user. If a user named "prosody" is found then prosodyctl will change to 25 user. If a user named "prosody" is found then prosodyctl will change to
29 that user before executing its commands. 26 that user before executing its commands.
30 27
31 COMMANDS 28 # COMMANDS
32 ========
33 29
34 User Management 30 ## User Management
35 ---------------
36 31
37 In the following commands users are identified by a Jabber ID, jid, of 32 In the following commands users are identified by a Jabber ID, jid, of
38 the usual form: user@domain. 33 the usual form: user@domain.
39 34
40 adduser jid 35 adduser jid
46 will be prompted to enter the user's new password. 41 will be prompted to enter the user's new password.
47 42
48 deluser jid 43 deluser jid
49 : Deletes an existing user with Jabber ID, jid, from the server. 44 : Deletes an existing user with Jabber ID, jid, from the server.
50 45
51 Daemon Management 46 ## Daemon Management
52 -----------------
53 47
54 Although prosodyctl has commands to manage the prosody daemon it is 48 Although prosodyctl has commands to manage the prosody daemon it is
55 recommended that you utilize your distributions daemon management 49 recommended that you utilize your distributions daemon management
56 features if you attained Prosody through a package. 50 features if you attained Prosody through a package.
57 51
78 log files. 72 log files.
79 73
80 status 74 status
81 : Prints the current execution status of the prosody server daemon. 75 : Prints the current execution status of the prosody server daemon.
82 76
83 Certificates 77 ## Certificates
84 ------------
85 78
86 prosodyctl can create self-signed certificates, certificate requests and 79 prosodyctl can create self-signed certificates, certificate requests and
87 private keys for use with Prosody. Commands are of the form 80 private keys for use with Prosody. Commands are of the form
88 `prosodyctl cert subcommand`. Commands take a list of hosts to be 81 `prosodyctl cert subcommand`. Commands take a list of hosts to be
89 included in the certificate. 82 included in the certificate.
106 99
107 `import hosts paths` 100 `import hosts paths`
108 : Copy certificates for hosts into the certificate path and reload 101 : Copy certificates for hosts into the certificate path and reload
109 prosody. 102 prosody.
110 103
111 Debugging 104 ## Debugging
112 ---------
113 105
114 prosodyctl can also show some information about the environment, 106 prosodyctl can also show some information about the environment,
115 dependencies and such to aid in debugging. 107 dependencies and such to aid in debugging.
116 108
117 `about` 109 `about`
121 `check [what]` 113 `check [what]`
122 : Performs various sanity checks on the configuration, DNS setup and 114 : Performs various sanity checks on the configuration, DNS setup and
123 configured TLS certificates. `what` can be one of `config`, `dns` 115 configured TLS certificates. `what` can be one of `config`, `dns`
124 and `certs` to run only that check. 116 and `certs` to run only that check.
125 117
126 Ejabberd Compatibility 118 ## Ejabberd Compatibility
127 ----------------------
128 119
129 ejabberd is another XMPP server which provides a comparable control 120 ejabberd is another XMPP server which provides a comparable control
130 tool, ejabberdctl, to control its server's operations. prosodyctl 121 tool, ejabberdctl, to control its server's operations. prosodyctl
131 implements some commands which are compatible with ejabberdctl. For 122 implements some commands which are compatible with ejabberdctl. For
132 details of how these commands work you should see ejabberdctl(8). 123 details of how these commands work you should see ejabberdctl(8).
133 124
134 register user server password 125 register user server password
135 126
136 unregister user server 127 unregister user server
137 128
138 OPTIONS 129 # OPTIONS
139 =======
140 130
141 `--config filename` 131 `--config filename`
142 : Use the specified config file instead of the default. 132 : Use the specified config file instead of the default.
143 133
144 `--root` 134 `--root`
145 : Don't drop root privileges. 135 : Don't drop root privileges.
146 136
147 `--help` 137 `--help`
148 : Display help text for the specified command. 138 : Display help text for the specified command.
149 139
150 FILES 140 # FILES
151 =====
152 141
153 `/etc/prosody/prosody.cfg.lua` 142 `/etc/prosody/prosody.cfg.lua`
154 : The main prosody configuration file. prosodyctl reads this to 143 : The main prosody configuration file. prosodyctl reads this to
155 determine the process ID file of the prosody server daemon and to 144 determine the process ID file of the prosody server daemon and to
156 determine if a host has been configured. 145 determine if a host has been configured.
157 146
158 ONLINE 147 # ONLINE
159 ======
160 148
161 More information may be found online at: <https://prosody.im/> 149 More information may be found online at: <https://prosody.im/>