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

Comparison

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
comparison
equal deleted inserted replaced
7031:89221daefae9 7032:817c7b197ac7
1 ---
2 author:
3 - 'Dwayne Bent <dbb.1@liqd.org>'
4 date: '2015-12-23'
5 section: 1
6 title: PROSODYCTL
7 ...
8
9 NAME
10 ====
11
12 prosodyctl - Manage a Prosody XMPP server
13
14 SYNOPSIS
15 ========
16
17 prosodyctl command [--help]
18
19 DESCRIPTION
20 ===========
21
22 prosodyctl is the control tool for the Prosody XMPP server. It may be
23 used to control the server daemon and manage users.
24
25 prosodyctl needs to be executed with sufficient privileges to perform
26 its commands. This typically means executing prosodyctl as the root
27 user. If a user named "prosody" is found then prosodyctl will change to
28 that user before executing its commands.
29
30 COMMANDS
31 ========
32
33 User Management
34 ---------------
35
36 In the following commands users are identified by a Jabber ID, jid, of
37 the usual form: user@domain.
38
39 adduser jid
40 : Adds a user with Jabber ID, jid, to the server. You will be prompted
41 to enter the user's password.
42
43 passwd jid
44 : Changes the password of an existing user with Jabber ID, jid. You
45 will be prompted to enter the user's new password.
46
47 deluser jid
48 : Deletes an existing user with Jabber ID, jid, from the server.
49
50 Daemon Management
51 -----------------
52
53 Although prosodyctl has commands to manage the prosody daemon it is
54 recommended that you utilize your distributions daemon management
55 features if you attained Prosody through a package.
56
57 To perform daemon control commands prosodyctl needs a pidfile value
58 specified in `/etc/prosody/prosody.cfg.lua`. Failure to do so will cause
59 prosodyctl to complain.
60
61 start
62 : Starts the prosody server daemon. If run as root prosodyctl will
63 attempt to change to a user named "prosody" before executing. This
64 operation will block for up to five seconds to wait for the server
65 to execute.
66
67 stop
68 : Stops the prosody server daemon. This operation will block for up to
69 five seconds to wait for the server to stop executing.
70
71 restart
72 : Restarts the prosody server daemon. Equivalent to running prosodyctl
73 stop followed by prosodyctl start.
74
75 status
76 : Prints the current execution status of the prosody server daemon.
77
78 Ejabberd Compatibility
79 ----------------------
80
81 ejabberd is another XMPP server which provides a comparable control
82 tool, ejabberdctl, to control its server's operations. prosodyctl
83 implements some commands which are compatible with ejabberdctl. For
84 details of how these commands work you should see ejabberdctl(8).
85
86 register user server password
87
88 unregister user server
89
90 OPTIONS
91 =======
92
93 `--help`
94 : Display help text for the specified command.
95
96 FILES
97 =====
98
99 `/etc/prosody/prosody.cfg.lua`
100 : The main prosody configuration file. prosodyctl reads this to
101 determine the process ID file of the prosody server daemon and to
102 determine if a host has been configured.
103
104 ONLINE
105 ======
106
107 More information may be found online at: <https://prosody.im/>