prosody
817c7b197ac7
man/prosodyctl.markdown

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

Software / code / prosody

Annotate

man/prosodyctl.markdown @ 7032:817c7b197ac7

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