15eb9b18e3
The root README lacked an overview of what each deployment directory provides, making it harder for new users to choose the right setup for their testing scenario. Adds a "Deployment Options" table summarising simple, federation, cluster, cluster_with_federation, and proxy configurations. |
||
|---|---|---|
| _common | ||
| cluster | ||
| cluster_with_federation | ||
| federation | ||
| proxy | ||
| scripts | ||
| simple | ||
| .gitignore | ||
| README.md | ||
| stop.sh | ||
README.md
Multiple Openfires in Docker
Quickly create multiple Openfire servers with associated PostgreSQL DBs in Docker containers for local testing.
Data and config snapshots have been taken of each DB and Openfire server so that a known desired state is configured on start. See the "How it's built" section below if you want to understand how this was done or need to add more nodes.
Prerequisites
-
Docker Compose - https://docs.docker.com/compose/install/
docker build -t openfire:latest .
Quick Start
- Make sure you have docker and docker-compose installed
- Create a local Openfire docker image, tagged
openfire:latestthat contains the version of Openfire that you want to run- run
docker build --tag openfire:latest .in the root of the Openfire repository (https://github.com/igniterealtime/Openfire)
- run
- Launch the environment using the
start.shin the directory of your choice.
Deployment Options
Each directory contains a different deployment configuration. Choose the one that matches your testing scenario:
| Directory | Description |
|---|---|
simple/ |
Single Openfire server with PostgreSQL database. The simplest configuration for basic testing and development. |
federation/ |
Two independent Openfire servers on separate domains (xmpp1.localhost.example and xmpp2.localhost.example), each with their own database. Use this to test server-to-server (S2S) federation between XMPP domains. |
cluster/ |
Three Openfire servers sharing a single database, with an nginx load balancer. Tests Openfire's clustering capabilities using the Hazelcast plugin. |
cluster_with_federation/ |
A 3-node Openfire cluster plus an additional standalone Openfire server on a different domain (otherxmpp.localhost.example). Use this to test clustering and federation simultaneously. |
proxy/ |
Single Openfire server with an nginx reverse proxy in front. Use this to test proxy configurations and header handling. |
All configurations support optional IPv6 networking via the -6 flag to start.sh. See the README in each directory for detailed information about ports, users, and network configuration.
How it's built
To recreate the known good state for the system we first create base Openfire and relevant database containers. We then perform the manual setup and any other configuration that we require, such as adding users and MUC rooms. Once the setup is complete we dump the database from the container to the Docker host and copy the Openfire config files from the container to the Docker host. These are then used with Docker volumes for creating the same state in subsequent Openfire and database containers.
SQL Initialisation Scripts
Each deployment option includes SQL files in a sql/ directory that are mounted to /docker-entrypoint-initdb.d in the PostgreSQL container. PostgreSQL executes these files alphabetically on first startup.
SQL files use numeric prefixes to control execution order:
000-init-openfire.sql- Schema initialisation (must run first)001-*.sql,002-*.sql, etc. - Additional seed data or configuration
If you need to add custom SQL scripts (e.g., for test data or configuration), use an appropriate numeric prefix to ensure correct execution order.