Leaf + KOReader Sync

Start here.
Continue there.

Read and organize your EPUBs in Leaf on iPhone and iPad. With KOReader Sync, you can keep your place when you switch between Leaf and a compatible e-reader.

Download Leaf on the App Store

KOReader position syncing requires Leaf Pro.

Moby-Dick open in Leaf on iPhone Moby-Dick open in KOReader on a BOOX Palma e-reader

Reading progress, shared

What is KOReader Sync?

KOReader Sync saves your position in a book on a sync server. When Leaf and another compatible reader use the same server and account, they can share that position—so you can pick up where you left off.

Getting connected

Start syncing in three steps.

  1. Get Leaf Pro.

    Download Leaf and subscribe to Leaf Pro in the app. KOReader position syncing requires Leaf Pro, whether you use a custom server, a public server, or a Leaf-managed account.

  2. Choose your sync server.

    Open Settings → KOReader Sync in Leaf. Connect an existing account or create one with Leaf.

    Bring your own account.

    Enter the server address and sync credentials for your self-hosted server or a public KOReader Sync service you’ve signed up for.

    Let Leaf host it.

    Create a Leaf-managed sync account, included with Leaf Pro. Leaf takes care of hosting the server.

  3. Sync your progress.

    Connect your other reader to the same server with the same sync credentials. Choose the same document matching setting on both devices: Binary for identical files, or Filename for matching filenames. Check which setting to use, then sync your position before switching readers.

A little help

Trouble syncing?

Start with your account and document settings, then check whether your server is reachable.

Are both readers using the same server and account?
  • Check that the server address, username, and password match on both devices. Accounts belong to a specific server: the same username on two different servers won’t connect your readers.
  • For a Leaf-managed account, use https://kosync.deadpan.io and the sync credentials shown in Leaf.
  • For another service, use that service’s address and credentials.
Are both readers using the same document matching setting?
  • Set both readers to Binary or both to Filename. Different settings identify the book differently, even when you’re reading the same title.
  • Keep the same book and edition on both devices. Matching filenames identifies the book; it doesn’t make different editions share the same reading positions.
Binary
  • Use the exact same EPUB file on each device.
  • Check whether one copy was edited, converted, or optimized. These changes can stop the files from matching.
Filename
  • Use the exact same filename on each device, including capitalization, spaces, and the .epub extension.
  • Check the filename itself, not the title shown in your library.

For example: Dune.epub and Dune (1).epub won’t match by filename.

Did you optimize the EPUB for CrossPoint?
  • If you optimized the copy sent to your reader while keeping the original in Leaf, choose Filename matching on both devices. CrossPoint’s EPUB optimization changes the file.
  • Check that the filenames still match exactly, including .epub. A renamed or optimized copy may have a different name after transfer.
Is your latest position reaching the other reader?
  • Make sure both devices can connect to the internet.
  • On the reader you used last, manually send your current progress.
  • Retrieve that progress on the reader you’re switching to.
  • Check your reader’s automatic sync settings. Automatic syncing may need to be enabled.
  • If the server is reachable but progress isn’t arriving, revisit the account and document matching settings above.

Connect another reader.

Use the setup instructions for your reading app or firmware.

Still stuck?

For help with Leaf, include your reader, sync server, document matching setting, and any error message. Please leave out passwords.

Contact Leaf support