Prosody Container Image

This repository contains a non-root container image for Prosody.

It contains:

• Prosody IM
• LuaRocks (required for prosodyctl install commands)
• Support for initialization scripts

Initialization Scripts

Important

Scripts are run with the user the container starts with. The default user is the non-root user prosody

Container configuration can be customized using initialization scripts mounted to /entrypoint.d/. Scripts in this directory will be executed when launching the container.

This can for example be used for installing prosody modules using prosodyctl install.

Volume Mounts

Tip

Mount your prosody modules into the directory specified in your Prosody configuration to speed up your startup.

Mount Directory	Description
/entrypoint.d/	Initialization shell scripts
/var/lib/prosody/	Prosody data directory
/etc/prosody/	Prosody configuration directory

Usage

Start and manage prosody using the following commands:

Running the server

Preparations

Note

You will need to follow the actions below in order to be able to run the container rootless.

Add a user to your host system with the user id 5222 named prosody for your volume mounts.

groupadd -g 5222 prosody
useradd -u 5222 --system -M -g 5222 prosody

# create prosody config directory (optional)
mkdir -p /etc/prosody
chown -R root:prosody /etc/prosody

# create prosody data directory (optional)
mkdir -p /var/lib/prosody
chown -R prosody:prosody /var/lib/prosody

Environment Variables

Following environment variables can be used to configure the container

Environment Variable	Description
PROSODY_EXTRA_MODULES	Space-separated list of Prosody modules to install on container startup using prosodyctl install

Image startup

Important

Adjust the volume mounts according to your system setup.

docker run -d \
 --name prosody \
 -p 5000:5000/tcp \
 -p 5222:5222/tcp \
 -p 5269:5269/tcp \
 -p 127.0.0.1:5280:5280/tcp \
 -p 5281:5281/tcp \
 -v /etc/prosody/prosody.cfg.lua:/etc/prosody/prosody.cfg.lua:ro \
 -v /var/lib/prosody/:var/lib/prosody/ \
 -v /etc/letsencrypt/live/:/etc/letsencrypt/live/:ro \
 -v /etc/letsencrypt/archive/:/etc/letsencrypt/archive/:ro \
 -e PROSODY_EXTRA_MODULES='mod_http_server mod_cloud_notify mod_vcard_muc' \
 --restart=unless-stopped \
 ghcr.io/error418/prosody:0.12.4

Managing the server

Use docker exec to run commands inside the container.

docker exec prosody prosodyctl status

Let's Encrypt

Add the following renewal hook to letsencrypt:

/etc/letsencrypt/renewal-hooks/deploy/prosody.sh

#!/bin/sh

docker exec -u0 prosody prosodyctl --root cert import /etc/letsencrypt/live

The certbot directory /etc/letsencrypt/live needs to be mounted in the running container.

Note

When starting the server it might be useful to run the above command after prosody container startup to initialize the certificate stores.