obsidian-sync

Rev Obsidian Sync

Reverse engineered obsidian sync server (NOT OFFICIAL)

[!WARNING] This is an experimental proof of concept. It was written hastily without knowledge of the real internal mechanisms. Expect a thousand bugs and inefficiencies. This is an incomplete reproduction of the server. Many features aren't supported yet. I'm not responsible for any data loss or corruption. Use at your own risk.

[!NOTE] If you have the time and energy, feel free to help out with PRs or suggestions.

Features

• Basic sync
• File recovery
• File history

To do

• Fix bugs
• Sharing notes
• Publish

Setup

• git clone https://github.com/acheong08/obsidian-sync
• cd obsidian-sync
• export HOST=<YOUR DOMAIN NAME>
• go run cmd/obsidian-sync/main.go
• Use nginx or cloudflare to proxy & handle TLS/SSL

Nginx configuration

map $http_upgrade $connection_upgrade {
        default upgrade;
        '' close;
}
server {
	listen 80 default_server;
	listen [::]:80 default_server;
	location / {
		proxy_http_version 1.1;
            	proxy_set_header Upgrade $http_upgrade;
            	proxy_set_header Connection $connection_upgrade;
           	proxy_set_header Host $host;
		proxy_pass http://127.0.0.1:3000/;
	}
	server_name _;
}

Adding a new user

go run cmd/signup/main.go

Sync override plugin

Tested on

• IOS
• Linux (Flatpak)

Usage

While we have no qualms with reverse engineering as a playground for experimentation, Obsidian Sync is a service we intend to keep first-party only for the foreseeable future. - https://github.com/obsidianmd/obsidian-releases/pull/2353

This plugin will not be part of the official community plugins list.

• Install https://github.com/acheong08/rev-obsidian-sync-plugin
• Go to settings
• Set API endpoint

Known bugs:

• Cannot restart plugin (for whatever reason you might want to do that...) - Restart the app if you want to reload this particular plugin

Report all bugs in this repository.