Signin Signup

Better Sync: Peer to Peer SiYuan sync plugin

This post was last updated for 233 days ago, and the information may already be changed

Hey everyone! 👋

I just wanted to share a cool SiYuan plugin I published a couple of days ago called Better Sync: GitHub - DD3Boh/better-sync-siyuan

It’s a game-changer for syncing your SiYuan notes across devices. It's fully free, open source under AGPL 3.0, and it doesn't require a premium SiYuan subscription to work.

Here’s what it can do:

  • Peer-to-peer sync between any two SiYuan instances (no third-party servers needed)
  • Syncs automatically when you start SiYuan, or you can trigger it manually with a button
  • Pushes changes when you edit a file (with a 5s cooldown currently)
  • Way faster than WebDAV (especially if everything’s on the same network)
  • Works as a client-server setup too, if you want to sync from outside your home (like with a server on a public IP)
  • Other features coming soon.

Setup is super straightforward and you can even install it on both devices for even smoother syncing.

The sync mechanism works by using just SiYuan's native APIs and basically nothing else.

Give it a try if you want an easier and faster way to keep your SiYuan notes in sync! 🚀

    7 Thank
    1 Up
    2 Reply
    2.3k 148 43 57 2 2.1k

    Related articles

    2 Reply
    Better Sync: Peer to Peer SiYuan sync plugin

    Welcome to here!

    Here we can learn from each other how to use SiYuan, give feedback and suggestions, and build SiYuan together.

    Signup About
    Please input reply content ...
    • cicko • • 1
      PRO

      Thanks a lot for making this plugin! Trying it out prompted me to take the trial subscription and compare to the official sync. Later I set up a separate S3 instance and effectively synced through that. This is also reply to the previous reply - one does not need to use the official servers if there are network issues with the US or China servers. S3 can be rented or self-hosted, removing that dependency on a specific 3rd party.

      During the trial I decided to get the license and continue using this synch method as I found it very practical. In comparison, I ran into a couple of issues with BetterSync which I'll report in the repo.

      In any case, I wanted to voice support for a great plugin and a way to keep the knowledge base safe. It feels great to know that, at any point, I can turn it on and have the devices synchronize among themselves, should there be any issues with network connection or the S3 data store.

    • MiscReply
    • alvorithm •
      VIP Warrior

      Thanks @dd3boh for this!

      It sounds as if it could be a workable approach for fast sync, in particular for paid subscribers outside of USA or China (where the datacenters are), who have to endure extra latency to those remote datacenters, and might have to pay twice if they need to relocate to new servers close to their location (see European Data Center for SiYuan Cloud Sync · Issue #15047 · siyuan-note/siyuan)

    dd3boh
    Reply
    0
     Article
    1
     Point
    630

    Recent hot