{"id":13599361,"url":"https://github.com/acheong08/obi-sync","last_synced_at":"2025-09-27T05:30:57.674Z","repository":{"id":190377254,"uuid":"679638162","full_name":"acheong08/obi-sync","owner":"acheong08","description":"Reverse engineering of the native Obsidian sync and publish server","archived":true,"fork":false,"pushed_at":"2023-12-28T13:14:27.000Z","size":203,"stargazers_count":1002,"open_issues_count":1,"forks_count":61,"subscribers_count":21,"default_branch":"main","last_synced_at":"2024-05-21T00:55:19.248Z","etag":null,"topics":["obsidian-md","obsidian-publish","obsidian-sync","obsidian-vault","sync"],"latest_commit_sha":null,"homepage":"https://obsidian.md/sync","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/acheong08.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-08-17T09:32:11.000Z","updated_at":"2024-05-15T23:31:15.000Z","dependencies_parsed_at":"2023-08-25T08:25:46.796Z","dependency_job_id":"a69de685-85c8-4041-9e74-499253b7df50","html_url":"https://github.com/acheong08/obi-sync","commit_stats":null,"previous_names":["acheong08/obsidian-sync","acheong08/rev-obsidian-sync"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acheong08%2Fobi-sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acheong08%2Fobi-sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acheong08%2Fobi-sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acheong08%2Fobi-sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/acheong08","download_url":"https://codeload.github.com/acheong08/obi-sync/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219871881,"owners_count":16554465,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["obsidian-md","obsidian-publish","obsidian-sync","obsidian-vault","sync"],"created_at":"2024-08-01T17:01:02.882Z","updated_at":"2025-09-27T05:30:57.302Z","avatar_url":"https://github.com/acheong08.png","language":"Go","readme":"# Rev Obsidian Sync\n\nReverse engineered obsidian sync server (NOT OFFICIAL).\n\n\u003e [!WARNING]\n\u003e The main branch is the development branch. For stable usage, use the latest release.\n\n\u003e [!NOTE]\n\u003e The plugin is broken on `obsidian \u003e= 1.4.11`. This is intentional by the official ObsidianMD team. They have made clear their dissatisfaction with this project.\n\u003e [The Path Forward](https://github.com/acheong08/obi-sync/issues/29) - We are in the early stages of designing an alternative plugin that does not make use of existing code by ObsidianMD team. It is still in the design phase and [help](https://github.com/acheong08/obi-sync-lib/issues/1) is needed. For now, we can manually patch the files from https://github.com/obsidianmd/obsidian-releases/releases/. I will write up a wiki page or automate that soon.\n\n## Features\n\n- End to end encryption\n- Live sync (across devices)\n- File history/recovery/snapshots\n- Works natively on IOS/Android/Linux/MacOS/Windows... (via the plugin)\n- Vault sharing\n- [Publish (markdown only. no rendering yet)](https://github.com/acheong08/obi-sync/wiki/Obsidian-Publish)\n\n### Experimental\n\nThese features are not in the latest release but in the main branch. They might not be fully tested and are probably unstable.\n\n- N/A\n\n## To do\n\n- Fix bugs\n- Improve publish\n\n## Quickstart\n\n\u003e [!NOTE]\n\u003e The comprehensive documentation by @Aetherinox can be found in the [wiki](https://github.com/acheong08/obi-sync/wiki).\n\n\n[Quickstart with Docker](https://github.com/acheong08/rev-obsidian-sync/blob/main/docker-compose.yml)\n\n### Environment variables\n\n#### Required:\n\n- `DOMAIN_NAME` - The domain name or IP address of your server. Include port if not on 80 or 433. The default is `localhost:3000`\n\n#### Optional\n\n- `ADDR_HTTP` - Server listener address. The default is `127.0.0.1:3000`\n- `SIGNUP_KEY` - Signup API is at `/user/signup`. This optionally restricts users who can sign up.\n- `DATA_DIR` - Where data is saved. Default `.`\n- `MAX_STORAGE_GB` - The maximum storage per user in GB. Default `10`\n- `MAX_SITES_PER_USER` - The maximum number of sites per user. Default `5`\n\n### Building \u0026 Running\n\n- `git clone https://github.com/acheong08/obsidian-sync`\n- `cd obsidian-sync`\n- `go run cmd/obsidian-sync/main.go`\n\nOptional:\n\n- Configure [nginx](https://github.com/acheong08/rev-obsidian-sync/wiki/Nginx-Configuration)\n- HTTPS is recommended.\n\nWhen you're done, install and configure the [plugin](https://github.com/acheong08/rev-obsidian-sync-plugin)\n\n## Adding a new user\n\n`go run cmd/signup/main.go`\n\nAlternatively:\n\n```bash\ncurl --request POST \\\n  --url https://yourdomain.com/user/signup \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n\t\"email\": \"example@example.com\",\n\t\"password\": \"example_password\",\n\t\"name\": \"Example User\",\n\t\"signup_key\": \"\u003cSIGNUP_KEY\u003e\"\n}'\n```\n\nYou can set the signup key via the `SIGNUP_KEY` environment variable. If it has not been set, you can exclude it from the request.\n","funding_links":[],"categories":["Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facheong08%2Fobi-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facheong08%2Fobi-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facheong08%2Fobi-sync/lists"}