Prosody modules

Prosody can be customized extensively using modules (plugins) to change its default behaviour and to add new features and functionality.

There are lots of fun and exciting modules to be found here, we know you'll like it. However please note that each module is in a different state of development. Some are proof-of-concept, others are quite stable and ready for production use. Be sure to read the documentation page of any module before installing it on your server.

This directory lets you easily browse through all the modules.

Recently updated

Entire list of all 232 modules

mod_addressing
XEP-0033: Extended Stanza Addressing Stage-Alpha
mod_adhoc_account_management
Personal account management command Stage-Alpha
mod_adhoc_blacklist
Block remote servers via ad-hoc command
mod_admin_blocklist
Block s2s connections based on admin blocklists
mod_admin_message
IM-based administration console Stage-Beta
mod_admin_probe
Allow server administrators to probe any user
mod_admin_web
Web administration interface Stage-Beta
mod_alias
Point alias accounts or domains to correct XMPP user
mod_auth_any
Authentication module that accepts any username and password Type-Auth
mod_auth_ccert
Client Certificate authentication module Stage-Alpha Type-Auth
mod_auth_custom_http
HTTP Authentication using custom JSON protocol
mod_auth_dovecot
Dovecot authentication module Stage-Alpha Type-Auth
mod_auth_external
Authentication via external script/process Stage-Alpha Type-Auth
mod_auth_ha1
Authentication module for 'HA1' hashed credentials in a text file, asused by reTurnServer Stage-Beta Type-Auth
mod_auth_http_async
Async HTTP auth module Stage-Alpha
mod_auth_imap
IMAP authentication module Stage-Alpha Type-Auth
mod_auth_internal_yubikey
Two-factor authentication using Yubikeys Stage-Beta Type-Auth
mod_auth_joomla
Joomla authentication module Stage-Alpha Type-Auth
mod_auth_ldap
LDAP authentication module Stage-Alpha Type-Auth
mod_auth_ldap2
Another take on LDAP authentication Type-Auth
mod_auth_pam
PAM authentication module Stage-Alpha Type-Auth
mod_auth_phpbb3
PHPBB3 authentication module Stage-Alpha Type-Auth
mod_auth_sql
SQL Database authentication module Type-Auth Stage-Stable
mod_auth_wordpress
Wordpress authentication module Stage-Alpha Type-Auth
mod_auto_accept_subscriptions
Automatically accept incoming subscription requests on behalf of users Stage-Beta
mod_auto_activate_hosts
Automatically activate/deactivate hosts on reload Stage-Beta
mod_benchmark_storage
Storage benchmark tool
mod_bidi
XEP-0288: Bidirectional Server-to-Server Connections Stage-Alpha
mod_block_outgoing
Module to block outgoing stanzas from users NeedDocs
mod_block_s2s_subscriptions
New module to block incoming presence subscriptions from non-contacts on selected remote hosts NeedDocs
mod_block_strangers
Module to block message and iqs from people not on your roster NeedDocs
mod_block_subscribes
Block inbound and outbound subscription requests (useful to prevent implicit roster modification) NeedDocs
mod_block_subscriptions
Block incoming and outgoing presence subscriptions (useful in conjunction with mod_readonly) NeedDocs
mod_blocking
XEP-0191: Simple Communications Blocking support Stage-Alpha
mod_broadcast
Broadcast a message to online users Stage-Stable
mod_c2s_conn_throttle
c2s connections throttling module Stage-Stable
mod_c2s_limit_sessions
Limit number of resources a user may connect
mod_candy
Serve Candy from prosody
mod_captcha_registration
provides captcha protection for registration form Stage-Beta
mod_carbons
Message Carbons Stage-Beta
mod_carbons_adhoc
Initial commit. NeedDocs
mod_carbons_copies
Initial commit; allow the user to enable v0 style carbons NeedDocs
mod_checkcerts
Certificate expiry reminder
mod_client_certs
Client-side certificate management for Prosody Stage-Alpha
mod_cloud_notify
XEP-0357: Cloud push notifications Stage-Beta
mod_compact_resource
Enforces short random resources NeedDocs
mod_compat_bind
Compatibility (ugh) with clients that send the resource bind to the login host (ugh) NeedDocs
mod_compat_dialback
Workaround for Dialback with some servers that violate RFC 6120
mod_compat_muc_admin
COMPAT Module for old clients using wrong namespaces in MUC'saffiliation manipulations. Stage-Beta
mod_compat_vcard
Handle vcard requests sent to full JIDs (a spec violation commited by older versions of ejabberd and possibly others) - replaces vcard_compatibility option from Prosody 0.8 NeedDocs
mod_component_client
Initial commit. Allows Prosody to act as an external component for other XMPP servers. NeedDocs
mod_component_roundrobin
Component round-robin load balancing module
mod_conformance_restricted
Send restricted XML for conformance testing
mod_couchdb
A CouchDB backend for Prosody Stage-Alpha Type-Storage
mod_csi
Client State Indication support
mod_csi_compat
Implement the google:queue protocol and map to mod_csi events
mod_data_access
HTTP access to prosody’s storage mechanism
mod_default_bookmarks
Default bookmarked chatrooms
mod_default_vcard
Automatically populate vcard based on account details Stage-Beta
mod_delegation
XEP-0355 (Namespace Delegation) implementation Stage-Alpha
mod_disable_tls
Disable TLS on certain client ports Stage-Beta
mod_discoitems
Manually override the list of service discovery items Stage-Beta
mod_dwd
Dialback-without-Dialback
mod_e2e_policy
Initial commit
mod_email_pass
Initial commit Stage-Beta
mod_extdisco
External Service Discovery
mod_fallback_vcard
Generates missing vcards from a template NeedDocs
mod_filter_chatstates
Drop chat states from messages to inactive sessions
mod_filter_words
Very basic module in its early stages, to filter words in messages NeedDocs
mod_firewall
A rule-based stanza filtering module Stage-Alpha
mod_flash_policy
Adds support for flash socket policy Stage-Alpha
mod_graceful_shutdown
Experiment in improving the shutdown experience
mod_group_bookmarks
mod_groups for chatrooms Stage-Beta
mod_host_blacklist
Similar to mod_s2s_blacklist, but stanza-based. Works between hosts on the same server, at a slight performance impact. NeedDocs
mod_host_guard
Granular remote host blacklisting plugin Stage-Stable
mod_host_status_check
Host status check Stage-Beta
mod_host_status_heartbeat
Host status heartbeat Stage-Beta
mod_http_altconnect
Exposes BOSH and WebSocket endpoints over HTTP per http://legastero.github.io/customxeps/extensions/xep-0156.html#http NeedDocs
mod_http_dir_listing
HTTP directory listing
mod_http_favicon
HTTP favicon
mod_http_host_status_check
HTTP Host Status Check Stage-Beta
mod_http_hostaliases
Give HTTP hosts additional aliases NeedDocs
mod_http_index
Generates an index of local HTTP apps
mod_http_logging
Produce HTTP logs in the style of Apache NeedDocs
mod_http_muc_log
Provides a web interface to stored chatroom logs Stage-Beta
mod_http_roster_admin
Add mod_http_roster_admin NeedDocs
mod_http_upload
Implementation of Conversations HTTP upload file transfer mode Stage-Alpha
mod_http_user_count
HTTP module to report the current number of online users or sessions NeedDocs
mod_idlecompat
XEP-0319 compatibility module Stage-Beta
mod_incidents_handling
Incidents Handling plugin Stage-Beta
mod_inotify_reload
Reload modules when their code changes NeedDocs
mod_invite
Allows users to invite new users Stage-Alpha
mod_ipcheck
XEP-0279: Server IP Check Stage-Stable
mod_isolate_host
Prevent communication between hosts Stage-Beta
mod_jid_prep
Implement XEP-xxxx: JID prep for clients Stage-Alpha
mod_json_streams
JSON Encodings for XMPP Stage-Beta
mod_lastlog
Log last login time Stage-Beta
mod_latex
Replace LaTeX markup in messages with embedded images Stage-Beta
mod_lib_ldap
Library module for LDAP
mod_limit_auth
Throttle authentication attempts with optional tarpit
mod_limits
Connection-level rate limiting Stage-Beta
mod_list_inactive
Parse data collected by mod_lastlog and print users who have not logged in for some time
mod_listusers
added (+config support; -assert tracebacks; +user friendly connection errors; -unneded repeat-until cycle, which braked module) NeedDocs
mod_log_auth
Log failed authentication attempts with their IP address Stage-Stable
mod_log_events
Module to log all events on the server/host NeedDocs
mod_log_mark
Log a message once per minute
mod_log_messages_sql
Fork of mod_mam_sql without the protocol bits NeedDocs
mod_log_rate
Collect statistics on rate of log messages
mod_log_sasl_mech
Logs authentication mechanism used NeedDocs
mod_log_slow_events
Log events that take a long time to process (including stanzas) NeedDocs
mod_mam
XEP-0313: Message Archive Management Stage-Beta
mod_mam_adhoc
Ad-hoc interface to Message Archive Management Settings Stage-Alpha
mod_mam_archive
XEP-0136: Message Archiving frontend for mod_mam Stage-Alpha
mod_mam_muc
XEP-0313: Message Archive Management for MUC Stage-Alpha
mod_mamsub
Experimental implementation of MAM subscriptions NeedDocs
mod_manifesto
Module for raising awareness about the Security Test Days
mod_measure_cpu
Measure CPU usage
mod_measure_memory
Measure memory usage
mod_message_logging
Log/archive all user messages Stage-Beta
mod_migrate
prosodyctl cross storage driver migration tool
mod_motd_sequential
Sequential MOTD messages Stage-Beta
mod_muc_access_control
Module to allow restricting rooms to a list of JIDs, which can include domains NeedDocs
mod_muc_ban_ip
Ban users from chatrooms by their IP address Stage-Alpha
mod_muc_config_restrict
Restrict MUC configuration options to server admins Stage-Alpha
mod_muc_intercom
adds mod_muc_intercom; forwards messages between rooms on a muc host NeedDocs
mod_muc_limits
Impose rate-limits on a MUC Stage-Beta
mod_muc_log
Log chatroom messages to disk Stage-Beta
mod_muc_log_http
Provides a web interface to stored chatroom logs Stage-Beta
mod_muc_restrict_rooms
Regexp based room restriction module
mod_munin
Implementation of the Munin node protocol Stage-Beta
mod_net_dovecotauth
Initial commit of server implementation of the Dovecot authentication protocol
mod_offline_email
Forward offline messages via email Stage-Beta
mod_onhold
Module enabling "on-hold" functionality
mod_onions
s2s to Tor hidden services Stage-Alpha
mod_openid
Enables Prosody to act as an OpenID provider Stage-Alpha
mod_password_policy
Initial commit. NeedDocs
mod_pastebin
Redirect long messages to built-in pastebin Stage-Stable
mod_pep_vcard_avatar
Sync avatars between vCards and PEP Stage-Alpha
mod_pep_vcard_png_avatar
Initial commit
mod_pinger
Added from /files/ NeedDocs
mod_poke_strangers
Query the features and version of JIDs sending messages to contacts they are not subscribed to. Stage-Alpha
mod_post_msg
Receives HTTP POST request, parses it and relays it into XMPP.
mod_presence_cache
Cache presence from remote users
mod_presence_dedup
Presence deduplication module
mod_privacy_lists
Privacy lists (XEP-0016) support Stage-Beta
mod_private_adhoc
Retrieve private XML data via adhoc command
mod_privilege
XEP-0356 (Privileged Entity) implementation Stage-Alpha
mod_proctitle
Set process name to prosody
mod_profile
Replacement for mod_vcard with vcard4 support and PEP integration
mod_proxy65_whitelist
Limit which file transfer users can use Stage-Alpha
mod_pubsub_eventsource
Subscribe to pubsub nodes using the HTML5 EventSource API Stage-Beta
mod_pubsub_feeds
Subscribe to Atom and RSS feeds over pubsub
mod_pubsub_github
Publish Github commits over pubsub Stage-Beta
mod_pubsub_hub
PubSubHubbub hub
mod_pubsub_mqtt
MQTT interface to Prosody's pubsub Stage-Beta
mod_pubsub_pivotaltracker
Accept activity notifications from Pivotal Tracker web hooks and relay them to a pubsub node NeedDocs
mod_pubsub_post
Module to publish to pubsub nodes from a simple HTTP POST NeedDocs
mod_pubsub_twitter
Subscribe to Twitter search queries over pubsub Stage-Alpha
mod_query_client_ver
Query and log client software NeedDocs
mod_rawdebug
Extra verbose logging of sent and received
mod_readonly
Allow preventing direct modification of certain user data via XMPP NeedDocs
mod_register_dnsbl
Initial commit of module to check users registering against an DNS block list NeedDocs
mod_register_json
Token based JSON registration & verification servlet. Stage-Stable
mod_register_redirect
XEP-077 IBR Registration Redirect. Stage-Stable
mod_register_web
A web interface to register user accounts Stage-Alpha
mod_reload_modules
Automatically reload modules with the config Stage-Stable
mod_remote_roster
Remote Roster Management
mod_require_otr
Enforce a policy for OTR-encrypted messages Stage-Stable
mod_roster_allinall
Adds all online users to the roster of newly signed in users, for a lazy everyone-in-everyones roster setup
mod_roster_command
Manage rosters through prosodyctl Stage-Beta
mod_s2s_auth_compat
Workaround for servers doing EXTERNAL without proper stream headers
mod_s2s_auth_dane
S2S authentication using DANE Stage-Alpha Type-S2SAuth
mod_s2s_auth_fingerprint
Fingerprint based s2s authentication Stage-Alpha Type-S2SAuth
mod_s2s_auth_monkeysphere
Monkeysphere certificate checking for s2s Stage-Alpha Type-S2SAuth
mod_s2s_auth_samecert
Authenticate incoming s2s connection if certificate matches that of an established outgoing s2s connection NeedDocs
mod_s2s_blacklist
A new _simple_ s2s blacklist module NeedDocs
mod_s2s_idle_timeout
Close idle server-to-server connections Stage-Stable
mod_s2s_keepalive
Keepalive s2s connections
mod_s2s_keysize_policy
Distrust servers with too small keys
mod_s2s_log_certs
Log certificate status and fingerprint of remote servers
mod_s2s_never_encrypt_blacklist
Stops prosody from including starttls into available features forspecified remote servers. Stage-Beta
mod_s2s_reload_newcomponent
Module to automatically load new components when config:reload is donein console
mod_s2s_whitelist
The opposite of mod_s2s_blacklist NeedDocs
mod_s2soutinjection
S2S connection override
mod_saslauth_muc
Initial commit. Implements SASL auth for MUC rooms <http://xmpp.org/extensions/inbox/remote-auth.html>. NeedDocs
mod_saslname
XEP-0233: Domain-Based Service Names in XMPP SASL Negotiation Stage-Alpha Type-Auth
mod_seclabels
Security Labels Stage-Alpha
mod_secure_interfaces
Mark some network interfaces (e.g. loopback/LAN) as always secure Stage-Beta
mod_server_contact_info
Contact Addresses for XMPP Services Stage-Alpha
mod_server_status
Server status plugin Stage-Stable
mod_service_directories
Initial commit. Untested. Support for both directory and buddy use cases. Incomplete pubsub support (only getting all items supported). NeedDocs
mod_sift
XEP-0273: Stanza Interception and Filtering Technology Stage-Alpha
mod_smacks
XEP-0198: Reliability and fast reconnects for XMPP Stage-Alpha
mod_smacks_offline
Monkeypatch mod_smacks to send unacked messages to offline storage IFF there was only one session NeedDocs
mod_sms_clickatell
XMPP to SMS gateway using the Clickatell API Stage-Alpha
mod_spam_reporting
XEP-0377: Spam Reporting Stage-Beta
mod_srvinjection
Manually specify SRV records Stage-Beta
mod_sslv3_warn
Module to notice users connected with SSLv3 that they need to upgrade becasue SSLv3 is insecure NeedDocs
mod_stanza_counter
Simple incoming and outgoing stanza counter Stage-Stable
mod_statistics
Initial version, and a rough 'prosodyctl mod_statistics top' NeedDocs
mod_statistics_auth
Collects statistics on number of successful or failed authentication attempts NeedDocs
mod_statistics_cputotal
Module that collects accumulated CPU usage statistics NeedDocs
mod_statistics_mem
Module that collects memory usage stats from /proc NeedDocs
mod_statistics_statsd
Module for pushing from util.statistics (0.10) to statsd NeedDocs
mod_statsd
First commit NeedDocs
mod_storage_appendmap
Experimental map store optimized for small incremental changes Stage-Alpha Type-Storage
mod_storage_ejabberdsql_readonly
Ejabberd SQL Read-only Storage Module Type-Storage Stage-Alpha
mod_storage_gdbm
Lua-GDBM storage Stage-Beta Type-Storage ArchiveStorage
mod_storage_ldap
LDAP storage for rosters, groups, and vcards Type-Storage
mod_storage_lmdb
Lightning Memory-Mapped Database storage Stage-Beta Type-Storage
mod_storage_memory
Simple memory-only storage module Stage-Beta Type-Storage ArchiveStorage
mod_storage_mongodb
MongoDB Storage Module Type-Storage Stage-Alpha
mod_storage_muc_log
Storage module using mod_muc_log data with new stanza archive API Stage-Alpha ArchiveStorage
mod_storage_muconference_readonly
MU-Conference SQL Read-only Storage Module Type-Storage Stage-Alpha
mod_storage_multi
Multi-backend storage module (WIP) NeedDocs Stage-Alpha
mod_storage_xmlarchive
XML archive storage Stage-Beta Type-Storage ArchiveStorage
mod_streamstats
New module that streams live stats from Prosody over a TCP stream NeedDocs
mod_strict_https
HTTP Strict Transport Security
mod_support_contact
Add a support contact to new registrations Stage-Stable
mod_swedishchef
Silly little module to convert your conversations to "swedish" Stage-Beta
mod_tcpproxy
TCP-over-XMPP :) Stage-Beta
mod_telnet_tlsinfo
Telnet command for showing TLS info
mod_throttle_presence
Limit presence stanzas to save traffic Stage-Beta
mod_throttle_unsolicited
Limit rate of outgoing unsolicited messages
mod_tls_policy
Cipher policy enforcement with application level error reporting
mod_track_muc_joins
Keep track of joined chat rooms
mod_turncredentials
XEP-0215 implementation for time-limited turn credentials NeedDocs
mod_twitter
Simple example of working component and HTTP polling. Stage-Alpha
mod_uptime_presence
Report server uptime in presence
mod_vjud
XEP-0055: Jabber Search Stage-Alpha
mod_watchuntrusted
Warn admins about outgoing s2s connections that are refused due toinvalid or untrusted certificates Stage-Alpha
mod_webpresence
Display your online status in web pages Stage-Stable