|
|
|
|
@@ -1,32 +1,51 @@
|
|
|
|
|
# obsidian-livesync
|
|
|
|
|
|
|
|
|
|
This is the obsidian plugin that enables livesync between multi terminals.
|
|
|
|
|
This is the obsidian plugin that enables livesync between multi-devices.
|
|
|
|
|
Runs in Mac, Android, Windows, and iOS.
|
|
|
|
|
|
|
|
|
|
<!-- <div><video controls src="https://user-images.githubusercontent.com/45774780/137352386-a274736d-a38b-4069-ac41-759c73e36a23.mp4" muted="false"></video></div> -->
|
|
|
|
|
|
|
|
|
|

|
|
|
|
|
|
|
|
|
|
**It's beta. Please make sure to back your vault up!**
|
|
|
|
|
|
|
|
|
|
**It's beta. Please make sure back your vault up!**
|
|
|
|
|
|
|
|
|
|
Limitations: File deletion handling is not completed.
|
|
|
|
|
Limitations: Folder deletion handling is not completed.
|
|
|
|
|
|
|
|
|
|
## This plugin enables..
|
|
|
|
|
|
|
|
|
|
- Live sync
|
|
|
|
|
- Live Sync
|
|
|
|
|
- Self-Hosted data synchronization with conflict detection and resolving in Obsidian.
|
|
|
|
|
- Off line sync is also available.
|
|
|
|
|
- Off-line sync is also available.
|
|
|
|
|
|
|
|
|
|
## How to use the beta build
|
|
|
|
|
## IMPORTANT NOTICE
|
|
|
|
|
|
|
|
|
|
1. download this repo and expand `[your-vault]/.obsidian/plugins/` (PC, Mac and Android will work)
|
|
|
|
|
1. enable obsidian livesync in the settings dialog.
|
|
|
|
|
1. If you use your self-hosted CouchDB, set your server's info.
|
|
|
|
|
1. or Use [IBM Cloudant](https://www.ibm.com/cloud/cloudant), take an account and enable **Cloudant** in [Catalog](https://cloud.ibm.com/catalog#services)
|
|
|
|
|
Note please choose "IAM and legacy credentials" for the Authentication method
|
|
|
|
|
Setup details are in Couldant Setup Section.
|
|
|
|
|
1. Setup LiveSync or SyncOnSave or SyncOnStart as you like.
|
|
|
|
|
**Please make sure to disable other synchronize solutions to avoid content corruption or duplication.**
|
|
|
|
|
If you want to synchronize to both backend, sync one by one, please.
|
|
|
|
|
|
|
|
|
|
## How to use
|
|
|
|
|
|
|
|
|
|
1. Install from Obsidian, or clone this repo and run `npm run build` ,copy `main.js`, `styles.css` and `manifest.json` into `[your-vault]/.obsidian/plugins/` (PC, Mac and Android will work)
|
|
|
|
|
2. Enable obsidian livesync in the settings dialog.
|
|
|
|
|
3. If you use your self-hosted CouchDB, set your server's info.
|
|
|
|
|
4. or Use [IBM Cloudant](https://www.ibm.com/cloud/cloudant), take an account and enable **Cloudant** in [Catalog](https://cloud.ibm.com/catalog#services)
|
|
|
|
|
Note please choose "IAM and legacy credentials" for the Authentication method
|
|
|
|
|
Setup details are in Couldant Setup Section.
|
|
|
|
|
5. Setup LiveSync or SyncOnSave or SyncOnStart as you like.
|
|
|
|
|
|
|
|
|
|
## When your database looks corrupted
|
|
|
|
|
|
|
|
|
|
obsidian-livesync changes data treatment of markdown files since 0.1.0
|
|
|
|
|
When you are troubled with synchronization, **Please reset local and remote databases**.
|
|
|
|
|
_Note: Without synchronization, your files won't be deleted._
|
|
|
|
|
|
|
|
|
|
1. Disable any synchronizations on all devices.
|
|
|
|
|
2. From the most reliable device<sup>(_The device_)</sup>, back your vault up.
|
|
|
|
|
3. Click "Reset local database" on all devices.
|
|
|
|
|
4. From _The device_ click "Reset remote database".
|
|
|
|
|
5. From _The device_ click "Init Database again".
|
|
|
|
|
6. Enable any sync or Hit the Replication button.
|
|
|
|
|
|
|
|
|
|
And wait for a minute. your data will be uploaded and synchronized with all devices again.
|
|
|
|
|
|
|
|
|
|
## Cloudant Setup
|
|
|
|
|
|
|
|
|
|
@@ -38,7 +57,7 @@ Limitations: File deletion handling is not completed.
|
|
|
|
|
1. In IBM Cloud Catalog, search "Cloudant".
|
|
|
|
|

|
|
|
|
|
|
|
|
|
|
1. You can choise "Lite plan" in free.
|
|
|
|
|
1. You can choose "Lite plan" for free.
|
|
|
|
|

|
|
|
|
|
|
|
|
|
|
Select Multitenant(it's the default) and the region as you like.
|
|
|
|
|
@@ -107,4 +126,5 @@ example values.
|
|
|
|
|
| CouchDB Password | (\*4) | c2c11651d75497fa3d3c486e4c8bdf27 |
|
|
|
|
|
|
|
|
|
|
# License
|
|
|
|
|
|
|
|
|
|
The source code is licensed MIT.
|
|
|
|
|
|