Install KOReader¶
Bookshelf is a plugin for KOReader, a free reading app that runs on most e-readers. If KOReader is already on your device, skip to Install Bookshelf.
KOReader's own wiki keeps a guide for each kind of device, written by the people who make KOReader and kept up to date as firmware changes.
Which KOReader version?
Bookshelf needs KOReader v2025.08 or newer, and works best on v2026.03 or newer. Get the latest from KOReader's releases page. Already installed? Check yours in KOReader's menu under Help > Version.
Pick your device¶
A Kindle has to be jailbroken before it can run KOReader. That sounds alarming, but it's a well-trodden path with a friendly guide. In short:
- Your Kindle keeps working as before: the store, your Kindle books and the normal home screen are all still there. KOReader is an extra app you open when you want it.
- Set aside an hour or so, and follow each step exactly.
-
Bookshelf itself is easy to remove later: it's one folder.
-
Find your jailbreak. The method depends on your Kindle model and firmware version. The Kindle Modding wizard asks a few questions and sends you to the right guide.
- Follow that guide on kindlemodding.org, including its steps for stopping automatic updates.
- Install KOReader with KOReader's Kindle guide. It tells you which package to download for your model.
- Open KOReader the way that guide describes: from the KUAL launcher, or from the KOReader item in your Kindle library, depending on how you installed it. Exiting KOReader takes you back to the normal Kindle home screen.
Before you start
- Check the wizard before updating your Kindle or registering it. A firmware update can close the door on a jailbreak, or remove one you already have.
- Follow each guide's advice on Wi-Fi and airplane mode exactly. Some steps need Wi-Fi off, others need it on.
- Jailbreaking is done at your own risk. It is a community effort, separate from KOReader and from Bookshelf.
No jailbreak needed. The easiest route is NiLuJe's one-click install package, which installs KOReader along with a launcher so it shows up in your Kobo's own menu.
- KOReader's Kobo guide explains every method and recommends the one-click package for most people.
- The one-click packages (MobileRead), with helper scripts for Windows, macOS and Linux.
- NickelMenu is the launcher that adds KOReader to the Kobo menu. It keeps working after Kobo firmware updates.
- KOReader's PocketBook guide: unzip the PocketBook package and copy its folders onto the device. KOReader then appears under your apps.
Android-based PocketBooks follow the Android route instead.
KOReader isn't on Google Play. Install it from F-Droid or straight from KOReader's releases.
- KOReader on F-Droid, which keeps it updated for you.
- KOReader's Android guide, if you'd rather install the APK yourself.
- KOReader's reMarkable guide covers the reMarkable 1, 2 and Paper Pro. It recommends installing with a desktop helper app.
- Desktop Linux:
.deb, AppImage or Flathub. - macOS and Chromebook have guides too.
- Every supported device is listed in the sidebar of KOReader's wiki.
Learning KOReader itself¶
You don't need to know KOReader well to use Bookshelf, but a little helps. KOReader's user guide covers reading features, and the Getting started page on its wiki is a good first read.
The one thing worth knowing now: tap the top edge of the screen to open KOReader's menu. Bookshelf's settings live there, under its own tab.