LinuxCommandLibrary

prosodyctl

Manage the Prosody XMPP server

TLDR

Show the status of the Prosody server

$ sudo prosodyctl status
copy

Reload the server's configuration files
$ sudo prosodyctl reload
copy

Add a user to the Prosody XMPP server
$ sudo prosodyctl adduser [user@example.com]
copy

Set a user's password
$ sudo prosodyctl passwd [user@example.com]
copy

Permanently delete a user
$ sudo prosodyctl deluser [user@example.com]
copy

SYNOPSIS

prosodyctl [options]

PARAMETERS

start
    Starts the Prosody server.

stop
    Stops the Prosody server.

restart
    Restarts the Prosody server.

status
    Checks the status of the Prosody server.

module-enable
    Enables the specified module.

module-disable
    Disables the specified module.

modules
    Lists all available modules.

check
    Checks the Prosody configuration file for errors.

version
    Displays the Prosody version.

certificate generate
    Generates a new SSL/TLS certificate for the specified hostname.

DESCRIPTION

The `prosodyctl` command is a utility for managing and controlling a Prosody XMPP (Extensible Messaging and Presence Protocol) server instance. It allows you to start, stop, restart, and check the status of the Prosody server. It also provides functionalities for managing modules, certificates, and other aspects of the Prosody configuration. `prosodyctl` simplifies the administration of a Prosody server, abstracting away the complexities of direct configuration file manipulation and system-level service management. This tool is crucial for deploying, maintaining, and scaling Prosody installations.

CONFIGURATION FILES

The main Prosody configuration file is typically located at `/etc/prosody/prosody.cfg.lua`. Modifications to server settings and module configurations are generally made in this file.
The `prosodyctl` command interacts with this file and other relevant configuration files.

USER MANAGEMENT

While `prosodyctl` doesn't directly manage user accounts, user data is often stored in databases.
Refer to the Prosody documentation for instructions on configuring user authentication and storage.

SEE ALSO

prosody(1)

Copied to clipboard