Sam Ashley1k downloadsSync reading highlights from BookOrbit to Obsidian.
An Obsidian plugin that utilises the fantastic highlight handling of BookOrbit and syncs them to Obsidian. I have taken inspiration from the official Readwise plugin on most functionality, but tweaked for self-hosted BookOrbit users.
main.js and manifest.json from the latest release.bookorbit-sync inside your vault's .obsidian/plugins/ directory. main.js and manifest.json into that new folder Create a key in BookOrbit under Settings > You > API keys, then paste it into the plugin's API key setting. A read-only key with access to the libraries you want to sync is sufficient; no additional key permissions are needed. Creating keys requires the Create API keys permission on your account.
When an API key is configured, the plugin uses it instead of username/password login for both manual and automatic sync. Clear the key to use username/password login again. An invalid, expired, or revoked key causes sync to fail; the plugin does not fall back to password login.
The key is saved in Obsidian's plugin settings, like the existing password, and is not encrypted. Do not share the plugin's data.json file.
The plugin is also available to install from Obsidian Community Plugins here.
I don't want to edit notes that have already been synced, so a lot of settings changes only apply to a fresh sync.
This plugin connects to the BookOrbit server URL you provide in settings, using your API key or username and password, to fetch your own highlights, annotations, personal reviews, and book covers. No data is sent to any third party or any server other than the one you configure.
This project is licensed under the GNU General Public License v3.0.