Skip to main content

Run with Docker Compose

Docker Compose is the fastest way to run a real Zaris cluster on your own machine. One command brings up a 3-node cluster, a Management Service, and the Web Console, with a store already created for you. It uses the exact same client API as every other mode — only the connection string points at a network address instead of inproc.

Prerequisites​

You need Docker with Compose v2 (docker compose, included with Docker Desktop). No Zaris installation is required — the images are pulled for you.

1. Download the Compose file​

Download the published quick-start Compose file:

curl -fL https://clustron.io/quick-start.yml -o quick-start.yml
note

https://clustron.io/quick-start.yml is the canonical URL the maintainers host. Until it is published, use the compose/quick-start.yml file from the release bundle instead — the commands below are identical once you have the file locally.

2. Start the cluster​

Bring everything up in the background:

docker compose -f quick-start.yml up -d

This starts a 3-node Zaris cluster, a Management Service, and the Web Console. A bootstrap service creates a store named demo automatically, so there is no store-creation step to run yourself.

The Web Console is available at:

http://localhost:7810

3. Connect​

From an application running on your host, connect to the store on the client port:

zaris://localhost:7861/demo

From another container on the same Compose network, connect to the nodes by their service names:

zaris://zaris-0:7861,zaris-1:7861,zaris-2:7861/demo

Listing all three nodes gives the client more than one seed to start from, so it can connect even if one node is unavailable.

4. Tear down​

When you're done, stop the cluster and remove its volumes:

docker compose -f quick-start.yml down -v

What you just did​

You brought up a real 3-node Zaris cluster on your laptop with a single command, complete with a Management Service, the Web Console, and a ready-to-use demo store. The client API is identical to in-process mode — only the connection string changed.

Next steps​