thomasabishop/obsidian-sync
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme with diagram

Browse source
This commit is contained in:
Thomas Bishop 2026-03-24 17:22:44 +00:00
parent d208e10931
commit 6454e55817
2 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,18 +1,20 @@
# obsidian-sync
# obsidian-sync
> Service for synchronising edits to my Obsidian vault accross multiple machines
> Service for synchronising edits to my Obsidian vault accross multiple machines
Synchronisation is managed via a CouchDB database and the [LiveSync]() Obsidian community plugin.
![Architecture diagram](./diagram.png)
Synchronisation is managed via a CouchDB database and the [LiveSync]() Obsidian community plugin.
The provisioning and deployment of the DB is managed via Docker. See Docker
Compose file in this repo.
CouchDB runs on an HP T520 Thin Client (hostname: `hpt520-bravo`, local IP
address: 192.168.178,49) acting as
address: 192.168.178.49) acting as
server on my local network. `hpt520-bravo` is node on my Tailscale network, as are all other devices that
want to Sync with the CouchDB server.
In order for LiveSync to work on mobile devices, the CouchDB instance must be
served from an HTTPS URL. This is a constraint of the LiveSync plugin. To achieve this, I use the instance of nginx running on my remote
served from an HTTPS URL. This is a constraint of the LiveSync plugin. To achieve this, I use the instance of nginx running on my remote
VPS to forward incoming HTTPS requests to
`https://obsidian-sync.systemsobscure.net` to the HTTP Tailscale address that is
running CouchDB on `hpt520-bravo` (100.xxx.xxx.xxx:5984). As the VPS is also a

BIN
diagram.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 482 KiB