Skip to content

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 用户提供无打扰、丝般顺滑、多端实时同步的多平台笔记同步插件。

License

Notifications You must be signed in to change notification settings

haierkeys/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, and deployable Obsidian Note Sync & Backup Plugin
Supports private deployment, dedicated to providing Obsidian users with non-intrusive, seamless, multi-device real-time note synchronization and backup. Supports Mac, Windows, Android, iOS, and provides multi-language support.

Requires a separate server: Fast Note Sync Service

fast-note-sync-service-preview

✨ Features

  • 🚀 Minimal Configuration:
    • No complicated setup required; simply paste the remote service configuration to start using.
    • One-click import is also available on desktop for automatic authorization.
  • 📗 Real-time Note Sync:
    • Automatically monitors and syncs all note creation, updates, and deletions within the Vault.
  • 🖼️ Full Attachment Support:
    • Real-time sync for images, videos, audio, and other non-setting files.

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

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

    ⚠️ Note: Requires plugin v1.4+, server v1.0+. Currently in beta; use with caution.

  • 🛂 Sync Exclusion & Whitelist:
    • Features exclusion and whitelist functionality to customize your synchronization strategy.
  • 🔄 Multi-platform Sync:
    • Supports Mac, Windows, Android, iOS, and more.
  • 📝 Note History:
    • Provides note history feature to view detailed modification history.
    • Supports restoring notes to previous versions.
  • 🛡️ Offline Edit Auto-merge:
    • Note edits made on offline devices are automatically merged when reconnected, preventing data loss from overwriting with latest versions.
  • 🚫 Offline Deletion Sync & Completion:
    • Deletions of notes, attachments, and configs made while offline are automatically synced or restored upon the next connection.
  • 🔍 Version Detection:
    • Provides version detection to quickly get the latest plugin and server version information for easier upgrades.
  • ☁️ Cloud Attachment Preview:
    • Online preview for attachments without local synchronization, saving local storage space.

    Combined with exclusion settings, specific attachments can be used via third-party libraries (e.g., WebDAV) instead of uploading to the server.

  • 🗒️ Sync Logs:
    • Provides sync logs for viewing detailed information about each synchronization.

🗺️ Roadmap

We are continuously improving; here is our future development plan:

  • Note Sharing: Generate sharing links for your cloud notes to easily share your work with others.

  • End-to-End Encryption: Secure your note data everywhere with end-to-end encryption.

  • Cloud Storage Backup: Cloud storage backup feature to protect your note data from loss.

  • AI Notes: Exploring AI+ note-related innovations; your valuable suggestions are welcome.

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

💖 Sponsorship & Support

🚀 Quick Start

  1. Install the plugin (choose one):
    • Official Store: Search for Fast Note Sync in the Obsidian Community Plugins market

      ⚠️ Plugin is not yet listed on the official store and cannot be searched. Please install manually.

    • Manual Installation: Visit https://github.com/haierkeys/obsidian-fast-note-sync/releases to download the package, then extract it to the Obsidian plugin directory .obsidian/plugins.
    • Install via BRAT (Supports mobile): Search and install the BRAT plugin in the Obsidian Community Plugins market, go to the plugin settings, click Add beta plugin, and paste https://github.com/haierkeys/obsidian-fast-note-sync.
  2. Open plugin settings and click the Paste Remote Config button to paste your 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 用户提供无打扰、丝般顺滑、多端实时同步的多平台笔记同步插件。

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published