coralhl/prosody-docker repository overview

⁠Docker build scripts for Prosody build server

This is the Prosody Docker image building repository. It is used by our build server to build and publish Docker images for stable releases and nightly builds.

⁠Supported tags and respective Dockerfile links

• latest (Dockerfile)⁠

⁠What is Prosody?

Prosody is a modern XMPP communication server. It aims to be easy to set up and configure, and efficient with system resources. Additionally, for developers it aims to be easy to extend and give a flexible system on which to rapidly develop added functionality, or prototype new protocols.

⁠Published images

For images please see here:

• DockerHub⁠
• GitHub⁠

⁠Running

It works by enabling the prosody package repository⁠ and installing the selected Prosody package from there based on the PROSODY_PACKAGE build argument.

Docker images are built off an Alpine Linux 3.22 base: DockerHub⁠ / GitHub⁠.

docker run -d --name prosody -p 5222:5222 coralhl/prosody

⁠Preinstalled additional modules

They are located in /usr/lib/prosody/modules-custom:

• mod_admin_web
• mod_cloud_notify
• mod_muc_moderation
• mod_reload_modules
• mod_sasl2
• mod_sasl2_bind2
• mod_throttle_presence
• mod_vcard_muc

⁠Ports

The image exposes the following ports to the docker host:

• 80: HTTP port
• 443: HTTPS port
• 5000: mod_proxy65 port
• 5222: c2s port
• 5269: s2s port
• 5347: XMPP component port
• 5280: BOSH / websocket port
• 5281: Secure BOSH / websocket port

Note: These default ports can be changed in your configuration file. Therefore if you change these ports will not be exposed.

⁠Volumes

Volumes can be mounted at the following locations for adding in files:

• /etc/prosody:
  • Prosody configuration file(s)
• /etc/prosody/certs:
  • SSL certificates
• /var/lib/prosody:
  • Location for persistent data

⁠Environment Variables

• TZ - Timezone, i.e. "Europe/Moscow".
• PROSODY_ADMINS - Comma-separated list of user addresses treated as admins.
• PROSODY_ENABLE_MODULES - Comma-separated list of additional plugins to load.
• PROSODY_DISABLE_MODULES - Comma-separated list of modules to disable, e.g. for auto-enabled modules.
• PROSODY_TURN_HOST - Hostname of TURN server.
• PROSODY_TURN_PORT - Port number of TURN server.
• PROSODY_TURN_SECRET - Shared secret for TURN.
• PROSODY_TURN_TLS_PORT - Port number for STUN over TLS.
• PROSODY_RETENTION_DAYS - How many days worth of message archives and shared file to keep.
• PROSODY_S2S_SECURE_AUTH - Whether to require that remote servers present valid certificates. Enabled by default.
• PROSODY_C2S_RATE_LIMIT - Rate limit for client-to-server connections. Defaults to 10kb/s.
• PROSODY_S2S_RATE_LIMIT - Rate limit for server-to-server connections. Defaults to 30kb/s.
• PROSODY_STORAGE - Storage driver⁠ to use. Defaults to internal.
• PROSODY_SQL_DRIVER - One of SQLite3, PostgreSQL or MySQL. Selects SQL backend when PROSODY_STORAGE is set to sql.
• PROSODY_SQL_DB - Name of SQL database to use.
• PROSODY_SQL_HOST - Hostname of SQL database to connect to (PostgreSQL and MySQL only).
• PROSODY_SQL_USERNAME, PROSODY_SQL_PASSWORD - Credentials for connecting to SQL database.
• PROSODY_ARCHIVE_EXPIRY_DAYS - When set, overrides PROSODY_RETENTION_DAYS for message archives.
• PROSODY_LOGLEVEL - Log level, one of debug, info, warn, error. Defaults to info.
• PROSODY_STATISTICS - Statistics provider⁠ to use, e.g. internal. Default disabled.
• PROSODY_STATISTICS_INTERVAL - Statistics collection interval. A number or the string manual for OpenMetrics-triggered collection. Defaults to 60.
• PROSODY_CERTIFICATES - Path to TLS certificates and private keys, relative to the config file. Defaults to certs.
• PROSODY_VIRTUAL_HOSTS - Comma-separated list of domain names to initialize as hosts that provide user accounts. Defaults to the hostname of the container. /etc/prosody/certs.
• PROSODY_NETWORK_HOSTNAME - Public domain name for use with e.g. HTTP. Defaults to the first entry in PROSODY_VIRTUAL_HOSTS.
• PROSODY_COMPONENTS - Comma-separated list of internal components in the form name.example.com:type where type can be e.g. muc, http_file_share.
• PROSODY_MUC_MODULES - Comma-separated list of additional modules to enable on a MUC component.
• PROSODY_UPLOAD_EXPIRY_DAYS - When set, overrides PROSODY_RETENTION_DAYS for uploaded files.
• PROSODY_UPLOAD_LIMIT_MB - Size limit in MiB for individual uploaded files.
• PROSODY_UPLOAD_STORAGE_GB - Total amount of storage available for file uploads.
• PROSODY_EXTERNAL_COMPONENTS - Comma-separated list of external components, in the form of name.example.com:secret.
• PROSODY_COMPONENT_SECRET - Component shared secret if not provided as part of PROSODY_EXTERNAL_COMPONENTS.
• PROSODY_EXTRA_CONFIG - Path to additional configuration file. Can contain wildcards. Defaults to /etc/prosody/conf.d/*.cfg.lua.

⁠Example

• configure prosody.cfg.lua⁠

• run

docker run -it \
   -p 5222:5222 \
   -p 5269:5269 \
   -v /data/prosody/configuration:/etc/prosody \
   -v /logs/prosody:/var/log/prosody \
   -v /data/prosody/modules:/usr/lib/prosody-modules \
   coralhl/prosody:0.12

⁠Docker-Compose