Skip to content

Chance-Linx/obsidian-fast-note-sync

 
 

Repository files navigation

简体中文 / English / 日本語 / 한국어 / 繁體中文

If you have any questions, please create an issue, or join the Telegram group for help: https://t.me/obsidian_users

Fast Note Sync For Obsidian

release alpha-release license TypeScript

Fast, Stable, Efficient, Anywhere-Deployable Obsidian Note Sync & Backup Plugin
Supports private deployment, dedicated to providing Obsidian users with a non-intrusive, sleek, multi-device real-time note sync & backup plugin. Supports Mac, Windows, Android, iOS, and multi-language support.

Requires an independent server: Fast Note Sync Service

fast-note-sync-service-preview

✨ Plugin Features

  • Minimalist Configuration: No tedious setup, just paste your remote service configuration to start using it.
  • Real-time Note Sync: Automatically listens to and syncs all note creation, update, and deletion operations within the Vault.
  • Full Attachment Support: Real-time synchronization of images, videos, audio, and other non-setting files.

    ⚠️ Note: Requires v1.0+, server v0.9+. Please manage attachment file sizes; large files may cause synchronization delays.

  • Config Sync: Provides configuration synchronization, supporting config sync across multiple devices, ending the pain of manually copying configuration files.

    ⚠️ Note: Requires v1.4+, server v1.0+. Currently in the testing phase, please use with caution.

  • Server Version Status: Displays server version information, making it easy to understand the server's version status.
  • Multi-device Sync: Supports Mac, Windows, Android, iOS, and other platforms.
  • Note History: Provides a note history feature where you can view all historical modification versions of notes from the plugin side or the server WebGui. You can view modification details or copy the content of historical versions.

🗺️ Roadmap

We are continuously improving; here are the future development plans:

  • Offline Conflict Optimization: Add conflict resolution strategies for note modifications on offline devices to avoid data loss caused by only keeping the latest update.
  • Cloud Storage Backup Status: A feature to check cloud storage backup status at any time, keeping you informed of the latest backup state.
  • Note Sharing: Generate shareable links for your cloud notes, making it easy to share your achievements with others.
  • AI Notes: Explore innovative AI+ note-related features, awaiting your valuable suggestions.

If you have improvement suggestions or new ideas, feel free to share via issues — we will carefully evaluate and adopt suitable suggestions.

💰 Pricing

  • If you find this plugin useful and want to support its continued development, please consider supporting me through:

    Ko-fi Non-Mainland China WeChat Pay Mainland China
    BuyMeACoffee or

🚀 Quick Start

  1. Install the plugin (choose one of two)
    • Official Store: Open the Obsidian community plugin market, search for Fast Note Sync to install

      ⚠️ Plugin not yet listed in the official store, searching is unavailable. Please install manually.

    • Manual Install: Visit https://github.com/haierkeys/obsidian-fast-note-sync/releases to download the installation package, and unzip it to the Obsidian plugin directory .obsidian/plugins
  2. Open the plugin configuration, click the Paste Remote Config button, and paste the remote service configuration into the input box.

📦 Server Deployment

For backend service setup, please refer to: Fast Note Sync Service.

About

Can be privately deployed, focusing on providing Obsidian users with a seamless, distraction-free note synchronization plugin with real-time sync across multiple platforms, supporting Mac, Windows, Android, iOS, and offering multilingual support.可私有化部署,专注为 Obsidian 用户提供无打扰、丝般顺滑、多端实时同步的多平台笔记同步插件。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 91.7%
  • JavaScript 6.2%
  • SCSS 1.4%
  • Python 0.7%