documentation

Concepts & guides

Everything you need to run siphon in anger — from your first backup to continuous cross-engine replication. These pages render the same Markdown that ships in the repository, so they track the latest source.

quick start

Install the binary, then head to Getting started for your first backup and sync.

Start here

Getting started→

Install siphon and run your first backup, restore, and sync in a few minutes.

Configuration→

Connection profiles, config file layout, env vars, and per-profile overrides.

Drivers→

How siphon talks to PostgreSQL, MySQL, and MariaDB, and what each driver supports.

Moving data

Incremental backup→

Capture only what changed since a base, then replay the base→incremental chain.

Cross-engine sync→

Move schema and data between different engines through a canonical model.

CDC (continuous sync)→

Tail the source's change stream and apply it to a target, with resumable state.

Operating

Storage backends→

Keep dumps locally or in S3 with a key-addressed, pluggable storage seam.

Retention & pruning→

Prune whole backup chains by keep-last, max-age, or GFS without orphaning.

Operational features→

Audit logging, 2FA-gated destructive ops, telemetry, schedules, and tunnels.

Found a gap or a bug? Open an issue.Browse the source ↗