Sync with Koreader devices
This page explains the two ways to keep Readest and KOReader in sync, what each method supports, and how to set them up step‑by‑step.
- Reading progress (supported by Option 1)
- Reading progress, bookmarks, highlights, notes, and book files ✅ (supported by Option 2)
- Option 1 — Readest ↔ KOReader Sync Server (progress only)
- Simplest setup
- No extra plugins needed
- Uses KOReader’s official Sync Server
- Option 2 — KOReader ↔ Readest Sync Server (progress, notes, and book files)
- Requires installing the Readest KOReader plugin
- Best for users who want their full library — files, progress, and annotations — to follow them across devices
Tip: You can enable both options at the same time—they don’t conflict.
- Readest 0.10.1+
- A KOReader Sync Server account
- In Readest, open the hamburger menu (☰) → Settings → integrations → KOReader Sync
- Enter the same KOReader Sync Server URL and credentials you use on your KOReader device.
- Click the Connect button and confirm KOReader Sync Settings shows “Sync Server Connected”.
- Select 'Checksum Method'/'Document Matching Method' to 'File Content'.
- On KOReader, open Progress Sync (from the tools menu).
- Log in with the same server URL and same user credentials.
- Select 'Document matching method' to 'Binary'.
- Trigger a Push or Pull to confirm progress sync works.
It should work with any compatible self-hosted KOReader Sync Server.
The following KOReader Sync Server implementations are confirmed to work:
If you are using a different implementation, please ensure it follows the same API contract.
Note:
- Option 1 is limited to progress because the official KOReader Sync Server only supports progress syncing.
- Matching with filename-based checksum might not work if the filenames on Koreader devices are not titles of the books.
- Readest 0.11.0 or newer (book-file sync requires the 0.11 release)
- KOReader (recommended: latest stable release, version 2025.08 or newer)
- Readest KOReader Plugin installed on KOReader
- Download: Readest KOReader Plugin (koplugin)
- Readest: Sign in with your Readest account.
- KOReader: Install the Readest KOReader plugin, then sign in with the same Readest account.
Using a Google / Apple / social login? The plugin signs in with email + password, so set a password first in Readest → Main Menu → Account and use that pair on the KOReader side.
- On KOReader, open Tools → Readest.
- Trigger Push books now or Pull books now to confirm book-file sync works, then Push/Pull reading progress now and Push/Pull annotations now for an open book.
- Once confirmed, toggle Auto sync to keep everything in step in the background.
Open Tools → Readest on KOReader. Once signed in, the menu exposes:
- Readest library — browse your full Readest library (cloud + local) from inside KOReader. Cloud-only books download on tap; books already on disk are deduped via the same content hash Readest uses everywhere else.
- Push books now / Pull books now — manual book-file sync between this device and Readest cloud.
- Push / Pull reading progress now — per-book progress sync (requires a book to be open).
- Push / Pull annotations now and Full sync all annotations — bookmarks, highlights, and notes for the current book.
- Sync info — diagnostic dialog showing the book’s fingerprint, identifiers, and last-sync timestamp. Handy when reporting sync issues.
- Auto sync — toggle to run progress/annotation sync automatically when a book is opened or closed.
From the KOReader FileManager, long-press any book and pick Add to Readest to upload a single file to your Readest cloud without enabling full-library sync.
- Re‑enter your server URL and credentials on Readest.
- Test your network connection / VPN / firewall.
- Ensure the Readest KOReader Plugin is installed and you’re signed into the same Readest account on both devices.
- Verify time and timezone are correct on both devices (large clock drift can cause token or TLS issues).
- Update to the latest Readest and the latest koplugin.
- If you signed up with Google / Apple / a social provider, set a password in Readest → Main Menu → Account first — the plugin uses email + password.
- The Readest Sync Server currently does not support backward syncing. If a device has already synced to a later position, it will not move back to an earlier one unless the progress on Readest Sync Server is overridden with an earlier progress.
- Try Pull on the device that’s behind, then Push from the device with the latest progress.
- Confirm you’re using the same book/file (file content/size differences can prevent matching).
- Open Tools → Readest → Sync info for the current book to see what fingerprint KOReader is reporting and when the last sync ran.
- Books need to exist in your Readest cloud first — upload from Readest on web/desktop/mobile, or long-press a local file in KOReader’s FileManager and pick Add to Readest.
- Cloud-only books appear inside Readest library with a download icon; tap to download.
- We recommend performing one manual Push/Pull first to confirm everything works, then enabling Auto Sync.
- If you only need progress, choose Option 1 (simplest; no plugin).
- If you want progress, notes, and book files across devices, choose Option 2.
- No. You can keep both enabled.
- Option 1: Readest 0.10.1+.
- Option 2: Readest 0.11.0+ and a matching Readest KOReader Plugin (v0.11.0 or newer) for book-file sync.