From e310e18a50db40e86930cf905561495637b3616c Mon Sep 17 00:00:00 2001 From: Kim Alvefur Date: Wed, 23 Dec 2015 14:19:01 +0100 Subject: man prosodyctl: Accidentally markdown --- man/prosodyctl.markdown | 107 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 107 insertions(+) create mode 100644 man/prosodyctl.markdown (limited to 'man/prosodyctl.markdown') diff --git a/man/prosodyctl.markdown b/man/prosodyctl.markdown new file mode 100644 index 00000000..e4cd8e91 --- /dev/null +++ b/man/prosodyctl.markdown @@ -0,0 +1,107 @@ +--- +author: +- 'Dwayne Bent ' +date: '2015-12-23' +section: 1 +title: PROSODYCTL +... + +NAME +==== + +prosodyctl - Manage a Prosody XMPP server + +SYNOPSIS +======== + + prosodyctl command [--help] + +DESCRIPTION +=========== + +prosodyctl is the control tool for the Prosody XMPP server. It may be +used to control the server daemon and manage users. + +prosodyctl needs to be executed with sufficient privileges to perform +its commands. This typically means executing prosodyctl as the root +user. If a user named "prosody" is found then prosodyctl will change to +that user before executing its commands. + +COMMANDS +======== + +User Management +--------------- + +In the following commands users are identified by a Jabber ID, jid, of +the usual form: user@domain. + +adduser jid +: Adds a user with Jabber ID, jid, to the server. You will be prompted + to enter the user's password. + +passwd jid +: Changes the password of an existing user with Jabber ID, jid. You + will be prompted to enter the user's new password. + +deluser jid +: Deletes an existing user with Jabber ID, jid, from the server. + +Daemon Management +----------------- + +Although prosodyctl has commands to manage the prosody daemon it is +recommended that you utilize your distributions daemon management +features if you attained Prosody through a package. + +To perform daemon control commands prosodyctl needs a pidfile value +specified in `/etc/prosody/prosody.cfg.lua`. Failure to do so will cause +prosodyctl to complain. + +start +: Starts the prosody server daemon. If run as root prosodyctl will + attempt to change to a user named "prosody" before executing. This + operation will block for up to five seconds to wait for the server + to execute. + +stop +: Stops the prosody server daemon. This operation will block for up to + five seconds to wait for the server to stop executing. + +restart +: Restarts the prosody server daemon. Equivalent to running prosodyctl + stop followed by prosodyctl start. + +status +: Prints the current execution status of the prosody server daemon. + +Ejabberd Compatibility +---------------------- + +ejabberd is another XMPP server which provides a comparable control +tool, ejabberdctl, to control its server's operations. prosodyctl +implements some commands which are compatible with ejabberdctl. For +details of how these commands work you should see ejabberdctl(8). + + register user server password + + unregister user server + +OPTIONS +======= + +`--help` +: Display help text for the specified command. + +FILES +===== + +`/etc/prosody/prosody.cfg.lua` +: The main prosody configuration file. prosodyctl reads this to + determine the process ID file of the prosody server daemon and to + determine if a host has been configured. + +ONLINE +====== + +More information may be found online at: -- cgit v1.2.3 From 449bfbc135e6592865fd68f29e2d75ec7667c4a7 Mon Sep 17 00:00:00 2001 From: Kim Alvefur Date: Wed, 23 Dec 2015 14:20:57 +0100 Subject: man prosodyctl: Add missing 'reload' command --- man/prosodyctl.markdown | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'man/prosodyctl.markdown') diff --git a/man/prosodyctl.markdown b/man/prosodyctl.markdown index e4cd8e91..5360503b 100644 --- a/man/prosodyctl.markdown +++ b/man/prosodyctl.markdown @@ -1,6 +1,7 @@ --- author: - 'Dwayne Bent ' +- Kim Alvefur date: '2015-12-23' section: 1 title: PROSODYCTL @@ -72,6 +73,10 @@ restart : Restarts the prosody server daemon. Equivalent to running prosodyctl stop followed by prosodyctl start. +reload +: Signals the prosody server daemon to reload configuration and reopen + log files. + status : Prints the current execution status of the prosody server daemon. -- cgit v1.2.3 From 4e8f92f0aee1621af3bc1302af7c0982d9a53077 Mon Sep 17 00:00:00 2001 From: Kim Alvefur Date: Wed, 23 Dec 2015 14:21:20 +0100 Subject: man prosodyctl: Add information about the 'about' and 'check' commands --- man/prosodyctl.markdown | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'man/prosodyctl.markdown') diff --git a/man/prosodyctl.markdown b/man/prosodyctl.markdown index 5360503b..217dfd3d 100644 --- a/man/prosodyctl.markdown +++ b/man/prosodyctl.markdown @@ -80,6 +80,21 @@ reload status : Prints the current execution status of the prosody server daemon. +Debugging +--------- + +prosodyctl can also show some information about the environment, +dependencies and such to aid in debugging. + +about +: Shows environment, various paths used by Prosody and + installed dependencies. + +check \[what\] +: Performs various sanity checks on the configuration, DNS setup and + configured TLS certificates. `what` can be one of `config`, `dns` + and `certs` to run only that check. + Ejabberd Compatibility ---------------------- -- cgit v1.2.3