Run with Docker Compose

Use this path when you want to build MessageX from the checked-out repository rather than using the launcher.

1. Clone the repositoryCopy Anchor Link

git clone https://github.com/sameeryadav05/MessageX.git
cd MessageX

2. Create the environment fileCopy Anchor Link

macOS / Linux:

cp .env.compose.example .env

Windows PowerShell:

Copy-Item .env.compose.example .env

Edit .env and replace the example database and administrator passwords with strong unique values. Never commit the real .env file.

3. Build and start servicesCopy Anchor Link

docker compose up -d --build

The Compose configuration defines:

The broker waits for PostgreSQL's health check. The dashboard waits for the broker's readiness check. The admin initialization service runs after the broker is healthy.

4. Verify the deploymentCopy Anchor Link

docker compose ps
docker compose logs -f broker

Open the dashboard at http://localhost:15672. The broker's TCP endpoint is localhost:5678.

In this Compose file, PostgreSQL is bound to 127.0.0.1:5433 on the host and listens on 5432 inside the Docker network.

5. Stop the deploymentCopy Anchor Link

docker compose down

This stops and removes containers and the Compose network while preserving named volumes. The following command also removes the persisted PostgreSQL data volume and should only be used when you intentionally want to destroy the local database:

docker compose down -v

Published images vs local buildsCopy Anchor Link

The repository Compose file defaults to locally built images:

• messagex-broker:local
• messagex-dashboard:local

You can override these with BROKER_IMAGE and DASHBOARD_IMAGE in .env. See published Docker images.