Deploy Your Own SynDB Node
This scenario covers the three deployment models for SynDB, from a local evaluation stack to a production kubernetes deployment to a federated node.
1. Evaluation — Docker Compose
The fastest way to run SynDB locally:
git clone --recurse-submodules https://github.com/memorycircuits/SynDB.git
cd SynDB
cp .env.example .env
syndb dev sync-versions
syndb stack prepare
syndb stack up
This starts PostgreSQL, ClickHouse, SeaweedFS (S3), Meilisearch, the API, and the web UI.
System requirements: 8 GB RAM, 4 CPU cores, 20 GB free disk.
Services:
| Service | URL | Default port |
|---|---|---|
| Web UI | http://localhost:8090 | 8090 |
| API | http://localhost:8080 | 8080 |
| API docs | http://localhost:8080/docs | (browser) |
| ClickHouse HTTP | http://localhost:8123 | 8123 |
| ClickHouse native | localhost:9002 | 9002 |
| PostgreSQL | localhost:5433 | 5433 |
| S3 (SeaweedFS) | http://localhost:9000 | 9000 |
What gets created
- A Docker network
syndb - PostgreSQL database
syndbwith migrations applied - ClickHouse database
syndbwith table schemas created - S3 buckets for mesh, SWB, search, job, and ETL data
- API server with token authentication
- Web UI served by the Dioxus Fullstack server
2. Production — Kubernetes
The primary production path uses Helm charts on a Kubernetes cluster (developed against the NRP Nautilus platform).
Prerequisites
- Kubernetes 1.28+
- Helm 3.14+
- A StorageClass that supports
ReadWriteOncePVCs - Optional: Ingress controller for HTTP access
Install
helm upgrade --install syndb infrastructure/helm/syndb-hub \
--namespace syndb --create-namespace
For ETL workers:
helm upgrade --install syndb-etl infrastructure/helm/syndb-etl \
--namespace syndb
Configuration
Refer to the environment reference for the full list of configuration variables. Key settings:
| Variable | Purpose | Example |
|---|---|---|
CLICKHOUSE_HOST | ClickHouse address | clickhouse.syndb.svc |
POSTGRES_HOST | PostgreSQL address | postgres.syndb.svc |
S3_ENDPOINT | S3-compatible object store | https://s3-west.nrp-nautilus.io |
PASETO_SECRET | Token signing key | (generate with openssl rand -hex 32) |
3. Federation node
A federation node is a standard SynDB deployment with federation enabled. It registers with a hub and makes its datasets available for cross-cluster queries while retaining data ownership.
Configuration
Add these to the hub’s Helm values:
federation:
enabled: true
hub:
listenAddr: "/ip4/0.0.0.0/tcp/4001"
Add these to each cluster’s Helm values:
federation:
enabled: true
cluster:
hubEndpoint: "https://hub.syndb.example.com"
nodeName: "my-cluster"
Registration
Once the cluster is running, register it with the hub:
syndb federation register \
--name my-cluster \
--api-url https://my-cluster.example.com
The hub and cluster establish a libp2p connection. The cluster’s datasets appear in the hub’s catalog within seconds.
Resource estimates
| Deployment | CPU | RAM | Storage | Notes |
|---|---|---|---|---|
| Evaluation | 4 cores | 8 GB | 20 GB | Docker Compose, single machine |
| Production | 8-16 cores | 32-64 GB | 500 GB+ SSD | Kubernetes, 3+ ClickHouse nodes |
| Federation | 4-8 cores | 16-32 GB | 100 GB+ | Additional libp2p overhead |