Skip to content

synkdRealtime rooms you run yourself

PartyKit-shaped WebSocket rooms on infrastructure you control. Build with partysocket. Operate with a Console and clear health signals.

Need the shape of the system first? Read the architecture diagrams: context, packages, request path, trust, control plane, and fleet topology.

What synkd is ​

synkd runs sticky realtime rooms. Each room is an actor with durable storage. Clients join over WebSockets using the same URL shape as PartyKit.

You host the process or fleet. There is no synkd cloud in v1.

What you need ​

  • Node.js 22 or later
  • pnpm for this monorepo
  • Podman or Docker only if you use local Durable Objects or a production fleet (Deploy)

Try it locally ​

sh
pnpm install
pnpm build
pnpm doctor
pnpm up

Or run the full lab stack with pnpm dev:all.

Then open:

Configuration ​

Each project has a synkd.json file. It names the parties, auth tokens, and listen port. The CLI reads that file for up, doctor, and deploy. There is no YAML config in v1.

Choose your path ​

Writing party code or a client? Start with Get started for developers. To scaffold a project, use the CLI.

Installing or securing a fleet? Start with Get started for operators.

Need Durable Objects locally or in production? Read Deploy. Use synkd up --durable on your laptop and synkd deploy for a fleet.

PartyKit-compatible rooms on infrastructure you run.