diff --git a/README.md b/README.md index 05d72aa..755d96d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ -# obsidian-livesync +# Self-hosted LiveSync +**Renamed from: obsidian-livesync** -This is the obsidian plugin that enables livesync between multi-devices. -Runs in Mac, Android, Windows, and iOS. +This is the obsidian plugin that enables livesync between multi-devices with self-hosted database. +Runs in Mac, Android, Windows, and iOS. +Community implementation, not compatible with official "Sync". @@ -26,7 +28,7 @@ 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. +2. Enable Self-hosted 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 @@ -35,7 +37,7 @@ If you want to synchronize to both backend, sync one by one, please. ## 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! +Setting up an instance of Cloudant or local CouchDB is a little complicated, so I made the [Tasting server of self-hosted-livesync](https://olstaste.vrtmrz.net/) up. Try free! Note: Please read "Limitations" carefully. Do not send your private vault. ## WebClipper is also available. @@ -45,7 +47,7 @@ Repo is here: [obsidian-livesync-webclip](https://github.com/vrtmrz/obsidian-liv ## 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 +self-hosted-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._ @@ -53,7 +55,7 @@ _Note: Without synchronization, your files won't be deleted._ 1. Disable any synchronizations on all devices. 1. From the most reliable device(_The device_), back your vault up. 1. Press "Drop History"-> "Execute" button from _The device_. -1. Wait for a while, so obsidian-livesync will say "completed." +1. Wait for a while, so self-hosted-livesync will say "completed." 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. 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. @@ -102,7 +104,7 @@ Select Multitenant(it's the default) and the region as you like. 6. When all of the above steps have been done, Open "Resource list" on the left pane. you can see the Cloudant instance in the "Service and software". Click it. ![step 8](instruction_images/cloudant_8.png) -7. In resource details, there's information to connect from obsidian-livesync. +7. In resource details, there's information to connect from self-hosted-livesync. Copy the "External Endpoint(preferred)" address. (\*1) ![step 9](instruction_images/cloudant_9.png) @@ -133,7 +135,7 @@ Select Multitenant(it's the default) and the region as you like. 1. The dialog to create a credential will be shown. type any name or leave it default, hit the "Add" button. ![step 2](instruction_images/credentials_2.png) - _NOTE: This "name" is not related to your username that uses in Obsidian-livesync._ + _NOTE: This "name" is not related to your username that uses in self-hosted-livesync._ 1. Back to "Service credentials", the new credential should be created. open details. @@ -143,7 +145,7 @@ Select Multitenant(it's the default) and the region as you like. follow the figure, it's "apikey-v2-2unu15184f7o8emr90xlqgkm2ncwhbltml6tgnjl9sd5"(\*3) and "c2c11651d75497fa3d3c486e4c8bdf27"(\*4) -### obsidian-livesync setting +### self-hosted-livesync setting ![xx](instruction_images/obsidian_sync_1.png) example values. diff --git a/main.ts b/main.ts index e6c4b72..6bed0f5 100644 --- a/main.ts +++ b/main.ts @@ -939,7 +939,7 @@ class LocalPouchDB { } if (!(await checkRemoteVersion(dbret.db, this.migrate.bind(this), VER))) { - Logger("Remote database is newer or corrupted, make sure to latest version of obsidian-livesync installed", LOG_LEVEL.NOTICE); + Logger("Remote database is newer or corrupted, make sure to latest version of self-hosted-livesync installed", LOG_LEVEL.NOTICE); return; } @@ -1120,7 +1120,7 @@ class LocalPouchDB { } if (!(await checkRemoteVersion(dbret.db, this.migrate.bind(this), VER))) { - Logger("Remote database is newer or corrupted, make sure to latest version of obsidian-livesync installed", LOG_LEVEL.NOTICE); + Logger("Remote database is newer or corrupted, make sure to latest version of self-hosted-livesync installed", LOG_LEVEL.NOTICE); return; } let defInitPoint: EntryMilestoneInfo = { @@ -1154,7 +1154,7 @@ class LocalPouchDB { } if (!(await checkRemoteVersion(dbret.db, this.migrate.bind(this), VER))) { - Logger("Remote database is newer or corrupted, make sure to latest version of obsidian-livesync installed", LOG_LEVEL.NOTICE); + Logger("Remote database is newer or corrupted, make sure to latest version of self-hosted-livesync installed", LOG_LEVEL.NOTICE); return; } let defInitPoint: EntryMilestoneInfo = { @@ -1647,7 +1647,7 @@ export default class ObsidianLiveSyncPlugin extends Plugin { if (change.type == "versioninfo") { if (change.version > VER) { this.localDatabase.closeReplication(); - Logger(`Remote database updated to incompatible version. update your Obsidian-livesync plugin.`, LOG_LEVEL.NOTICE); + Logger(`Remote database updated to incompatible version. update your self-hosted-livesync plugin.`, LOG_LEVEL.NOTICE); } } this.gcHook(); @@ -2152,7 +2152,7 @@ class ObsidianLiveSyncSettingTab extends PluginSettingTab { containerEl.empty(); - containerEl.createEl("h2", { text: "Settings for obsidian-livesync." }); + containerEl.createEl("h2", { text: "Settings for Self-hosted LiveSync." }); new Setting(containerEl).setName("CouchDB Remote URI").addText((text) => text diff --git a/manifest.json b/manifest.json index 519b896..ce4e6da 100644 --- a/manifest.json +++ b/manifest.json @@ -1,9 +1,9 @@ { "id": "obsidian-livesync", - "name": "Obsidian Live sync", - "version": "0.1.9", + "name": "Self-hosted LiveSync", + "version": "0.1.10", "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": "Community implementation of self-hosted livesync. 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", "authorUrl": "https://github.com/vrtmrz", "isDesktopOnly": false diff --git a/package-lock.json b/package-lock.json index 4c22b2c..a99d786 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "obsidian-livesync", - "version": "0.1.9", + "version": "0.1.10", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "obsidian-livesync", - "version": "0.1.9", + "version": "0.1.10", "license": "MIT", "dependencies": { "diff-match-patch": "^1.0.5", diff --git a/package.json b/package.json index 29b6fcc..19cf135 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "obsidian-livesync", - "version": "0.1.9", + "version": "0.1.10", "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", "scripts": {