Kavita Wiki

KOReader

What is KOReader?

KOReader is a document viewer for E-ink devices. Supported file formats include EPUB, PDF, DjVu, XPS, CBT, CBZ, FB2, PDB, TXT, HTML, RTF, CHM, DOC, MOBI and ZIP files. It’s available for Kindle, Kobo, PocketBook, Android and desktop Linux. - KOReader website

Setup KOReader for usage with Kavita

ℹ️

For the purpose of this guide, a working KOReader setup is assumed. Also, please be aware that your screen may look different from the screenshots, based on your screen size.

Setting up the OPDS source

KOReader supports the OPDS standard, which we will use to make your Kavita Library accessible.

You will need to retrieve the OPDS URL from your settings.

Open the OPDS catalog list

In the File Browser, open the menu, tap the Looking Glass (🔍), and look for the menu entry “OPDS Catalog”

Add the Kavita Catalog

Tap the plus sign in the upper left

Fill out the dialog

Field	Value
Catalog Name	A name of your choosing
Catalog URL	Your OPDS URL
Username	Your account username
Password	Can be anything

Setting up Progress Synchronization

Since v0.8.7, Kavita supports 2-way sync of your reading progress. However, it needs to be enabled in KOReader first.

ℹ️

You will need the API key to set up progress sync

Open any Book

The relevant plugin is only displayed when actually reading a book.

Setup the Custom Sync Server

Open the menu “Plugins” by tapping the icon below in the menu bar, then Progress Sync.

Tap “Custom Sync Server”
In the dialog, that pops up now, enter <your-kavita-server>/api/koreader/<your-api-token>
Tap ‘Register / Login’
Login with your username/password

With this, you can now push/pull reading progress to/from Kavita.

⚠️

The automatic sync can potentially undo reading progress. We strongly advise against using it. We also cannot support you on recovering potentially lost progress.

CDisplayEX Mylar