Sync Engine
Hēsperus37k downloadsThe extensible vault synchronization engine: Fast · Free · Reliable. Supports WebDAV, S3, and Google Drive.
- Overview
- Scorecard
- Updates83
The extensible vault synchronization engine: Fast · Free · Reliable
简体中文 • Documentation • Plugin Store
Introduction
Sync Engine is a vault syncing plugin to synchronize vault files in multiple devices, it supports:
Backends: S3, WebDAV, Google Drive
Features:
- Client-side encryption
- Bidirectional / mirror remote / mirror local syncing.
- Startup / periodic / save-on-change syncing.
- Conflict resolution strategies (smart merge / keep both / latest survive / keep remote / keep local / skip).
- Rate / memory control options.
- Custom headers.
Sync Engine is also a modular platform that everyone can build upon. You can achieve customized experience by building your own modules via the convenient SDK, extending the plugin, contributing to the community, all without modifying the source code.
Access Sync Engine documentation at sync.consensia.cc, which contains usage guides, existing modules, permission claims, benchmarking, and documentation on how to build a module.
There's already a lot of plugins to sync your notes between devices:
- Remotely Save supports many backends (S3, Dropbox, OneDrive, WebDAV). But is optionally paid, development paused for years with stability issues
- Self-hosted LiveSync and Fast Note Sync offer real-time, server-based sync. They work well if you are comfortable setting up your own server.
- Relay is a managed relay service. Convenient, but your notes pass through infrastructure you don't control.
Sync Engine fits the gap: you want to choose your own storage, you want the plugin to stay small because unused features aren't bundled in, and you want a highly optimized syncing that is no slower than a self-hosted server.
Our Claims
Fast
- Incremental syncing never uploads the full vault each time.
- Anchored Asymmetric Storage substantially accelerates syncing.
- Real-time sync uses cached remote states, allowing it to complete within milliseconds.
- Benchmarking shows around 100x faster than Remotely Save in some metrics.
- Handles vaults with thousands of files smoothly.
- No slower than a self-hosted server
- Detailed performance comparison can be found in performance benchmark.
Free and Reliable
- The plugin is completely open-source, free to use and distribute (MIT License)
- All source code, including plugin core, all modules, and the documentation website are publicly accessible in this repo; and thus they are all scanned by Obsidian's automated scan. There's no hidden telemetry or third-party server.
- The documentation documents everything in detail, including permission and security claims.
- The plugin protects you from attacks: encryption, module verification.
- The sync algorithm is battle-tested and has evolved over thousands of usage.
Extensible
- You can add backends, optimizers, sync triggers, i18n resources, decision strategies, conflict strategies, setting entries, custom file processing, and invoke all possible operations in custom modules.
- Documentation and SDK with debug and testing toolkit are provided.
- Plugin provides dedicated module discovery and management UI.
- Repo accepts any module contribution as long as it respects contribution guide.
Usage
- Download and enable
Sync Enginefrom Obsidian plugin store. - Open "Module management" setting, install needed translations, backends and optional features.
- Fill the necessary information about your cloud service in the settings interface.
- Start your first sync from command palette or ribbon button.
- Review the sync tasks that will be performed.
- Click "Confirm", and your files will arrive the configured backend at the speed of light.
- Access documentation for advanced usages.
Roadmap
Below is a list of planned features and improvements, the faster this plugin is adopted and the star ⭐ grows, the faster the development will be. Also, we welcome contributors that would like to help us with the development of either modules or core.
- v3.0: Rewrite entirely, dynamic module loading, module store, asymmetric storage, and rebrand
- v3.1: Migrate settings to Obsidian v1.13 API
- v3.2: Granular sync strategy selection / exclusion inclusion rule refactor based on ordered glob match rules.
Sync Engine has a wishlist of features, you can react with thumbs up 👍 on feature comments you would like to have. And the features with more votes will have higher priority.
Common Questions
What should I do if I get an error during syncing?
You can simply retry the sync. An error does not block later syncs nor corrupt your files.
If the error persists after retrying, please open an issue, describing the error, your setup, with the log attached.
How should I manage my remote storage when using this plugin?
According to this plugin's file handling strategy, all remote changes will be propagated to all vaults. So it's generally not recommended to manually manage your remote storage unless you intend to add / remove these files. Manual management is more discouraged when you have encryption or asymmetric storage enabled.
License
The source code of Sync Engine and modules in this repository are licensed under the MIT License.
Pages in the documentation website are licensed under CC BY 4.0 license.
Copyright ©️ 2026 Hēsperus and All Contributors