README file from
GithubHybrid Git Sync for Obsidian
🚀 An adaptive, cross-platform Git synchronization solution for Obsidian.
Enjoy high-performance Native Git execution on Desktop alongside a lightweight, zero-dependency Git Provider API on Mobile.
🌟 Introduction & Design Philosophy
Managing an Obsidian vault with Git across different operating systems usually requires distinct synchronization strategies due to platform-specific constraints. Hybrid Git Sync bridges this gap seamlessly by implementing an Adaptive Sync Engine.
Instead of applying a single approach to all environments, this plugin intelligently splits the synchronization workload based on the device you are currently using:
- 💻 On Desktop (Windows/Mac/Linux): It invokes your local Native Git client. This guarantees maximum execution speed, reliability, and full support for complex repository histories or large assets.
- 📱 On Mobile (iOS/Android): It bypasses mobile OS limitations by interacting directly with cloud REST APIs (GitHub / GitLab / Gitea). It reads and writes changes via lightweight HTTPS requests without requiring any local Git binary environments on your phone.
✨ Key Features
- 🔄 Adaptive Hybrid Engine: Runs full native Git commands on your PC and shifts to clean, memory-efficient API requests on your mobile devices.
- 🔒 Privacy Centric: Your Personal Access Tokens (PAT) are stored locally within Obsidian's secure configuration storage. No data ever leaves your device or touches intermediate servers.
- ⚡ Conflict Resolution: Built-in smart synchronization logic helps track updates, reducing the risk of overwriting files during simultaneous multi-device editing.
- 💰 100% Free & Open Source: A reliable, customizable, and fully self-hosted alternative for universal knowledge base backups.
📦 Installation
- Inside Obsidian, navigate to Settings -> Community Plugins.
- Click Browse and search for
Hybrid Git Sync. - Click Install, then toggle on Enable.
⚙️ Quick Setup Guide
Setting up Hybrid Git Sync takes less than 3 minutes:
- Repository Setup: Initialize your Obsidian vault as a Git repository on your desktop and push it to your hosting platform (GitHub, GitLab, or Gitea).
- Generate Token: Navigate to your Git provider's settings and create a Personal Access Token (PAT) with full
reporead/write scopes. - Mobile Configuration: Open the plugin settings on your mobile device, enter your Repository URL and the generated Token. Tap Sync to initiate your first transfer!
🤝 Feedback & Contributing
As this is a newly released plugin, your feedback is incredibly valuable! If you encounter any bugs, have feature requests, or want to support the project:
- Please open an Issue or join the discussion in the Discussions tab.
- If this plugin helps streamline your cross-platform workflow, consider dropping a ⭐ Star to help others discover it!
License
MIT
☕ Support
If you find this plugin useful and would like to support its development, you can support me on Ko-fi.