Initial Obsidian CouchDB sync plugin

2026-06-20 09:58:46 +08:00
commit 621b25c39f
6 changed files with 869 additions and 0 deletions
@@ -0,0 +1,116 @@
+# Simple CouchDB Sync
+
+Simple CouchDB Sync is an Obsidian plugin that synchronizes vault files through a CouchDB database.
+
+## Features
+
+- Manual synchronization command and ribbon action.
+- Optional live synchronization for file create, modify, delete, and rename events.
+- Syncs Markdown notes and binary attachments.
+- Uses Obsidian `requestUrl`, so it can work on desktop and mobile, including Android.
+- Stores CouchDB connection settings inside the plugin settings tab.
+
+## Default Test Configuration
+
+- Server: `https://obsidian.dinlo.ru`
+- Database: `obsidian-test`
+- User: `test`
+- Password: `testpassword`
+
+You can change these values in Obsidian under Settings -> Community plugins -> Simple CouchDB Sync.
+
+## Installation From Gitea On Desktop
+
+The repository contains a ready-to-load Obsidian plugin. No build step is required.
+
+1. Open the Obsidian vault folder on your computer.
+2. Create this folder if it does not exist:
+
+```text
+<vault>/.obsidian/plugins/simple-couchdb-sync/
+```
+
+3. Download these files from the Gitea repository and place them into that folder:
+
+```text
+manifest.json
+main.js
+styles.css
+```
+
+4. Restart Obsidian, or run "Reload app without saving" from the command palette.
+5. Open Settings -> Community plugins.
+6. Disable Safe mode or Restricted mode if Obsidian asks for it.
+7. Enable `Simple CouchDB Sync`.
+8. Open the plugin settings and verify the CouchDB server, database, username, and password.
+9. Press `Sync` in the plugin settings, or use the command `Sync vault with CouchDB`.
+
+For your test vault, the target folder is:
+
+```text
+C:\Users\dimir\Documents\ObsidianTest\Test\.obsidian\plugins\simple-couchdb-sync
+```
+
+If Git is installed, you can clone the repository directly into the plugin folder:
+
+```powershell
+cd "C:\Users\dimir\Documents\ObsidianTest\Test\.obsidian\plugins"
+git clone https://nnootteess.dinlo.ru/dimon/simple-couchdb-sync.git simple-couchdb-sync
+```
+
+Repository URL:
+
+```text
+https://nnootteess.dinlo.ru/dimon/simple-couchdb-sync
+```
+
+## Installation From Gitea On Android
+
+Android Obsidian can load the same plugin files, but the folder must be copied into the mobile vault.
+
+1. Enable Community plugins in Obsidian for Android.
+2. Using a file manager, open your vault folder on the phone.
+3. Create this folder:
+
+```text
+<vault>/.obsidian/plugins/simple-couchdb-sync/
+```
+
+4. From the Gitea repository, download these files:
+
+```text
+manifest.json
+main.js
+styles.css
+```
+
+5. Copy the three files into:
+
+```text
+<vault>/.obsidian/plugins/simple-couchdb-sync/
+```
+
+6. Fully close and reopen Obsidian on Android.
+7. Go to Settings -> Community plugins and enable `Simple CouchDB Sync`.
+8. Open the plugin settings and enter the same CouchDB connection settings as on desktop.
+9. Run `Sync vault with CouchDB`.
+
+For easier Android updates, install an Android Git client such as Termux or a file manager with Git support, then clone the repository into the same plugin folder. After updating files, restart Obsidian so it reloads `main.js`.
+
+## Updating The Plugin
+
+When the repository changes, update these three files in the plugin folder:
+
+```text
+manifest.json
+main.js
+styles.css
+```
+
+Then restart Obsidian or disable and re-enable the plugin.
+
+## CouchDB Notes
+
+The plugin stores one CouchDB document per vault file. Document ids are derived from file paths. Deleted files are represented by tombstone documents so deletion can propagate between devices.
+
+The CouchDB user needs read and write access to the database. If the database does not exist, the plugin will try to create it.