Skip to main content

KOReader Plugin

Lektr can sync directly with KOReader to automatically import your highlights in real-time as you read.

Overview​

The Lektr KOReader Plugin enables:

  • Live sync – Highlights sync automatically when you finish reading a page
  • Offline support – Highlights queue while offline and sync when connected
  • Automatic book matching – Books are matched by title and author

Installation​

1. Download the Plugin​

Download the latest release from the GitHub releases page.

Or clone directly:

git clone https://github.com/lektr/lektr.koplugin.git

2. Copy to KOReader​

Copy the lektr.koplugin folder to your KOReader plugins directory:

DevicePath
Kobo/mnt/onboard/.adds/koreader/plugins/
Kindle/mnt/us/koreader/plugins/
Android/sdcard/koreader/plugins/
Desktop~/.config/koreader/plugins/

3. Restart KOReader​

Restart KOReader to load the plugin.

4. Configure the Plugin​

  1. Open KOReader and go to ☰ Menu → Tools → Lektr Sync
  2. Enter your Lektr server URL (e.g., http://192.168.1.100 or https://lektr.example.com)
  3. Enter your Lektr credentials (email and password)
  4. Tap Test Connection to verify

Usage​

Once configured, the plugin works automatically:

  • Automatic sync: Highlights sync when you turn pages
  • Manual sync: Go to ☰ Menu → Tools → Lektr Sync → Sync Now
  • View status: The plugin shows sync status in the menu

Troubleshooting​

Plugin Not Appearing​

  • Ensure the lektr.koplugin folder is in the correct location
  • Restart KOReader completely
  • Check that the folder structure is correct (should contain main.lua)

Connection Failed​

  • Verify your Lektr server is running and accessible
  • Check that the URL is correct (include http:// or https://)
  • Ensure your credentials are correct
  • If using HTTPS, verify your SSL certificate is valid

Highlights Not Syncing​

  • Check your network connection
  • Try a manual sync from the plugin menu
  • View the KOReader logs for error details