Quickstart

You’ll need: Docker 24+, a domain you control, and a Linux server reachable from the internet (see Server requirements).

1. Get the source

The source is not public yet; until it opens under AGPL-3.0 (designer) and Apache-2.0 (runtime), these steps assume you already have a copy of the repository.

cd pipebase   # your copy of the repository

2. Generate .env

./scripts/init.sh

The script prompts for your ROOT_DOMAIN and Let’s Encrypt email, generates PIPEBASE_DEPLOY_TOKEN for you (plus a PIPEBASE_JWT_SECRET and PIPEBASE_RUNTIME_ROOT_DOMAIN left commented out; both are opt-in), and writes .env (mode 600).

3. Start the stack

docker compose up -d

That’s it. Open https://designer.<your-root-domain> and you’re in.

---

What just happened?

Six containers came up — Traefik, Kafka and Pulsar alongside these three:

• pipebase-runtime — the Apache Camel engine, listening on https://runtime.<your-domain> for HTTP-triggered flows.
• pipebase-designer — the React-based visual editor, served at https://designer.<your-domain>.
• pipebase-docs — this site, at https://docs.designer.<your-domain>.

Traefik (pipebase-traefik) terminates TLS via Let’s Encrypt and routes per-host to the right container.

What now?

• Set up DNS — point your domain at the server
• Build your first flow — 5-minute walkthrough
• Operations — backup, upgrade, troubleshooting
• All env vars — full reference

If something doesn’t come up cleanly, head straight to troubleshooting.