Documentation
BeziSync is a self-service control plane for Debezium Server: platform teams connect runtimes and set guardrails once; anyone can then stream changes from a database to a destination safely. This guide covers installing, using and operating it.
Sections
InstallTry it (Docker, two minutes): docker compose -f deploy/compose/docker-compose.yml up -d --build, open http://localhost:8080, sign in as [email protected] / bezisync-demo.ConceptsAdmin is account-wide: Admins open every project with every permission and are the only ones who see Settings (people, projects, runtimes, Debezium versions, policies).Your first pipelineBeziSync Your first pipelineSourcesEvery source runs the readiness checks of its own database, each failure with the exact fix for the provider, and shows source protection in its own terms (see Operate).Shape events (transforms)The wizard's Transform step decides what each event looks like.DestinationsEach destination states what it needs from a pipeline, and the wizard only offers that: the names it accepts (with a live preview), its event formats, the event shape it requires, its own pipeline setDatabases behind a bastion (SSH)PostgreSQL, MySQL/MariaDB, SQL Server, Oracle, CockroachDB and Vitess connections can reach a database through an SSH bastion (jump host).OperateThe pipeline page opens on Overview: a flow strip (source → connector → destination) with the log kept on the source for this pipeline (for MongoDB, how far back the shared oplog reaches), the connectManage runtimesSettings → Runtimes (Admins; pick the project at the top: it changes which project the section shows, not the project you are in) adds Kubernetes namespaces and Docker hosts with Add runtime.Remote runtimes (agents)Add a runtime with Through an agent: BeziSync shows a one-time install command (closing it needs "I've copied it", since the token is never shown again; Helm chart deploy/helm/bezisync-agent, or dockeGoogle GKE and Amazon EKSUse an agent.Debezium versionsSettings → Debezium versions (Admins) is the one list of Debezium Server images every project picks from, with how many pipelines run each one per project (each count links to that project's PipelinesPersonal dataEach pipeline decides what happens to personal data, in the Tables step (and later from Change → Tables and columns or the Data tab's Tables and personal data).Guardrails: policies, approvals, templatesSettings → Policies (Admins, per project): allowed runtimes, source/destination types and snapshot modes; the largest size; pipelines per source (each holds a replication slot or log reader); whether Secrets and secret storesConnection secrets are encrypted (AES-256-GCM), write-only and never returned or logged.Single sign-onAdmins set up sign-in in Settings → Sign-in, with as many providers as they need, of three kinds:AI agents (MCP)BeziSync speaks the Model Context Protocol, so agents such as Claude Code, Claude Desktop, ChatGPT, Codex, Gemini CLI, Cursor, VS Code or Windsurf can list, build, check, deploy and operate pipelines Config-as-code and the CLIEvery pipeline exports as YAML (History → Export YAML, or bezisync remote export):Adopt an existing Debezium ServerPipelines → Adopt existing: paste its application.properties.AdministrationSettings (Admins only) is grouped by job: People & projects, Running pipelines (runtimes, secret stores, Debezium versions) and Guardrails (policies, templates, audit log).Configuration referenceAll settings are environment variables prefixed with BEZISYNC_.