Skip to content

Prosody Prosody

Description / nameInput element
Container Registry
Container Configuration Root Path
Timezone
User ID
Group ID
Prosody Host Port
Prosody /config Path

Build Status Last Commit OCI Pulls

Lightweight XMPP chat server, easy to set up and extend.
Port 5222
Registry ghcr.io/daemonless/prosody
Daemonless daemonless/prosody
Source hg.prosody.im/
Website prosody.im

Version Tags

Tag Description Best For
latest / pkg Installed from the FreeBSD quarterly package repository. Most users — recommended.
pkg-latest Installed from the FreeBSD latest package repository. Alternative build.

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
services:
  prosody:
    image: "ghcr.io/daemonless/prosody:latest"
    container_name: prosody
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - XMPP_DOMAIN=localhost  # Domain in user addresses (user@domain)
    volumes:
      - "/containers/prosody:/config"
    ports:
      - "5222:5222"
      - "5269:5269"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

1
2
3
4
5
6
7
# .env

DIRECTOR_PROJECT=prosody
PUID=1000
PGID=1000
TZ=UTC
XMPP_DOMAIN=localhost

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  prosody:
    name: prosody
    options:
      - container: 'args:--pull'
      - expose: '5222:5222 proto:tcp'
      - expose: '5269:5269 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - XMPP_DOMAIN: !ENV '${XMPP_DOMAIN}'
    volumes:
      - PROSODY_CONFIG_PATH: /config
volumes:
  PROSODY_CONFIG_PATH:
    device: '/containers/prosody'

1
2
3
4
5
6
7
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/prosody:${tag}

Save the files above, then run appjail-director up.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
services:
  prosody:
    name: prosody
    image: "ghcr.io/daemonless/prosody:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - XMPP_DOMAIN=localhost
    volumes:
      - "/containers/prosody:/config"

Save as bastille-compose.yml, then run bastille up.

Setup Instructions

Create an account:

1
podman exec -it prosody prosodyctl adduser user@your.domain

The first boot creates /config/prosody.cfg.lua, and a self-signed certificate for XMPP_DOMAIN in /config/certs. Clients will warn about that certificate, and other servers will refuse it. To use a real one, replace <domain>.crt and <domain>.key there and restart the container.

Modules that serve HTTP, such as WebSocket or file sharing, listen on 5280 and 5281. Enable them in the config and publish those ports.

Interactive Configuration

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container
XMPP_DOMAIN localhost Domain in user addresses (user@domain)

Volumes

Path Description
/config Configuration, certificates and data

Ports

Port Protocol Description
5222 TCP Client connections
5269 TCP Connections from other XMPP servers

Implementation Details

  • Architectures: amd64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).

Need help? Join our Discord community.