mva@mva.name If you have any issues, please contact me, or try to find me in IRC on Freenode, OFTC or RusNet. Vadim A. Misbakh-Soloviov Prosody IM server's community-writen modules This module is a partial implementation of XEP-0033: Extended Stanza Addressing. (info: https://modules.prosody.im/mod_addressing) This module adds an ad-hoc command that lets an user change their password. This is useful for clients that don’t have support for XEP-0077 style password changing. In the future, it may provide other account management commands. (info: https://modules.prosody.im/mod_adhoc_account_management) This module provides the Edit Blacklist ad-hoc command described in XEP-0133 and also performs the actual blocking of incoming and outgoing server-to-server connections. (info: https://modules.prosody.im/mod_adhoc_blacklist) This module uses the blocklists set by admins for blocking s2s connections. (info: https://modules.prosody.im/mod_admin_blocklist) This module provides a console over XMPP. All the commands of the mod_admin_telnet module are available from an XMPP client. (info: https://modules.prosody.im/mod_admin_message) This module lets server administrators send <presence type="probe"/> to any local user and receive their presence in response, bypassing roster checks. (info: https://modules.prosody.im/mod_admin_probe) This module provides a basic web administration interface. It currently gives you access to Ad-Hoc commands on any virtual host or component that you are set as an administrator for in the Prosody config file. It also provides a live list of all S2S and C2S connections. (info: https://modules.prosody.im/mod_admin_web) This module allows you to set up aliases that alert people who try to contact them or add them to their roster what your actual JID is. This is useful for changing JIDs, or just in the case where you own both example.com and example.net, and want people who contact you@example.com to be alerted to contact you at you@example.net instead. (info: https://modules.prosody.im/mod_alias) No documentation yet :( (info: https://modules.prosody.im/mod_atom) This module accepts any username and password, which can be useful for testing. (info: https://modules.prosody.im/mod_auth_any) This module implements PKI-style client certificate authentication. You will therefore need your own Certificate Authority. How to set that up is beyond the current scope of this document. (info: https://modules.prosody.im/mod_auth_ccert) To authenticate users, this module does a POST request to a configured URL with a JSON payload. It is not async so requests block the server until answered. (info: https://modules.prosody.im/mod_auth_custom_http) This is a Prosody authentication plugin which uses Dovecot as the backend. (info: https://modules.prosody.im/mod_auth_dovecot) Allow client authentication to be handled by an external script/process. (info: https://modules.prosody.im/mod_auth_external) This module authenticates users against hashed credentials stored in a plain text file. The format is the same as that used by reTurnServer. (info: https://modules.prosody.im/mod_auth_ha1) This is an experimental authentication module that does an asynchronous HTTP call to verify username and password. (info: https://modules.prosody.im/mod_auth_http_async) This is a Prosody authentication plugin which uses a generic IMAP server as the backend. (info: https://modules.prosody.im/mod_auth_imap) A YubiKey is a small USB one-time-password (OTP) generator. (info: https://modules.prosody.im/mod_auth_internal_yubikey) This module allows you to authenticate against an Joomla database. (info: https://modules.prosody.im/mod_auth_joomla) This is a Prosody authentication plugin which uses LDAP as the backend. (info: https://modules.prosody.im/mod_auth_ldap) See mod_lib_ldap for more information. (info: https://modules.prosody.im/mod_auth_ldap2) This module makes Prosody authenticate users against PAM (Linux Pluggable Authentication Modules) (info: https://modules.prosody.im/mod_auth_pam) This module allows you to authenticate against an PHPBB3 database. (info: https://modules.prosody.im/mod_auth_phpbb3) Allow client authentication to be handled by an SQL database query. (info: https://modules.prosody.im/mod_auth_sql) This module allows you to authenticate against an Wordpress database. (info: https://modules.prosody.im/mod_auth_wordpress) In some environments where all users on the system have mutual trust in each other, it’s sometimes fine to skip the usual authorization process to add someone to your contact list and see their status. (info: https://modules.prosody.im/mod_auto_accept_subscriptions) By default Prosody does not automatically activate/deactivate hosts when they are added to and removed from the configuration. (info: https://modules.prosody.im/mod_auto_activate_hosts) To benchmark mod_storage_internal: (info: https://modules.prosody.im/mod_benchmark_storage) This module implements XEP-0288: Bidirectional Server-to-Server Connections. It allows servers to use a single connection for sending stanzas to each other, instead of two connections (one for stanzas in each direction). (info: https://modules.prosody.im/mod_bidi) This module blocks all outgoing stanzas from a list of users. (info: https://modules.prosody.im/mod_block_outgoing) On a server with public registration it is usually desirable to prevent registration of certain “reserved” accounts, such as “admin”. (info: https://modules.prosody.im/mod_block_registrations) No documentation yet :( (info: https://modules.prosody.im/mod_block_s2s_subscriptions) No documentation yet :( (info: https://modules.prosody.im/mod_block_strangers) No documentation yet :( (info: https://modules.prosody.im/mod_block_subscribes) No documentation yet :( (info: https://modules.prosody.im/mod_block_subscriptions) Privacy lists are a widely implemented protocol for instructing your server on blocking communications with selected users and services. (info: https://modules.prosody.im/mod_blocking) This module largely duplicates the functionality of the standard mod_announce that is included with Prosody. It was developed for compatibility with some clients (e.g. iChat) that do not support ad-hoc commands or sending to JIDs with the format ‘example.com/announce/online’. (info: https://modules.prosody.im/mod_broadcast) This module allows to throttle those client connections which exceed a n*seconds limit. (info: https://modules.prosody.im/mod_c2s_conn_throttle) This module lets you limit number of resources a user may connect. (info: https://modules.prosody.im/mod_c2s_limit_sessions) This is a very simple demo module showing how to serve a BOSH-using web app from prosody. (info: https://modules.prosody.im/mod_candy) Prosody-captcha is a little modification of prosody’s “mod_register.lua” module that provides captcha protection for registration form. (info: https://modules.prosody.im/mod_captcha_registration) This module implements XEP-0280: Message Carbons, allowing users to maintain a shared and synchronized view of all conversations across all their online clients and devices. (info: https://modules.prosody.im/mod_carbons) No documentation yet :( (info: https://modules.prosody.im/mod_carbons_adhoc) No documentation yet :( (info: https://modules.prosody.im/mod_carbons_copies) This module periodically checks your certificate to see if it is about to expire soon. The time before expiry is printed in the logs. About a week before a certificate expires, reminder messages will be sent to admins. (info: https://modules.prosody.im/mod_checkcerts) XEP-0257 specifies a protocol for clients to store and manage client side certificates. When a client presents a stored client side certificate during the TLS handshake, it can log in without supplying a password (using SASL EXTERNAL). This makes it possible to have multiple devices accessing an account, without any of them needing to know the password, and makes it easier to revoke access for a single device. (info: https://modules.prosody.im/mod_client_certs) This is an implementation of the server bits of XEP-0357: Push Notifications. It allows clients to register an “app server” which is notified about new messages while the user is offline, disconnected or the session is hibernated by mod_smacks. Implementation of the “app server” is not included¹. (info: https://modules.prosody.im/mod_cloud_notify) No documentation yet :( (info: https://modules.prosody.im/mod_compact_resource) No documentation yet :( (info: https://modules.prosody.im/mod_compat_bind) This module provides a workaround for servers that do not set the to attribute on stream headers, which is required per RFC6120: (info: https://modules.prosody.im/mod_compat_dialback) Adds compatibility for old clients/libraries attempting to change affiliations and retrieve ’em sending the < http://jabber.org/protocol/muc#owner > xmlns instead of < http://jabber.org/protocol/muc#admin >. (info: https://modules.prosody.im/mod_compat_muc_admin) No documentation yet :( (info: https://modules.prosody.im/mod_compat_vcard) This module turns Prosody hosts into components of other XMPP servers. (info: https://modules.prosody.im/mod_component_client) This module enables multiple instances of external components to connect at the same time, and does round-robin load-balancing of incoming stanzas. (info: https://modules.prosody.im/mod_component_roundrobin) NOTE: XMPP compression has unresolved security concerns, and this module has been removed from Prosody and renamed. (info: https://modules.prosody.im/mod_compression_unsafe) This module sends processing instructions, comments, DTDs and a non predefined entity (defined by the DTD) to the requesting entity. (info: https://modules.prosody.im/mod_conformance_restricted) No documentation yet :( (info: https://modules.prosody.im/mod_conversejs) Note: This module needs updating to the 0.8 storage module API. (info: https://modules.prosody.im/mod_couchdb) This module implements Client State Indication, a way for mobile clients to tell the server that they are sitting in someones pocket and would rather not get some less urgent things pushed to it. (info: https://modules.prosody.im/mod_csi) Please use this module instead of mod_csi_pump if you want timestamping, properly handled carbon copies, support for handling encrypted messages and correctly handled smacks events. (info: https://modules.prosody.im/mod_csi_battery_saver) This module implements the google:queue protocol and maps it to mod_csi events. (info: https://modules.prosody.im/mod_csi_compat) Stanzas are queued in a buffer until either an “important” stanza is encountered or the buffer becomes full. Then all queued stanzas are sent at the same time. This way, nothing is lost or reordered while still allowing for power usage savings by not requiring mobile clients to bring up their radio for unimportant stanzas. (info: https://modules.prosody.im/mod_csi_pump) This module gives HTTP access to prosody’s storage mechanism. It uses normal HTTP verbs and Basic HTTP authentication, so you could call it RESTful if you like buzzwords. (info: https://modules.prosody.im/mod_data_access) This module allows you to add default bookmarks for users. It only kicks in when the user has no existing bookmarks, so users are free to add, change or remove them. (info: https://modules.prosody.im/mod_default_bookmarks) It is possible for the user to supply more than just a username and password when creating an account using mod_register. This module automatically copies over that data to the user’s vcard. (info: https://modules.prosody.im/mod_default_vcard) This module adds “Delayed Delivery”-tags to every message stanza passing the server containing the current time on that server. (info: https://modules.prosody.im/mod_delay) Namespace Delegation is an extension which allows server to delegate some features handling to an entity/component. Typical use case is an external PEP service, but it can be used more generally when your prefered server lack one internal feature and you found an external component which can do it. (info: https://modules.prosody.im/mod_delegation) This module can be used to prevent Prosody from offering TLS on client ports that you specify. This can be useful to work around buggy clients when transport security is not required. (info: https://modules.prosody.im/mod_disable_tls) This Prosody plugin lets you manually override the service discovery items for a host. (info: https://modules.prosody.im/mod_discoitems) This module implements an optimization of the Dialback protocol, by skipping the dialback step for servers presenting a valid certificate. (info: https://modules.prosody.im/mod_dwd) This module was written to encourage usage of End-to-end encryption for chat and MUC messages. It can be configured to warn the sender after every plaintext/unencrypted message or to block all plaintext/unencrypted messages. It also supports MUC and JID whitelisting, so administrators can for example whitelist public support MUCs ;-) (info: https://modules.prosody.im/mod_e2e_policy) This module aims to help in the procedure of user password restoration. To start the restoration, the user must go to an URL provided by this module, fill the JID and email and submit the request. (info: https://modules.prosody.im/mod_email_pass) This module adds support for XEP-0215: External Service Discovery, which lets Prosody advertise non-XMPP services. (info: https://modules.prosody.im/mod_extdisco) No documentation yet :( (info: https://modules.prosody.im/mod_fallback_vcard) Some mobile XMPP client developers consider Chat State Notifications to be a waste of power and bandwidth, especially when the user is not actively looking at their device. This module will filter them out while the session is considered inactive. It depends on mod_csi for deciding when to begin and end filtering. (info: https://modules.prosody.im/mod_filter_chatstates) No documentation yet :( (info: https://modules.prosody.im/mod_filter_words) Note: mod_firewall is in its very early stages. This documentation is liable to change, and some described functionality may be missing, incomplete or contain bugs. (info: https://modules.prosody.im/mod_firewall) This Prosody plugin adds support for flash socket policies. When connecting with a flash client (from a webpage, not an exe) to prosody the flash client requests for an xml “file” on port 584 or the connecting port (5222 in the case of default xmpp). Responding on port 584 is tricky because it requires root priviliges to set up a socket on a port < 1024. (info: https://modules.prosody.im/mod_flash_policy) This module is an experiment about a more graceful shutdown process. (info: https://modules.prosody.im/mod_graceful_shutdown) mod_groups allows you to insert contacts into users’ contact lists. Well mod_group_bookmarks allows you to insert chatrooms into the user’s bookmarks. These are fetched by their client and automatically joined when the log in. (info: https://modules.prosody.im/mod_group_bookmarks) No documentation yet :( (info: https://modules.prosody.im/mod_host_blacklist) As often it’s undesiderable to employ only whitelisting logics in public environments, this module let’s you more selectively restrict access to your hosts (component or server host) either disallowing access completely (with optional exceptions) or blacklisting certain sources. (info: https://modules.prosody.im/mod_host_guard) This module allows you to monitor the state of hosts and components in your Prosody server. For example, it will track whether components are connected and (if the component supports it) listen for heartbeats sent by the component to indicate that it is functioning. (info: https://modules.prosody.im/mod_host_status_check) This module integrates with mod_host_status_check to provide heartbeats at regular intervals. (info: https://modules.prosody.im/mod_host_status_heartbeat) No documentation yet :( (info: https://modules.prosody.im/mod_http_altconnect) This module enforces HTTP Basic authentication across all HTTP endpoints served by Prosody. (info: https://modules.prosody.im/mod_http_authentication) This module generates directory listings when invoked by mod_http_files. See documentation on mod_http_files. (info: https://modules.prosody.im/mod_http_dir_listing) This simple module serves a favicon.ico from prosodys HTTP server and nothing else. (info: https://modules.prosody.im/mod_http_favicon) This module exposes serves over HTTP the information collected by mod_host_status_check and mod_host_status_heartbeat in a convenient format for automated monitoring tools. (info: https://modules.prosody.im/mod_http_host_status_check) No documentation yet :( (info: https://modules.prosody.im/mod_http_hostaliases) This module produces a list of enabled HTTP “apps” exposed from Prosody at http://example.org:5280/, e.g. mod_http_muc_log, mod_http_files or mod_admin_web. If you think Prosodys default “root” web page (a 404 error usually) is boring, this might be the module for you! :) (info: https://modules.prosody.im/mod_http_index) No documentation yet :( (info: https://modules.prosody.im/mod_http_logging) This module provides a built-in web interface to view chatroom logs stored by mod_mam_muc. (info: https://modules.prosody.im/mod_http_muc_log) This module provides a RESTful method for sending XMPP stanzas. (info: https://modules.prosody.im/mod_http_rest) NOTE: THIS MODULE IS RELEASED UNDER THE MOZILLA PUBLIC LICENSE VERSION 2. (info: https://modules.prosody.im/mod_http_roster_admin) This module provides a streaming interface to Prosodys internal statistics via Server-sent events. (info: https://modules.prosody.im/mod_http_stats_stream) This module implements XEP-0363, versions 0.2 and 0.3, which let clients upload files over HTTP. (info: https://modules.prosody.im/mod_http_upload) This module implements XEP-0363, which lets clients upload files over HTTP to an external web server. (info: https://modules.prosody.im/mod_http_upload_external) No documentation yet :( (info: https://modules.prosody.im/mod_http_user_count) This module adds XEP-0319 idle tags to presence stanzas containing XEP-0012: Last Activity tags for idle indication (e.g. supported by libpurple clients). It works on outgoing and incoming presence stanzas. (info: https://modules.prosody.im/mod_idlecompat) This module implements XEP-268. (info: https://modules.prosody.im/mod_incidents_handling) No documentation yet :( (info: https://modules.prosody.im/mod_inotify_reload) This module allows users with an account to generate single-use invite URLs using an ad-hoc command. The invite URLs allow new users to create an account even if public registration is disabled. (info: https://modules.prosody.im/mod_invite) Sometimes for various reasons a client might want to know its IP address as it appears to the server. This simple XEP allows the client to ask the server for the IP address it is connected from. (info: https://modules.prosody.im/mod_ipcheck) In some environments it is desirable to isolate one or more hosts, and prevent communication with external, or even other internal domains. (info: https://modules.prosody.im/mod_isolate_host) This is a plugin that implements the JID prep protocol defined in http://xmpp.org/extensions/inbox/jidprep.html (info: https://modules.prosody.im/mod_jid_prep) This plugin encodes XMPP as JSON. This is an implementation of XEP-0295: JSON Encodings for XMPP. (info: https://modules.prosody.im/mod_json_streams) Simple module that stores the timestamp of when a user logs in. (info: https://modules.prosody.im/mod_lastlog) This module intercepts messages between users and into chatrooms, and attaches a links to a rendered version of any LaTeX in the message. This requires client support for XHTML-IM, and fetching images via HTTP. (info: https://modules.prosody.im/mod_latex) This module is used by other modules to access an LDAP server. It’s pretty useless on its own; you should use it if you want to write your own LDAP-related module, or if you want to use one of mine (mod_auth_ldap2, mod_storage_ldap). (info: https://modules.prosody.im/mod_lib_ldap) This module lets you put a per-IP limit on the number of failed authentication attempts. (info: https://modules.prosody.im/mod_limit_auth) On some servers, especially public ones, it is desired to make sure that everyone gets their fair share of system resources (and no more). (info: https://modules.prosody.im/mod_limits) This module lists those users, who have used their account in a defined time-frame, basically the inverse of mod_list_inactive. (info: https://modules.prosody.im/mod_list_active) This module lists those users, who haven’t used their account in a defined time-frame. (info: https://modules.prosody.im/mod_list_inactive) This module adds a command to prosodyctl for listing users. (info: https://modules.prosody.im/mod_listusers) Prosody doesn’t write IP addresses to its log file by default for privacy reasons (unless debug logging is enabled). (info: https://modules.prosody.im/mod_log_auth) No documentation yet :( (info: https://modules.prosody.im/mod_log_events) This module logs outgoing requests that go via the internal net.http API. (info: https://modules.prosody.im/mod_log_http) This module sends -- MARK -- to the log once per minute. This may be useful to give a sense of how busy the server is or see that logging and timers are still working. (info: https://modules.prosody.im/mod_log_mark) This module logs messages to a SQL database. (info: https://modules.prosody.im/mod_log_messages_sql) If you ever wanted to collect statistics on the number of log messages, this is the module for you! (info: https://modules.prosody.im/mod_log_rate) No documentation yet :( (info: https://modules.prosody.im/mod_log_sasl_mech) No documentation yet :( (info: https://modules.prosody.im/mod_log_slow_events) Implementation of XEP-0313: Message Archive Management. (info: https://modules.prosody.im/mod_mam) This module complements mod_mam by allowing clients to change archiving preferences through an Ad-hoc command. (info: https://modules.prosody.im/mod_mam_adhoc) Implementation of XEP-0136: Message Archiving for mod_mam. (info: https://modules.prosody.im/mod_mam_archive) This module logs the conversation of chatrooms running on the server to Prosody’s archive storage. To access them you will need a client with support for XEP-0313: Message Archive Management or a module such as mod_http_muc_log. (info: https://modules.prosody.im/mod_mam_muc) No documentation yet :( (info: https://modules.prosody.im/mod_mamsub) This module informs users about the XMPP Test day and whether their contacts are affected. For mor info about the test day, see https://stpeter.im/journal/1496.html (info: https://modules.prosody.im/mod_manifesto) This module measures the number of resources of a certain show (available, away, etc.) currently connected, and reports using Prosody 0.10 APIs (info: https://modules.prosody.im/mod_measure_client_presence) This module measures CPU usage and reports using Prosody 0.10 APIs (info: https://modules.prosody.im/mod_measure_cpu) This module collects stats from util.pposix.meminfo usage and reports using Prosody 0.10 APIs (info: https://modules.prosody.im/mod_measure_malloc) This module measures memory usage and reports using Prosody 0.10 APIs (info: https://modules.prosody.im/mod_measure_memory) Simple module that collects statistics on message length in bytes, word count and line count. (info: https://modules.prosody.im/mod_measure_message_length) This module measures the number of stanzas handled and reports using Prosody 0.10 APIs (info: https://modules.prosody.im/mod_measure_stanza_counts) This module collects statistics from storage operations. (info: https://modules.prosody.im/mod_measure_storage) Often service administrators need to log their users’ messages for reasons such as auditing and compliance. This module simply logs user messages to simple text files, which can be easily searched, archived or removed on a regular basis. (info: https://modules.prosody.im/mod_message_logging) This module adds a command to prosodyctl for copying data between storage drivers. (info: https://modules.prosody.im/mod_migrate) mod_motd_sequential is a variant of mod_motd that lets you specify a sequence of MOTD messages instead of a single static one. Each message is only sent once and the module keeps track of who as seen which message. (info: https://modules.prosody.im/mod_motd_sequential) No documentation yet :( (info: https://modules.prosody.im/mod_muc_access_control) One frequent complaint about XMPP chatrooms (MUCs) compared to IRC is the inability for a room admin to ban a user based on their IP address. This is because an XMPP user is not identified on the network by their IP address, only their JID. (info: https://modules.prosody.im/mod_muc_ban_ip) This module prevents unaffiliated users from sending private messages in chat rooms, unless someone with an affiliation (member, admin etc) messages them first. (info: https://modules.prosody.im/mod_muc_block_pm) Sometimes, especially on public services, you may want to allow people to create their own rooms, but prevent some options from being modified by normal users. (info: https://modules.prosody.im/mod_muc_config_restrict) This module allows sending a message to another MUC room. (info: https://modules.prosody.im/mod_muc_intercom) This module allows you to control the maximum rate of ‘events’ in a MUC room. This makes it useful to prevent room floods (whether malicious or accidental). (info: https://modules.prosody.im/mod_muc_limits) This module logs the conversation of chatrooms running on the server to Prosody’s data store. To view them you will need a module such as mod_muc_log_http. (info: https://modules.prosody.im/mod_muc_log) This module provides a built-in web interface to view chatroom logs stored by mod_muc_log. (info: https://modules.prosody.im/mod_muc_log_http) This module allows disabling room creation based on regexp patterns defined in configuration. (info: https://modules.prosody.im/mod_muc_restrict_rooms) This module implements the Munin reporting protocol, allowing you to collect statistics directly from Prosody into Munin. (info: https://modules.prosody.im/mod_munin) mod_net_dovecotauth is a server implementation of the Dovecot authentication protocol. It allows you to authenticate e.g. Postfix against your Prosody installation. (info: https://modules.prosody.im/mod_net_dovecotauth) Quite often when I am out and about, I’m not able to connect to Jabber. It is usually much more likely I can access my email though (whether via the web, or a mobile client). (info: https://modules.prosody.im/mod_offline_email) Enable mod_onhold to allow temporarily placing messages from particular JIDs “on hold” – i.e. store them, but do not deliver them until the hold status is taken away. (info: https://modules.prosody.im/mod_onhold) This plugin allows Prosody to connect to other servers that are running as a Tor hidden service. Running Prosody on a hidden service works without this module, this module is only necessary to allow Prosody to federate to hidden XMPP servers. (info: https://modules.prosody.im/mod_onions) OpenID is an decentralized authentication mechanism for the Web. mod_openid turns Prosody into an OpenID provider, allowing users to use their Prosody credentials to authenticate with various third party websites. (info: https://modules.prosody.im/mod_openid) No documentation yet :( (info: https://modules.prosody.im/mod_password_policy) Pastebins are used very often in IM, especially in chat rooms. You have a long log or command output which you need to send to someone over IM, and don’t want to fill their message window with it. Put it on a pastebin site, and give them the URL instead, simple. (info: https://modules.prosody.im/mod_pastebin) No documentation yet :( (info: https://modules.prosody.im/mod_pep_plus) This module pushes the users nickname and avatar from vCards into PEP, or into vCards from PEP. This allows interop between older clients that use XEP-0153: vCard-Based Avatars to see the avatars of clients that use XEP-0084: User Avatar and vice versa. (info: https://modules.prosody.im/mod_pep_vcard_avatar) Conversations (an XMPP client for Android) is publishing PEP avatars in the webp file format. However Pidgin and other XMPP desktop clients can only show vcard avatars, that are in the PNG file format. This module is the mod_pep_vcard_avatar module extended to also change the avatar file format to PNG. (info: https://modules.prosody.im/mod_pep_vcard_png_avatar) This module creates stub configuration files for newly activated hosts. (info: https://modules.prosody.im/mod_persisthosts) No documentation yet :( (info: https://modules.prosody.im/mod_pinger) In order to build heuristics for which messages are spam, it is necessary to log as many details as possible about the spammers. This module sends a version and disco query whenever a message is received from a JID to a user it is not subscribed to. The results are printed to Prosody’s log file at the ‘info’ level. Queried full JIDs are not queried again until Prosody restarts. (info: https://modules.prosody.im/mod_poke_strangers) Sometimes it’s useful to have different interfaces to access XMPP. (info: https://modules.prosody.im/mod_post_msg) This module stores a timestamp of the latest presence received from users contacts so that the client can see who is online faster when they sign in, and won’t have to wait for remote servers to reply. (info: https://modules.prosody.im/mod_presence_cache) This module tries to squash incoming identical presence stanzas to save some bandwith at the cost of increased memory use. (info: https://modules.prosody.im/mod_presence_dedup) Privacy lists are a flexible method for blocking communications. (info: https://modules.prosody.im/mod_privacy_lists) This is a very simple module which implements an adhoc commant toretrieves the users private XML data. (info: https://modules.prosody.im/mod_private_adhoc) Privileged Entity is an extension which allows entity/component to have privileged access to server (set/get roster, send message on behalf of server, access presence informations). It can be used to build services independently of server (e.g.: PEP service). (info: https://modules.prosody.im/mod_privilege) This module sets the process name to prosody so it shows up as such instead of lua in process management tools. (info: https://modules.prosody.im/mod_proctitle) This module provides a replacement for mod_vcard. In addition to the ageing protocol defined by XEP-0054, it also supports the new vCard 4 based protocol and integrates with Personal Eventing Protocol. The vCard 4, User Avatar and User Nickname PEP nodes are updated when the vCard is changed.. (info: https://modules.prosody.im/mod_profile) This module attempts to restrict use of non-whitelisted XEP-0065 proxies. (info: https://modules.prosody.im/mod_proxy65_whitelist) Server-Sent Events is a simple HTTP/line-based protocol supported in HTML5, making it easy to receive a stream of “events” in realtime using the Javascript EventSource API. (info: https://modules.prosody.im/mod_pubsub_eventsource) This module allows Prosody to fetch Atom and RSS feeds for you, and push new results to subscribers over XMPP. (info: https://modules.prosody.im/mod_pubsub_feeds) This module accepts Github web hooks and publishes them to a local pubsub component for XMPP clients to subscribe to. (info: https://modules.prosody.im/mod_pubsub_github) This module implements a PubSubHubbub (PuSH) hub, allowing PuSH clients to subscribe to local XMPP Publish-Subscribe nodes stored by mod_pubsub and receive real time updates to feeds. (info: https://modules.prosody.im/mod_pubsub_hub) MQTT is a lightweight binary pubsub protocol suited to embedded devices. This module provides a way for MQTT clients to connect to Prosody and publish or subscribe to local pubsub nodes. (info: https://modules.prosody.im/mod_pubsub_mqtt) No documentation yet :( (info: https://modules.prosody.im/mod_pubsub_pivotaltracker) No documentation yet :( (info: https://modules.prosody.im/mod_pubsub_post) Twitter has an open ‘realtime’ search API, but it requires polling (within their rate limits). This module allows Prosody to poll for you, and push new results to subscribers over XMPP. (info: https://modules.prosody.im/mod_pubsub_twitter) No documentation yet :( (info: https://modules.prosody.im/mod_query_client_ver) Sometimes it is useful to get the raw XML logs from clients for debugging purposes, but some clients don’t expose this. (info: https://modules.prosody.im/mod_rawdebug) No documentation yet :( (info: https://modules.prosody.im/mod_readonly) This module checks the IP address of newly registered users against a DNS block list. If a positive match is found, it gets logged. (info: https://modules.prosody.im/mod_register_dnsbl) This module let’s you activate a httpserver interface to handle data from webforms with POST and Base64 encoded JSON. (info: https://modules.prosody.im/mod_register_json) Registration Redirect as explained in the IBR XEP. (info: https://modules.prosody.im/mod_register_redirect) There are various reasons to prefer web registration instead of “in-band” account registration over XMPP. For example the lack of CAPTCHA support in clients and servers. (info: https://modules.prosody.im/mod_register_web) This module allows to load/unload external components after they have been added/removed to a configuration file. It is necessary to explicitly initiate a reload on Prosody either via prosodyctl reload or config:reload(). (info: https://modules.prosody.im/mod_reload_components) By default Prosody does not reload modules at runtime unless instructed to via one of its admin interfaces. However sometimes you want to easily reload a module to apply new settings when the config changes. (info: https://modules.prosody.im/mod_reload_modules) This module adds support for XEP-0321: Remote Roster Management which is commonly used to allow components such as transports to modify the rosters of local users. (info: https://modules.prosody.im/mod_remote_roster) OTR, “Off The Record”, encryption allows clients to encrypt messages such that the server cannot read/modify them. (info: https://modules.prosody.im/mod_require_otr) This module is similar in purpouse to mod_groups, for when you want all users on the server to be in each others roster. (info: https://modules.prosody.im/mod_roster_allinall) This module allows you to perform various actions on user rosters via prosodyctl. (info: https://modules.prosody.im/mod_roster_command) This module is a workaround for servers that try to do s2s authentication with certificates and SASL EXTERNAL, but do not send correct stream headers. Notably Openfire versions since 3.7 or 3.8. (info: https://modules.prosody.im/mod_s2s_auth_compat) This module implements DANE as described in Using DNS Security Extensions (DNSSEC) and DNS-based Authentication of Named Entities (DANE) as a Prooftype for XMPP Domain Name Associations. (info: https://modules.prosody.im/mod_s2s_auth_dane) This module allows you to manually pin certificate fingerprints of remote servers. (info: https://modules.prosody.im/mod_s2s_auth_fingerprint) Monkeysphere is a project aiming to introduce PGP’s web of trust to protocols such as SSH and TLS (which XMPP uses). (info: https://modules.prosody.im/mod_s2s_auth_monkeysphere) No documentation yet :( (info: https://modules.prosody.im/mod_s2s_auth_samecert) No documentation yet :( (info: https://modules.prosody.im/mod_s2s_blacklist) Some people find it preferable to close server-to-server connections after they have been silent for a while. (info: https://modules.prosody.im/mod_s2s_idle_timeout) This module periodically sends XEP-0199 ping requests to remote servers to keep your connection alive. (info: https://modules.prosody.im/mod_s2s_keepalive) This module sets the security status of s2s connections to invalid if their key is too small and their certificate was issued after 2014, per CA/B Forum guidelines. (info: https://modules.prosody.im/mod_s2s_keysize_policy) This module produces info level log messages with the certificate status and fingerprint every time an s2s connection is established. It can also optionally store this in persistant storage. (info: https://modules.prosody.im/mod_s2s_log_certs) Let’s you stop Prosody from sending <starttls xmlns=‘urn:ietf:params:xml:ns:xmpp-tls’> feature to choppy/buggy servers which therefore would fail to re-negotiate and use a secure stream. (e.g. OpenFire 3.7.0) (info: https://modules.prosody.im/mod_s2s_never_encrypt_blacklist) Currently, module:reload command in console doesn’t load new components. This module will automatically load the new components (if any) when the config:reload command is run in the console. (info: https://modules.prosody.im/mod_s2s_reload_newcomponent) No documentation yet :( (info: https://modules.prosody.im/mod_s2s_whitelist) This module is similar to mod_srvinjection but less of an hack. (info: https://modules.prosody.im/mod_s2soutinjection) No documentation yet :( (info: https://modules.prosody.im/mod_saslauth_muc) This module implements a manual method for advertsing the Kerberos principal name as per XEP-0233. It could be used in conjection with a Kerberos authentication module. (info: https://modules.prosody.im/mod_saslname) This module implements XEP-0258: Security Labels in XMPP, but not actual policy enforcement. See for example mod_firewall for that. (info: https://modules.prosody.im/mod_seclabels) Sometimes you might run clients without encryption on the same machine or LAN as Prosody - and you want Prosody to treat them as secure ( e.g. allowing plaintext authentication) even though they are not encrypted. (info: https://modules.prosody.im/mod_secure_interfaces) This module lets you advertise various contact addresses for your XMPP service via XEP-0157. (info: https://modules.prosody.im/mod_server_contact_info) This module fetches the current status of configured hosts and/or stanza statistics from mod_stanza_counter. And outputs it in either XML or JSON format. (info: https://modules.prosody.im/mod_server_status) No documentation yet :( (info: https://modules.prosody.im/mod_service_directories) SIFT is a technology to allow clients to filter incoming traffic on the server. This helps save bandwidth, etc. (info: https://modules.prosody.im/mod_sift) By default XMPP is as reliable as your network is. Unfortunately in some cases that is not very reliable - in some network conditions disconnects can be frequent and message loss can occur. (info: https://modules.prosody.im/mod_smacks) By default mod_smacks sends back error stanzas for every unacked message stanza when the hibernation times out. This leads to “message not delivered” errors displayed in clients. (info: https://modules.prosody.im/mod_smacks_noerror) No documentation yet :( (info: https://modules.prosody.im/mod_smacks_offline) This module provides and SMS gateway component which uses the Clickatell HTTP API to deliver text messages. See clickatell.com for details on their services. Note that at present, this is entirely one way: replies will either go nowhere or as sms to the source number you specify. (info: https://modules.prosody.im/mod_sms_clickatell) This module is a very basic implementation of XEP-0377: Spam Reporting. (info: https://modules.prosody.im/mod_spam_reporting) This Prosody plugin lets you manually override SRV records used for a remote host. (info: https://modules.prosody.im/mod_srvinjection) No documentation yet :( (info: https://modules.prosody.im/mod_sslv3_warn) This module counts incoming and outgoing stanzas from when the instance started, and makes the data available to other modules by creating a global prosody. object (info: https://modules.prosody.im/mod_stanza_counter) This module logs the full stanzas that are sent and received into debug logs, for debugging purposes. (info: https://modules.prosody.im/mod_stanzadebug) No documentation yet :( (info: https://modules.prosody.im/mod_statistics) No documentation yet :( (info: https://modules.prosody.im/mod_statistics_auth) No documentation yet :( (info: https://modules.prosody.im/mod_statistics_cputotal) No documentation yet :( (info: https://modules.prosody.im/mod_statistics_mem) No documentation yet :( (info: https://modules.prosody.im/mod_statistics_statsd) No documentation yet :( (info: https://modules.prosody.im/mod_statsd) This is an experimental storage driver where changed data is appended. Data is simply written as key = value pairs to the end of the file. This allows changes to individual keys to be written without needing to write out the entire object again, but reads would grow gradually larger as it still needs to read old overwritten keys. This may be suitable for e.g. rosters where individual contacts are changed at a time. In theory, this could also allow rolling back changes. (info: https://modules.prosody.im/mod_storage_appendmap) This is a storage backend using Ejabberd’s SQL backend. It depends on LuaDBI (info: https://modules.prosody.im/mod_storage_ejabberdsql_readonly) This is a storage module using GNU DBM as backend. It supports archives. (info: https://modules.prosody.im/mod_storage_gdbm) See mod_lib_ldap for more information. (info: https://modules.prosody.im/mod_storage_ldap) This is a storage module using OpenLDAP Lightning Memory-Mapped Database as backend. (info: https://modules.prosody.im/mod_storage_lmdb) This module acts as a normal storage module for Prosody, but saves all data in memory only. All data is lost when the server stops. This makes it useful for testing, or certain specialized applications. (info: https://modules.prosody.im/mod_storage_memory) This is a storage backend that uses MongoDB. Depends on luamongo bindings (info: https://modules.prosody.im/mod_storage_mongodb) mod_muc_log provided logging of chatrooms running on the server to Prosody’s data store. This module gives access to this data using the 0.10+ stanza archive API, allowing legacy log data to be used with mod_mam_muc and mod_http_muc_log. (info: https://modules.prosody.im/mod_storage_muc_log) This is a storage backend using MU-Conference’s SQL storage. It depends on LuaDBI (info: https://modules.prosody.im/mod_storage_muconference_readonly) This module attemtps to provide a storage driver that is really multiple storage drivers. This could be used for storage error tolerance or caching of data in a faster storage driver. (info: https://modules.prosody.im/mod_storage_multi) This module implements stanza archives using files, similar to the default “internal” storage. (info: https://modules.prosody.im/mod_storage_xmlarchive) No documentation yet :( (info: https://modules.prosody.im/mod_streamstats) This module implements HTTP Strict Transport Security and responds to all non-HTTPS requests with a 301 Moved Permanently redirect to the HTTPS equivalent of the path. (info: https://modules.prosody.im/mod_strict_https) This Prosody plugin adds a default contact to newly registered accounts. (info: https://modules.prosody.im/mod_support_contact) This module does some conversions on message bodys passed through it causing them to look like our beloved swedish chef had typed them. (info: https://modules.prosody.im/mod_swedishchef) It happens occasionally that I would like to use the XMPP server as a generic proxy for connecting to another service. It is especially awkward in some environments, and impossible in (for example) Javascript inside a web browser. (info: https://modules.prosody.im/mod_tcpproxy) This module adds two commands to the telnet console, c2s:showtls() and s2s:showtls(). These commands shows TLS parameters, such as ciphers and key agreement protocols, of all c2s or s2s connections. (info: https://modules.prosody.im/mod_telnet_tlsinfo) For most people ‘presence’ (status changes) of contacts make up most of the traffic received by their client. However much of the time it is not essential to have highly accurate presence information. (info: https://modules.prosody.im/mod_throttle_presence) This module limits the rate of outgoing unsolicited messages from local clients. Optionally, unsolicited messages coming in from remote servers may be limited per s2s conneciton. A message counts as “unsolicited” if the receiving user hasn’t added the sending user to their roster. (info: https://modules.prosody.im/mod_throttle_unsolicited) This module arose from discussions at the XMPP Summit about enforcing better ciphers in TLS. It may seem attractive to disallow some insecure ciphers or require forward secrecy, but doing this at the TLS level would the user with an unhelpful “Encryption failed” message. This module does this enforcing at the application level, allowing better error messages. (info: https://modules.prosody.im/mod_tls_policy) This module writes out a traceback to traceback.txt in Prosodys data directory (see prosodyctl about) when the signal SIGUSR1 is received. This is useful when debugging seemingly frozen instances in case it is stuck in Lua code. (info: https://modules.prosody.im/mod_traceback) This module attempts to keep track of what MUC chat rooms users have joined. It’s not very useful on its own, but can be used by other modules to influence decisions. (info: https://modules.prosody.im/mod_track_muc_joins) XEP-0215 implementation for time-limited TURN credentials. (info: https://modules.prosody.im/mod_turncredentials) Twitter has simple API to use, so I tried to deal with it via Prosody. I didn’t manage to finish this module, but it is nice example of component that accepts registrations, unregistrations, does HTTP polling and so on. Maybe someone will finnish this idea. (info: https://modules.prosody.im/mod_twitter) This module simply responds to a presence probe sent to the server with a presence staza containing a timestamp from when the server started. (info: https://modules.prosody.im/mod_uptime_presence) Basic implementation of XEP-0055: Jabber Search. (info: https://modules.prosody.im/mod_vjud) Similar to mod_watchregistrations, this module warns admins when an s2s connection fails due for encryption or trust reasons. (info: https://modules.prosody.im/mod_watchuntrusted) Quite often you may want to publish your Jabber status to your blog or website. mod_webpresence allows you to do exactly this. (info: https://modules.prosody.im/mod_webpresence)