Welcome to SyncEngine¶

SyncEngine is a modular automation and data synchronization engine designed for building reliable, transparent, and high-performance integrations between systems.

It combines the flexibility of custom integrations with a structured execution model that provides previews, execution history, and deep observability out of the box.

SyncEngine is built for people who care not just that an integration runs, but why, how, and with what data it ran.

Whether you’re building advanced automation flows, connecting third-party APIs, or orchestrating entire business processes, SyncEngine provides the performance, flexibility, and transparency you need.

What is SyncEngine?¶

SyncEngine is a modular automation framework that lets you define, execute, and inspect data flows between systems, running as a self-hosted service or managed platform.

At its core, it provides:

• Explicit automation flows composed of reusable routines and tasks
• Preview and live execution modes
• Structured traces that record execution history
• An extensible architecture for both prebuilt modules and custom logic

You can use SyncEngine to:

• Synchronize data between platforms (e.g. webshops, PIMs, ERPs, CRMs)
• Orchestrate complex, multi-step business processes
• Build robust integrations without reinventing logging, retries, and execution tracking
• Replace fragile custom scripts with a maintainable integration framework

Key Capabilities¶

• Flows & Routines
  Build automations from reusable building blocks with predictable execution.
• Preview & Live Execution Modes
  Inspect data and behavior before running an automation live.
• Execution History (Traces)
  Every run is recorded with inputs, outputs, decisions, and metadata. Trace retention is configurable and automatically managed.
• Built-in Observability
  Understand what happened, when it happened, and why.
• Extensible by Design
  Add custom tasks or install modules without modifying Core.

Quick Start¶

If you’re new to SyncEngine, we recommend starting here:

1. Installation – Set up SyncEngine using Docker, the Installer, or Composer.
2. Setup – Complete the initial configuration and create your admin account.
3. Dashboard – Learn how to use the dashboard and preview features.
4. Tasks – Understand how SyncEngine processes data using tasks.
5. Connections – Connect to your favorite apps and services.

Documentation Overview¶

The documentation is divided into two main sections:

• User Docs – Installation, setup, dashboard, flows, routines, storages, and tasks.
• Developer Docs – Modules, API, and architecture for extending SyncEngine.

Contributing¶

Bug reports 🐛, improvements ✨ and ideas 💡 are very welcome!
If you’d like to improve the docs, report issues, or contribute modules, visit our GitHub repositories:

• SyncEngine Core
• SyncEngine Docker
• SyncEngine Installer

Join the Team¶

Help us shape the future of Secure, Scalable and Automated Data Synchronization! Please contact us at [email protected]

Why SyncEngine?¶

Many automation tools focus on getting something running as quickly as possible. They often trade long-term clarity, debuggability, and performance for convenience.

SyncEngine takes a different approach:

• It treats execution history as a first-class concept, not just logs.
• It makes previewing and live execution explicit choices.
• It favors predictable, inspectable behavior over hidden automation.
• It is designed to handle recurring and bulk synchronizations reliably.

Licensing & Commercial Sustainability¶

SyncEngine is fair-code distributed under a SyncEngine Core License for self-hosted use, personal projects, and client-specific integrations. This license is inspired by the Sustainable Use License and the Business Source License.

Offering the software as SaaS or managed hosted service requires a Commercial / Enterprise License.

Our licensing model exists to ensure the platform can be sustainably maintained and improved, while preventing commercial free-riding that would undermine long-term development.

For full details, see Core License and Commercial License.

License Comparison¶

The Core License is designed for developers, agencies, and companies who use SyncEngine as part of their own systems or client projects, without offering SyncEngine itself as a hosted or multi-tenant service.

If you want to offer SyncEngine as a public SaaS, managed hosting platform, or large-scale multi-tenant solution, a Commercial or Enterprise License is required.

This licensing model ensures long-term sustainability of the project while remaining friendly to integrators, consultants, and embedded use cases.

The table below highlights the practical differences between the SyncEngine Core License and the Commercial / Enterprise License.

Learn More¶

• Installation Guide
• Setup Guide
• Dashboard Overview
• Task Reference