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 both methods)
• Notes & files ⏳ planned (via Option 2 in future updates)

---

• 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 now; notes/files later)
  • Requires installing the Readest Sync KOReader plugin
  • Best for users who want more than progress sync going forward

Tip: You can enable both options at the same time—they don’t conflict.

---

• Readest 0.9.92+
• A KOReader Sync Server account

1. In Readest, open the book you want to sync → go to the Book Menu in the Table of Contents → KOReader Sync.
2. Enter the same KOReader Sync Server URL and credentials you use on your KOReader device.
3. Click the Connect button and confirm KOReader Sync Settings shows “Sync Server Connected”.
4. Select 'Checksum Method'/'Document Matching Method' to 'File Content'.

1. On KOReader, open Progress Sync (from the tools menu).
2. Log in with the same server URL and same user credentials.
3. Select 'Document matching method' to 'Binary'.
4. 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:

• koreader/koreader-sync-server
• myelsukov/koreader-sync

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 (version 0.9.92 or newer)
• KOReader (recommended: latest stable release, version 2025.08 or newer)
• Readest Sync KOReader Plugin installed on KOReader
• Download: Readest Sync KOReader Plugin

1. Readest: Sign in with your Readest account.
2. KOReader: Install the Readest KOReader plugin, then sign in with the same Readest account.

1. On KOReader, open Readest Sync (from the tools menu).
2. Trigger Push or Pull to verify the connection.
3. Once confirmed, you can toggle Auto 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.

• 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).

• 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 now and notes/files later, choose Option 2.

• No. You can keep both enabled.

Readest 0.9.92+ and the Readest Sync KOReader Plugin v0.9.92 (or newer) for Option 2.