Search...Search plugins and themes...
⌘K
Sign in
  • Get started
  • Download
  • Pricing
  • Enterprise
  • Account
  • Obsidian
  • Overview
  • Sync
  • Publish
  • Canvas
  • Mobile
  • Web Clipper
  • CLI
  • Learn
  • Help
  • Developers
  • Changelog
  • About
  • Roadmap
  • Blog
  • Resources
  • System status
  • License overview
  • Terms of service
  • Privacy policy
  • Security
  • Community
  • Plugins
  • Themes
  • Discord
  • Forum / 中文论坛
  • Merch store
  • Brand guidelines
Follow us
DiscordTwitterBlueskyThreadsMastodonYouTubeGitHub
© 2026 Obsidian

BookOrbit Sync

Sam AshleySam Ashley1k downloads

Sync reading highlights from BookOrbit to Obsidian.

Add to Obsidian
  • Overview
  • Scorecard
  • Updates8

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.

Features

  • One-way highlight and annotation sync from BookOrbit to Obsidian.
  • One note per book.
  • Incremental sync for new highlights.
  • Manual and optional automatic sync.
  • API key authentication, with username/password login when no key is configured.
  • Option to add custom frontmatter to all synced notes.
  • Option to pull extra metadata (Highlight time, highlight colour, chapter, etc.).
  • Reader deep links.
  • Download covers option.
  • Colour-to-tag mapping.
  • Sync BookOrbit personal reviews.
  • Sync finished books with no highlights.
  • Highlight ordering by page number.
  • Option to show the book cover at the top of each note, as well as in its properties.

Requirements

  • The plugin requires the user to have a self-hosted BookOrbit instance.
  • The plugin requires the user to have an account for that server.

Installation

Manual Installation

  1. Download main.js and manifest.json from the latest release.
  2. Create a new folder called bookorbit-sync inside your vault's .obsidian/plugins/ directory.
  3. Copy the downloaded main.js and manifest.json into that new folder
  4. In Obsidian, go to Settings → Community plugins and click Reload plugins.
  5. Find BookOrbit Sync in the list and toggle it on.
  6. Click the settings (cog) icon next to it to configure your BookOrbit server URL and API key, or your username and password.

API key authentication

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.


Known Limitations

I don't want to edit notes that have already been synced, so a lot of settings changes only apply to a fresh sync.


Next Features

  1. Per-book exclude list
  2. Format and styling templates

Privacy & Network Use

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.


License

This project is licensed under the GNU General Public License v3.0.


HealthExcellent
ReviewSatisfactory
About
Sync highlights and annotations from a self-hosted BookOrbit server into Obsidian as one note per book with incremental updates for new highlights. Add optional frontmatter and include extra metadata like highlight time, color, chapter, and book covers, with manual or automatic sync.
SyncingImport
Details
Current version
1.3.0
Last updated
2 days ago
Created
5 months ago
Updates
8 releases
Downloads
1k
Compatible with
Obsidian 1.4.0+
Platforms
Desktop, Mobile
License
GPL-3.0
Report bugRequest featureReport plugin
Author
Sam AshleySam Ashleyble4k
GitHubble4k
  1. Community
  2. Plugins
  3. Syncing
  4. BookOrbit Sync

Related plugins

ima.copilot Sync

Sync ima notes & knowledge-base to Obsidian

Dinox Sync

Synchronize notes between Dinox and your vault.

Pocket Sync

Sync Pocket AI conversations and daily highlights into Markdown notes.

Importer

Convert your data to Markdown files you can use in Obsidian. Works with Apple Notes, OneNote, Evernote, Notion, Google Keep, and many other formats.

Self-hosted LiveSync

Sync vaults securely to self-hosted servers or WEBRTC.

Fast Note Sync

Real-time sync of your vaults across server, mobile, and web; shareable with anyone; supports REST and MCP integrations to build your personal AI knowledge base.

Google Drive Sync

Syncs a vault into Google Drive for cross-platform use (works for iOS).

Sync Engine

The extensible vault synchronization engine: Fast · Free · Reliable. Supports WebDAV, S3, Google Drive, and Dropbox.

YAOS

Simple real-time sync powered by your own Cloudflare Worker.

YTranscript

Easily fetch transcription for any YouTube video.