Rowkai

Rowkai Docs

Quickstart guide.

Quickstart

Get Rowkai running locally in under 10 minutes.

Build the Postgres-compatible distribution, compile the Go services, start the fullstack demo, and create your first branchable tenant environment.

Prerequisites

  • Go 1.22+
  • Node.js 18+ and npm
  • make, gcc, and standard build tools
  • libreadline-dev, zlib1g-dev, flex, and bison
  • Python 3 for demo helpers

Build PostgreSQL

./configure --prefix=/usr/local/pgsql \
  --with-openssl --with-libcurl

make -j$(nproc)
make install DESTDIR=.local-install

Build services

cd controlplane
go build -o bin/controlplane ./cmd/controlplane/
go build -o bin/pageserver ./cmd/pageserver/
go build -o bin/walservice ./cmd/walservice/
cd ..

Start the demo

scripts/rowkai-fullstack-demo start

The demo starts the control plane, Pageserver, WAL service, a default tenant and timeline, a compute node, and the admin UI.

Create your first branch

curl -X POST \
  http://127.0.0.1:9090/tenants/TENANT_ID/timelines/TIMELINE_ID/branches \
  -H "Content-Type: application/json" \
  -d '{"name": "feature-branch"}'