mirror of
https://github.com/vrtmrz/obsidian-livesync.git
synced 2026-05-08 00:31:54 +00:00
Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9965d123bd | ||
|
|
b1c045937b | ||
|
|
a4fdcf9540 | ||
|
|
a9f06a3ae7 | ||
|
|
0946b1e012 | ||
|
|
ccbf1b2ffe | ||
|
|
a01079d4b1 | ||
|
|
1d71870fa3 | ||
|
|
0587a52d22 | ||
|
|
6c37f7bb05 | ||
|
|
d746c1cb52 | ||
|
|
39e2eab023 |
43
README.md
43
README.md
@@ -16,6 +16,7 @@ Limitations: Folder deletion handling is not completed.
|
|||||||
- Live Sync
|
- Live Sync
|
||||||
- Self-Hosted data synchronization with conflict detection and resolving in Obsidian.
|
- Self-Hosted data synchronization with conflict detection and resolving in Obsidian.
|
||||||
- Off-line sync is also available.
|
- Off-line sync is also available.
|
||||||
|
- Receive WebClip from [obsidian-livesync-webclip](https://chrome.google.com/webstore/detail/obsidian-livesync-webclip/jfpaflmpckblieefkegjncjoceapakdf)
|
||||||
|
|
||||||
## IMPORTANT NOTICE
|
## IMPORTANT NOTICE
|
||||||
|
|
||||||
@@ -32,20 +33,48 @@ If you want to synchronize to both backend, sync one by one, please.
|
|||||||
Setup details are in Couldant Setup Section.
|
Setup details are in Couldant Setup Section.
|
||||||
5. Setup LiveSync or SyncOnSave or SyncOnStart as you like.
|
5. Setup LiveSync or SyncOnSave or SyncOnStart as you like.
|
||||||
|
|
||||||
## When your database looks corrupted
|
## Test Server
|
||||||
|
|
||||||
|
Setting up an instance of Cloudant or local CouchDB is a little complicated, so I made the [Tasting server of obsidian-livesync](https://olstaste.vrtmrz.net/) up. Try free!
|
||||||
|
Note: Please read "Limitations" carefully. Do not send your private vault.
|
||||||
|
|
||||||
|
## WebClipper is also available.
|
||||||
|
|
||||||
|
Available from on Chrome Web Store:[obsidian-livesync-webclip](https://chrome.google.com/webstore/detail/obsidian-livesync-webclip/jfpaflmpckblieefkegjncjoceapakdf)
|
||||||
|
Repo is here: [obsidian-livesync-webclip](https://github.com/vrtmrz/obsidian-livesync-webclip). (Docs are work in progress.)
|
||||||
|
|
||||||
|
## When your database looks corrupted or too heavy to replicate to a new device.
|
||||||
|
|
||||||
obsidian-livesync changes data treatment of markdown files since 0.1.0
|
obsidian-livesync changes data treatment of markdown files since 0.1.0
|
||||||
When you are troubled with synchronization, **Please reset local and remote databases**.
|
When you are troubled with synchronization, **Please reset local and remote databases**.
|
||||||
_Note: Without synchronization, your files won't be deleted._
|
_Note: Without synchronization, your files won't be deleted._
|
||||||
|
|
||||||
|
1. Update plugin on all devices.
|
||||||
1. Disable any synchronizations on all devices.
|
1. Disable any synchronizations on all devices.
|
||||||
2. From the most reliable device<sup>(_The device_)</sup>, back your vault up.
|
1. From the most reliable device<sup>(_The device_)</sup>, back your vault up.
|
||||||
3. Click "Reset local database" on all devices.
|
1. Press "Drop History"-> "Execute" button from _The device_.
|
||||||
4. From _The device_ click "Reset remote database".
|
1. Wait for a while, so obsidian-livesync will say "completed."
|
||||||
5. From _The device_ click "Init Database again".
|
1. In other devices, replication will be canceled automatically. Click "Reset local database" and click "I'm ready, mark this device 'resolved'" on all devices.
|
||||||
6. Enable any sync or Hit the Replication button.
|
If it doesn't be shown. replicate once.
|
||||||
|
1. It's all done. But if you are sure to resolve all devices and the warning is noisy, click "I'm ready, unlock the database". it unlocks the database completely.
|
||||||
|
|
||||||
|
# Designed architecture
|
||||||
|
|
||||||
|
## How does this plugin synchronize.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
1. When notes are created or modified, Obsidian raises some events. obsidian-live-sync catch these events and reflect changes into Local PouchDB.
|
||||||
|
2. PouchDB automatically or manually replicates changes to remote CouchDB.
|
||||||
|
3. Another device is watching remote CouchDB's changes, so retrieve new changes.
|
||||||
|
4. obsidian-live-sync reflects replicated changeset into Obsidian's vault.
|
||||||
|
|
||||||
|
Note: The figure is drawn as single-directional, between two devices. But everything occurs bi-directionally between many devices at once in real.
|
||||||
|
|
||||||
|
## Techniques to keep bandwidth low.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
And wait for a minute. your data will be uploaded and synchronized with all devices again.
|
|
||||||
|
|
||||||
## Cloudant Setup
|
## Cloudant Setup
|
||||||
|
|
||||||
|
|||||||
BIN
images/1.png
Normal file
BIN
images/1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 96 KiB |
BIN
images/2.png
Normal file
BIN
images/2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 223 KiB |
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"id": "obsidian-livesync",
|
"id": "obsidian-livesync",
|
||||||
"name": "Obsidian Live sync",
|
"name": "Obsidian Live sync",
|
||||||
"version": "0.1.2",
|
"version": "0.1.8",
|
||||||
"minAppVersion": "0.9.12",
|
"minAppVersion": "0.9.12",
|
||||||
"description": "Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.",
|
"description": "Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.",
|
||||||
"author": "vorotamoroz",
|
"author": "vorotamoroz",
|
||||||
|
|||||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "obsidian-livesync",
|
"name": "obsidian-livesync",
|
||||||
"version": "0.0.8",
|
"version": "0.1.8",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "obsidian-livesync",
|
"name": "obsidian-livesync",
|
||||||
"version": "0.0.8",
|
"version": "0.1.8",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"diff-match-patch": "^1.0.5",
|
"diff-match-patch": "^1.0.5",
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "obsidian-livesync",
|
"name": "obsidian-livesync",
|
||||||
"version": "0.1.1",
|
"version": "0.1.8",
|
||||||
"description": "obsidian Live synchronization plugin.",
|
"description": "Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.",
|
||||||
"main": "main.js",
|
"main": "main.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "rollup --config rollup.config.js -w",
|
"dev": "rollup --config rollup.config.js -w",
|
||||||
|
|||||||
Reference in New Issue
Block a user