sameeryadav2005/messagex-dashboard-v2 repository overview

Self-hosted Message Broker Management Dashboard

⁠MessageX Dashboard

Repository: sameeryadav2005/messagex-dashboard-v2

MessageX Dashboard is the web-based management interface for MessageX Broker. It provides a browser interface for managing broker resources and monitoring messaging activity.

⁠Features

• Web-based management interface
• Administrator authentication
• Queue management
• Exchange management
• Binding management
• Message publishing
• Connection monitoring
• Broker statistics and monitoring
• API communication through Nginx reverse proxy
• Lightweight Nginx-based production image

⁠Architecture

        Developer Browser
                |
                | HTTP :15672
                v
        MessageX Dashboard
              Nginx
                |
                | Internal HTTP :3000
                v
         MessageX Broker
                |
                v
           PostgreSQL

The dashboard communicates with the broker through the internal Docker network. It does not connect directly to PostgreSQL.

⁠Requirements

• Docker Engine
• A running MessageX Broker
• Broker management API reachable at broker:3000
• Dashboard and broker connected to the same Docker network

⁠Pull Image

docker pull sameeryadav2005/messagex-dashboard-v2:0.1.4

⁠Recommended Installation

For the easiest complete installation, use the MessageX Launcher:

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

The launcher configures the broker, dashboard, PostgreSQL, networking, and administrator account automatically.

⁠Manual Dashboard Setup

The dashboard requires a broker accessible through the Docker network using the service name broker.

⁠1. Create or use an existing Docker network

docker network create messagex-net

⁠2. Ensure the broker has the network alias broker

When creating the broker container, include:

--network messagex-net \
--network-alias broker

The broker management API must be listening on port 3000 inside the Docker network.

⁠3. Run the dashboard

docker run -d \
  --name messagex-dashboard \
  --restart unless-stopped \
  --network messagex-net \
  -p 15672:80 \
  sameeryadav2005/messagex-dashboard-v2:0.1.4

⁠4. Open the dashboard

http://localhost:15672

Log in using the administrator credentials initialized in MessageX Broker.

⁠Docker Networking

The dashboard Nginx configuration forwards API requests to:

http://broker:3000

Therefore:

• The broker and dashboard must share a Docker network.
• The broker must be resolvable using the hostname broker.
• The broker management API must listen on port 3000.
• Do not expose the broker management API publicly.

⁠Ports

Default Docker mapping:

-p 15672:80

To use host port 8080:

-p 8080:80

Then access:

http://localhost:8080

⁠Nginx Configuration

The image includes an Nginx configuration that:

• Serves the React dashboard.
• Proxies /api/ requests to broker:3000.
• Proxies health requests to the broker.
• Supports React Router fallback using index.html.
• Hides the Nginx server version.

The broker hostname is configured in the bundled Nginx configuration. Keep the Docker network alias consistent.

⁠Useful Commands

# Dashboard logs
docker logs -f messagex-dashboard

# Restart
docker restart messagex-dashboard

# Stop
docker stop messagex-dashboard

# Start
docker start messagex-dashboard

# Inspect container
docker inspect messagex-dashboard

⁠Security Notes

• The dashboard uses HTTP by default, not HTTPS.
• Restrict dashboard access to trusted users and networks.
• Use strong administrator credentials.
• Keep the broker management API port 3000 private.
• The dashboard requires a working connection to the MessageX Broker.

⁠Related Repositories

• MessageX Launcher⁠
• MessageX Broker⁠
• GitHub Source Code⁠

MessageX — Your infrastructure. Your messages. Your control.