[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-71277":3},{"id":4,"name":5,"fullName":6,"owner":7,"repo":5,"description":8,"homepage":8,"htmlUrl":8,"language":9,"languages":8,"totalLinesOfCode":8,"stars":10,"forks":11,"watchers":12,"openIssues":13,"contributorsCount":14,"subscribersCount":14,"size":14,"stars1d":15,"stars7d":16,"stars30d":17,"stars90d":14,"forks30d":14,"starsTrendScore":18,"compositeScore":19,"rankGlobal":8,"rankLanguage":8,"license":20,"archived":21,"fork":21,"defaultBranch":22,"hasWiki":23,"hasPages":21,"topics":24,"createdAt":8,"pushedAt":8,"updatedAt":25,"readmeContent":26,"aiSummary":27,"trendingCount":14,"starSnapshotCount":14,"syncStatus":28,"lastSyncTime":29,"discoverSource":30},71277,"obsidian-livesync","vrtmrz\u002Fobsidian-livesync","vrtmrz",null,"TypeScript",11165,397,28,314,0,44,111,375,132,42.8,"MIT License",false,"main",true,[],"2026-06-12 02:02:50","# Self-hosted LiveSync\n[Japanese docs](.\u002FREADME_ja.md) - [Chinese docs](.\u002FREADME_cn.md).\n\n\nSelf-hosted LiveSync is a community-developed synchronisation plug-in available on all Obsidian-compatible platforms. It leverages robust server solutions such as CouchDB or object storage systems (e.g., MinIO, S3, R2, etc.) to ensure reliable data synchronisation.\n\nAdditionally, it supports peer-to-peer synchronisation using WebRTC, enabling you to synchronise your notes directly between devices without relying on a server. Documentations is available for [Peer-to-Peer Synchronisation](.\u002Fdocs\u002Fp2p_sync_updates_2026.md).\n\n![obsidian_live_sync_demo](https:\u002F\u002Fuser-images.githubusercontent.com\u002F45774780\u002F137355323-f57a8b09-abf2-4501-836c-8cb7d2ff24a3.gif)\n\n>[!IMPORTANT]\n> This plug-in is not compatible with the official \"Obsidian Sync\" and cannot synchronise with it.\n\n## Features\n- Synchronise vaults efficiently with minimal traffic.\n- Handle conflicting modifications effectively.\n  - Automatically merge simple conflicts.\n- Use open-source solutions for the server.\n  - Compatible solutions are supported.\n- Support end-to-end encryption.\n- Synchronise settings, snippets, themes, and plug-ins via [Customisation Sync (Beta)](docs\u002Fsettings.md#6-customization-sync-advanced) or [Hidden File Sync](docs\u002Fsettings.md#7-hidden-files-advanced).\n- Enable WebRTC peer-to-peer synchronisation without requiring a `host` (Experimental).\n  - This feature is still in the experimental stage. Please exercise caution when using it.\n  - WebRTC is a peer-to-peer synchronisation method, so **at least one device must be online to synchronise**.\n  - Instead of keeping your device online as a stable peer, you can use two pseudo-peers:\n    - [livesync-serverpeer](https:\u002F\u002Fgithub.com\u002Fvrtmrz\u002Flivesync-serverpeer): A pseudo-client running on the server for receiving and sending data between devices.\n    - [webpeer](https:\u002F\u002Fgithub.com\u002Fvrtmrz\u002Fobsidian-livesync\u002Ftree\u002Fmain\u002Fsrc\u002Fapps\u002Fwebpeer): A pseudo-client for receiving and sending data between devices.\n    - A pre-built instance is available at [fancy-syncing.vrtmrz.net\u002Fwebpeer](https:\u002F\u002Ffancy-syncing.vrtmrz.net\u002Fwebpeer\u002F) (hosted on the vrtmrz blog site). This is also peer-to-peer. Feel free to use it.\n  - For more information, refer to the [English explanatory article](https:\u002F\u002Ffancy-syncing.vrtmrz.net\u002Fblog\u002F0034-p2p-sync-en.html) or the [Japanese explanatory article](https:\u002F\u002Ffancy-syncing.vrtmrz.net\u002Fblog\u002F0034-p2p-sync).\n\nThis plug-in may be particularly useful for researchers, engineers, and developers who need to keep their notes fully self-hosted for security reasons. It is also suitable for anyone seeking the peace of mind that comes with knowing their notes remain entirely private.\n\n>[!IMPORTANT]\n> - Before installing or upgrading this plug-in, please back up your vault.\n> - Do not enable this plug-in alongside another synchronisation solution at the same time (including iCloud and Obsidian Sync).\n> - For backups, we also provide a plug-in called [Differential ZIP Backup](https:\u002F\u002Fgithub.com\u002Fvrtmrz\u002Fdiffzip).\n\n## How to use\n\n### 3-minute setup - CouchDB on fly.io\n\n**Recommended for beginners**\n\n[![LiveSync Setup onto Fly.io SpeedRun 2024 using Google Colab](https:\u002F\u002Fimg.youtube.com\u002Fvi\u002F7sa_I1832Xc\u002F0.jpg)](https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=7sa_I1832Xc)\n\n1. [Setup CouchDB on fly.io](docs\u002Fsetup_flyio.md)\n2. Configure plug-in in [Quick Setup](docs\u002Fquick_setup.md)\n\n### Manually Setup\n\n1. Setup the server\n   1. [Setup CouchDB on fly.io](docs\u002Fsetup_flyio.md)\n   2. [Setup your CouchDB](docs\u002Fsetup_own_server.md)\n2. Configure plug-in in [Quick Setup](docs\u002Fquick_setup.md)\n> [!TIP]\n> Fly.io is no longer free. Fortunately, despite some issues, we can still use IBM Cloudant. Refer to [Setup IBM Cloudant](docs\u002Fsetup_cloudant.md).\n> And also, we can use peer-to-peer synchronisation without a server. Or very cheap Object Storage -- Cloudflare R2 can be used for free.\n> HOWEVER, most importantly, we can use the server that we trust. Therefore, please set up your own server.\n> CouchDB can be run on a Raspberry Pi. (But please be careful about the security of your server).\n\n\n## Information in StatusBar\n\nSynchronization status is shown in the status bar with the following icons.\n\n-   Activity Indicator\n    -   📲 Network request\n-   Status\n    -   ⏹️ Stopped\n    -   💤 LiveSync enabled. Waiting for changes\n    -   ⚡️ Synchronization in progress\n    -   ⚠ An error occurred\n-   Statistical indicator\n     -   ↑ Uploaded chunks and metadata\n     -   ↓ Downloaded chunks and metadata\n-   Progress indicator\n     -   📥 Unprocessed transferred items\n     -   📄 Working database operation\n     -   💾 Working write storage processes\n     -   ⏳ Working read storage processes\n     -   🛫 Pending read storage processes\n     -   📬 Batched read storage processes\n     -   ⚙️ Working or pending storage processes of hidden files\n     -   🧩 Waiting chunks\n     -   🔌 Working Customisation items (Configuration, snippets, and plug-ins)\n\nTo prevent file and database corruption, please wait to stop Obsidian until all progress indicators have disappeared as possible (The plugin will also try to resume, though). Especially in case of if you have deleted or renamed files.\n\n## Tips and Troubleshooting\nIf you are having problems getting the plugin working see: [Tips and Troubleshooting](docs\u002Ftroubleshooting.md). \n\n## Acknowledgements\nThe project has been in continual progress and harmony thanks to:  \n- Many [Contributors](https:\u002F\u002Fgithub.com\u002Fvrtmrz\u002Fobsidian-livesync\u002Fgraphs\u002Fcontributors).  \n- Many [GitHub Sponsors](https:\u002F\u002Fgithub.com\u002Fsponsors\u002Fvrtmrz#sponsors).  \n- JetBrains Community Programs \u002F Support for Open-Source Projects. \u003Cimg src=\"https:\u002F\u002Fresources.jetbrains.com\u002Fstorage\u002Fproducts\u002Fcompany\u002Fbrand\u002Flogos\u002Fjetbrains.png\" alt=\"JetBrains logo\" height=\"24\">  \n\nMay those who have contributed be honoured and remembered for their kindness and generosity.\n\n## Development Guide\nPlease refer to [Development Guide](devs.md) for development setup, testing infrastructure, code conventions, and more.\n\n## License\n\nLicensed under the MIT License.\n","Self-hosted LiveSync 是一个社区开发的同步插件，适用于所有支持 Obsidian 的平台。它利用 CouchDB 或对象存储系统（如 MinIO、S3、R2 等）来实现可靠的数据同步，并且支持通过 WebRTC 进行点对点同步，无需依赖服务器即可直接在设备间同步笔记。该插件的核心功能包括高效同步、冲突处理、端到端加密以及设置、代码片段、主题和插件的同步。特别适合需要完全自托管以确保安全性的研究人员、工程师和开发者使用，同时也适用于希望保证笔记绝对私密性的用户。",2,"2026-06-11 03:36:56","high_star"]