How To Install prosody-modules on Ubuntu

Posted on April 1, 2023  (Last modified on May 20, 2023 )

5 minutes  • 874 words

Introduction

In this tutorial we learn how to install prosody-modules on Ubuntu.

What is prosody-modules

prosody-modules is:

This package contains extensions to the Prosody XMPP server. This is a selection of the community provided archive at http://hg.prosody.im/prosody-modules/

modules included:

• mod_adhoc_blacklist: XEP-0133: Service Administration blacklist editing
• mod_atom: exposes users microblogging on HTTP
• mod_auth_ccert: PKI-style client certificate authentication
• mod_auth_dovecot: dovecot authentication
• mod_auth_ha1: HA1 based authentication
• mod_auth_ldap: LDAP authentication with several features
• mod_auth_ldap2: LDAP authentication
• mod_auth_sql: SQL Database authentication module
• mod_blocking: XEP-0191: Blocking Command
• mod_block_strangers: block messages from jids not in roster
• mod_bob: cache Bits of Binary on MUC services
• mod_bookmarks: XEP-0411: Synchronise bookmarks between Private XML and PEP
• mod_bookmarks2: XEP-0402: PEP Native Bookmarks
• mod_broadcast: broadcast a message to online users, like mod_announce
• mod_c2s_conn_throttle: c2s connections throttling module
• mod_carbons_adhoc: XEP-0280: adhoc command for Message Carbons
• mod_carbons_copies: XEP-0280: Message Carbons, v0 style copy support
• mod_client_certs: XEP-0257: Client Certificate Management for SASL EXTERNAL
• mod_cloud_notify: XEP-0357: Push Notifications
• mod_conversejs: small snippet of HTML that loads Converse.js
• mod_csi/mod_csi_battery_saver/mod_filter_chatstates/mod_throttle_presence: XEP-0352: Client State Indication
• mod_default_bookmarks: default bookmarks for users
• mod_delegation: XEP-0355: Namespace Delegation
• mod_firewall: block, bounce, drop, forward, copy, redirect stanzas
• mod_host_guard: granular remote host blacklisting plugin
• mod_http_libjs: serve common Javascript libraries
• mod_http_muc_log: web interface to stored chatroom logs
• mod_http_upload: XEP-0363: upload files over HTTP for clients
• mod_http_upload_external: XEP-0363: upload files over HTTP for clients to an external web server
• mod_invite: allows users with an account to generate single-use invite URLs using an ad-hoc command (deprecated)
• mod_invites: invite management module for Prosody
• mod_invites_adhoc: enable ad-hoc command for XMPP clients to create invitations
• mod_invites_api: authenticated HTTP API to create invites
• mod_invites_page: generate friendly web page for invitations
• mod_invites_register: allow account registration using invite tokens
• mod_invites_register_web: register accounts via the web using invite tokens
• mod_ipcheck: XEP-0279: server IP check
• mod_lastlog: stores the timestamp of when a user logs in
• mod_lib_ldap: LDAP lib
• mod_list_inactive: lists users, who haven’t used their account in a defined time-frame
• mod_log_auth: log failed authentication attempts with their IP address
• mod_mam_adhoc: XEP-0313: adhoc command for Message Archive Management
• mod_muc_log: logs the conversation of chatrooms running on the server to Prosody’s data store
• mod_muc_log_http: provides a built-in web interface to view chatroom logs stored by mod_muc_log
• mod_muc_moderation: XEP-0425: Message Moderation
• mod_net_dovecotauth: server implementation of the Dovecot authentication protocol. It allows you to authenticate e.g. Postfix against your Prosody installation.
• mod_onions: allow federation (s2s) to Tor hidden services
• mod_pastebin: redirect long messages to built-in pastebin
• mod_privacy_lists: XEP-0016: privacy lists
• mod_private_adhoc: retrieve private XML data via adhoc command
• mod_privilege: XEP-0356: allows entity/component to have privileged access
• mod_profile: replacement for mod_vcard
• mod_prometheus: implements the Prometheus reporting protocol
• mod_pubsub_feeds: fetch Atom and RSS feeds, push to pubsub subscribers
• mod_pubsub_mqtt: lets MQTT clients connect to pubsub nodes
• mod_pubsub_text_interface: lets users manage subscriptions to pubsub nodes via simple chat messages
• mod_register_apps: manage list of compatible client apps
• mod_register_json: token based JSON registration & verification servlet
• mod_register_redirect: XEP-077: IBR Registration Redirect
• mod_register_web: web interface to register user accounts
• mod_reload_modules: automatically reload modules with the config
• mod_require_otr: enforce a policy for OTR-encrypted messages
• mod_s2s_idle_timeout: close idle server-to-server connections
• mod_seclabels: XEP-0258: Security Labels in XMPP
• mod_server_status/mod_stanza_counter: server status plugin
• mod_smacks: XEP-0198: Stream Management
• mod_storage_ldap: LDAP storage (read-only) for rosters and vCards.
• mod_support_contact: add a support contact to new registrations
• mod_turncredentials: XEP-0215: Implementation for time-limited TURN credentials
• mod_vcard_muc: set vCard for MUC rooms, e.g. for MUC room avatars
• mod_vjud: XEP-0055: Jabber Search
• mod_watch_spam_reports: handles incoming XEP-0377: Spam Reporting
• mod_webpresence: display your online status in web pages

There are three methods to install prosody-modules on Ubuntu. We can use apt-get, apt and aptitude. In the following sections we will describe each method. You can choose one of them.

Install prosody-modules Using apt-get

Update apt database with apt-get using the following command.

sudo apt-get update

After updating apt database, We can install prosody-modules using apt-get by running the following command:

sudo apt-get -y install prosody-modules

Install prosody-modules Using apt

Update apt database with apt using the following command.

sudo apt update

After updating apt database, We can install prosody-modules using apt by running the following command:

sudo apt -y install prosody-modules

Install prosody-modules Using aptitude

If you want to follow this method, you might need to install aptitude first since aptitude is usually not installed by default on Ubuntu. Update apt database with aptitude using the following command.

sudo aptitude update

After updating apt database, We can install prosody-modules using aptitude by running the following command:

sudo aptitude -y install prosody-modules

How To Uninstall prosody-modules on Ubuntu

To uninstall only the prosody-modules package we can use the following command:

sudo apt-get remove prosody-modules

Uninstall prosody-modules And Its Dependencies

To uninstall prosody-modules and its dependencies that are no longer needed by Ubuntu, we can use the command below:

sudo apt-get -y autoremove prosody-modules

Remove prosody-modules Configurations and Data

To remove prosody-modules configuration and data from Ubuntu we can use the following command:

sudo apt-get -y purge prosody-modules

Remove prosody-modules configuration, data, and all of its dependencies

We can use the following command to remove prosody-modules configurations, data and all of its dependencies, we can use the following command:

sudo apt-get -y autoremove --purge prosody-modules

Dependencies

prosody-modules have the following dependencies:

• prosody

References

• prosody-modules website

Summary

In this tutorial we learn how to install prosody-modules package on Ubuntu using different package management tools: apt, apt-get and aptitude.