Welcome! Follow the steps below to get MigratoryData Platform running locally using Docker Compose.

The setup includes:

  • MigratoryData Server — the pub/sub messaging engine optimized to deliver real-time data to and from millions of web, mobile, and IoT clients over WebSocket connections (messaging plane)
  • MigratoryData Portal — organizes MigratoryData subjects into streaming APIs and makes them available through a centralized API Hub, with a self-service developer experience for discovering, adopting, and testing APIs (management plane)
  • Demo Publishers — sample services that continuously stream live data to the MigratoryData Server, so you have ready-made subjects to explore and test the MigratoryData Portal.

Step 1: Clone the repository

git clone https://github.com/migratorydata/migratorydata-platform-sandbox.git
cd migratorydata-platform-sandbox/docker

Step 2: Start the services

docker compose up -d

This command starts MigratoryData Server, MigratoryData Portal, and Demo Publishers using Docker Compose.

Step 3: Open the Portal

Open http://127.0.0.1:8080 and log in with:

Step 4: Explore the Portal

Use the grid-dots button to switch between the four views:

  • API Hub — browse and discover published streaming APIs.
  • API Manager — create a streaming API and add pub/sub endpoints.
  • Developer Portal — create an App, adopt the API, generate an Access Token, and test it live in the built-in console.
  • Administrator — inspect the Gateway configuration and monitor connected clients and message throughput.

You’re up and running. Next, define and publish a streaming API, then use the built-in tutorials in the Portal to build your first real-time app.

Step 5: Stop the services

To stop and remove containers:

docker compose down

See more details about the stack in the Docker deployment guide.