Obsidian Sync Server

A reimplemented sync server for Obsidian based on reverse engineering. Not affiliated with Obsidian.md.

[!WARNING] Due to the official protection added to the new version, you must use the old version 1.3.7 to use this project successfully. You can download it from here.

What works

• [x] support mobile devices
• [x] user create, login
• [x] vault list, create, delete
• [x] vault share
• [x] live sync
• [x] history, restore

TODO

• [ ] database/storage cleanup
• [ ] API to access vaults/documents
• [ ] publish maybe?

Usage

1. Run the server

   docker run -d \
     -p 8000:8000 \
     -v /path/to/data:/app/data \
     --name ob-sync-server \
     ghcr.io/czbix/ob-sync-server
   

2. Create user

   docker exec -it ob-sync-server ./cli.py create-user {name} {email} {password}
   

3. Install api-server plugin

   Download the plugin from release, extract and put it into your vault's .obsidian/plugins folder. Enable the plugin and set the server URL to your server, such as http://localhost:8000/. Also do the same on your other devices if needed.

4. Follow the official guide to set up sync on your devices.

Disclaimer

This implementation is based on the reverse engineering of client, and may not be the same as the official server. Most of features are implemented, and should work as expected. But bugs may exist, use at your own risk.