Quickstart

The fastest evaluation path uses the MessageX Launcher image. The launcher provisions the broker, dashboard, PostgreSQL service, Docker network, and initial administrator account.

1. Start the launcherCopy Anchor Link

The repository README currently references launcher image tag 0.1.8.

docker run -d \
  --name messagex \
  --restart unless-stopped \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v messagex_launcher_data:/data \
  sameeryadav2005/messagex-v2:0.1.8

For a first-time installation, you can set the administrator username and password explicitly:

docker run -d \
  --name messagex \
  --restart unless-stopped \
  -e MESSAGEX_DEFAULT_USER=admin \
  -e MESSAGEX_DEFAULT_PASS='ReplaceWithA_StrongPassword123' \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v messagex_launcher_data:/data \
  sameeryadav2005/messagex-v2:0.1.8

Choose your own password and store it in a secret manager. The password must be at least 12 characters. These variables initialize credentials on first startup; they do not reset an existing account.

Security: The launcher mounts the Docker socket so it can create and manage child containers. Access to the Docker socket is highly privileged. Run the launcher only on a host you trust and protect access to that host.

2. Check startupCopy Anchor Link

docker ps
docker logs -f messagex

If credentials were generated automatically, the README documents this command to retrieve them:

docker exec messagex cat /data/credentials.txt

3. Open the dashboardCopy Anchor Link

Use the administrator credentials created during the first startup.

4. Connect an applicationCopy Anchor Link

Install the Node.js client:

npm install messagex-client

Then follow the JavaScript SDK guide to connect, declare an exchange and queue, publish a message, and consume it.

Stop the stackCopy Anchor Link

docker stop messagex
docker start messagex

To remove the launcher container without deleting its persistent data volume:

docker rm -f messagex

Do not delete the messagex_launcher_data volume unless you intentionally want to remove launcher state.