Reverse engineered obsidian sync server (NOT OFFICIAL).
I have abandoned ObsidianMD due to bad faith behavior. I am working on writing a compatible Logseq plugin that will use this server.
Warning
The main branch is the development branch. For stable usage, use the latest release.
Note
If you have the time and energy, feel free to help out with PRs or suggestions.
- End to end encryption
- Live sync (across devices)
- File history/recovery/snapshots
- Works natively on IOS/Android/Linux/MacOS/Windows... (via the plugin)
- Vault sharing
- Publish (markdown only. no rendering yet)
These features are not in the latest release but in the main branch. They might not be fully tested and are probably unstable.
- N/A
- Fix bugs
DOMAIN_NAME
- The domain name or IP address of your server. Include port if not on 80 or 433. The default islocalhost:3000
ADDR_HTTP
- Server listener address. The default is127.0.0.1:3000
SIGNUP_KEY
- Signup API is at/user/signup
. This optionally restricts users who can sign up.DATA_DIR
- Where data is saved. Default.
git clone https://github.com/acheong08/obsidian-sync
cd obsidian-sync
go run cmd/obsidian-sync/main.go
Optional:
- Configure nginx
- HTTPS is recommended.
When you're done, install and configure the plugin
go run cmd/signup/main.go
Alternatively:
curl --request POST \
--url https://yourdomain.com/user/signup \
--header 'Content-Type: application/json' \
--data '{
"email": "[email protected]",
"password": "example_password",
"name": "Example User",
"signup_key": "<SIGNUP_KEY>"
}'
You can set the signup key via the SIGNUP_KEY
environment variable. If it has not been set, you can exclude it from the request.