Run a microservices site
Start an MDK site from the PM2 or Docker microservices example.
This thin page directs you to the correct location for the prerequisites, config fields, run command, smoke test, and troubleshooting.
Overview
Use the microservices site example when you want the Gateway and Workers to run as separate OS processes or containers.
This page is the task guide for the microservices topology. The deployment topologies concept explains when to choose microservices instead of single-process.
Use this topology when
- You need supervisor-managed restarts and logs
- You want to restart or scale one service without restarting the others
- You want a production-like layout for Gateway and Workers
Run the example
The examples/backend/site/ example starts only the Gateway and Worker processes — Kernel must run
separately. For a self-contained example that starts every service including Kernel, use
examples/site-backend/ instead.
Follow the microservices site example:
- Start with the prerequisites
- Use the PM2 steps for local process supervision on one host
- Use the Docker steps when you want containerized services or Compose-managed startup
Next steps
- Compare the supported shapes: Deployment topologies
- Run the simpler local topology — Run a single-process site
- Register a single miner before building a site config — Run a miner Worker