Software /
code /
prosody
Annotate
man/prosodyctl.markdown @ 7033:719f02848c99
man prosodyctl: Add missing 'reload' command
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Wed, 23 Dec 2015 14:20:57 +0100 |
parent | 7032:817c7b197ac7 |
child | 7034:27f4d63f136a |
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: |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
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 |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 date: '2015-12-23' |
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 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
8 ... |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
9 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
10 NAME |
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 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
13 prosodyctl - Manage a Prosody XMPP server |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 SYNOPSIS |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
16 ======== |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
18 prosodyctl command [--help] |
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 DESCRIPTION |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
21 =========== |
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 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
|
24 used to control the server daemon and manage users. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
25 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 prosodyctl needs to be executed with sufficient privileges to perform |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
27 its commands. This typically means executing prosodyctl as the root |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
28 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
|
29 that user before executing its commands. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
30 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
31 COMMANDS |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
32 ======== |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
33 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
34 User Management |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
35 --------------- |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
36 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
37 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
|
38 the usual form: user@domain. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
39 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
40 adduser jid |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
41 : 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
|
42 to enter the user's password. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
43 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
44 passwd jid |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
45 : 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
|
46 will be prompted to enter the user's new password. |
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 deluser jid |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
49 : Deletes an existing user with Jabber ID, jid, from the server. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
50 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
51 Daemon Management |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
52 ----------------- |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
53 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
54 Although prosodyctl has commands to manage the prosody daemon it is |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
55 recommended that you utilize your distributions daemon management |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
56 features if you attained Prosody through a package. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
57 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
58 To perform daemon control commands prosodyctl needs a pidfile value |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
59 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
|
60 prosodyctl to complain. |
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 start |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
63 : Starts the prosody server daemon. If run as root prosodyctl will |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
64 attempt to change to a user named "prosody" before executing. This |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
65 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
|
66 to execute. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
67 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
68 stop |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
69 : 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
|
70 five seconds to wait for the server to stop executing. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
71 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
72 restart |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
73 : Restarts the prosody server daemon. Equivalent to running prosodyctl |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
74 stop followed by prosodyctl start. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
75 |
7033
719f02848c99
man prosodyctl: Add missing 'reload' command
Kim Alvefur <zash@zash.se>
parents:
7032
diff
changeset
|
76 reload |
719f02848c99
man prosodyctl: Add missing 'reload' command
Kim Alvefur <zash@zash.se>
parents:
7032
diff
changeset
|
77 : 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
|
78 log files. |
719f02848c99
man prosodyctl: Add missing 'reload' command
Kim Alvefur <zash@zash.se>
parents:
7032
diff
changeset
|
79 |
7032
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
80 status |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
81 : Prints the current execution status of the prosody server daemon. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
82 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
83 Ejabberd Compatibility |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
84 ---------------------- |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
85 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
86 ejabberd is another XMPP server which provides a comparable control |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
87 tool, ejabberdctl, to control its server's operations. prosodyctl |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
88 implements some commands which are compatible with ejabberdctl. For |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
89 details of how these commands work you should see ejabberdctl(8). |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
90 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
91 register user server password |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
92 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
93 unregister user server |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
94 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
95 OPTIONS |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
96 ======= |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
97 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
98 `--help` |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
99 : Display help text for the specified command. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
100 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
101 FILES |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
102 ===== |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
103 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
104 `/etc/prosody/prosody.cfg.lua` |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
105 : The main prosody configuration file. prosodyctl reads this to |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
106 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
|
107 determine if a host has been configured. |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
108 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
109 ONLINE |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
110 ====== |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
111 |
817c7b197ac7
man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
112 More information may be found online at: <https://prosody.im/> |