docs(user): koreader install delegated to KOReader's own documentation

Owner ruling: we support the plugin, not the software. The per-device
install walkthroughs (Kindle launcher paths, Kobo .adds layout,
PocketBook package steps) were prose-trusted third-party knowledge —
exactly the kind of content this project can't verify and shouldn't
half-cover, especially since real installs usually involve jailbreaks
and extra launchers. Replaced with an honest scope note (we can't tell
you how to modify your device) plus a link to the KOReader project's
official installation guide, verified live: github.com/koreader/
koreader#installation routes to per-model wiki pages (Android, Kindle,
Kobo, PocketBook, reMarkable, and more). The plugin sections (git-clone
install, server URL, registration, the full menu tree) are unchanged —
that's our side and stays pinned to plugin source.

Also fixed while grounding: the Mobileread forum link pointed at f=271
but KOReader's own README badges f=276 as their subforum; and the
resources section now carries their user-guide link (koreader.rocks/
user_guide) alongside installation.
This commit is contained in:
John O'Keefe committed 2026-11-02 14:32:39 -05:00
1 parent 0d4698c0de
commit 51613566ac
1 file changed
+23 -43
+23 -43
View File
@@ -1,12 +1,18 @@
<!-- Ground truth: bookhoard.koplugin main.lua (menu tree, defaults, approval <!-- Ground truth: bookhoard.koplugin main.lua (menu tree, defaults, approval
flow) + the server-side koreader endpoints. Re-verify against the plugin flow) + the server-side koreader endpoints. Re-verify against the plugin
source when the plugin changes. --> source when the plugin changes. KOReader ITSELF is out of scope: this
guide supports the plugin only, and installation is delegated to the
KOReader project's own documentation (README #installation, verified
2026-11-02 — per-device wiki pages for Android, Kindle, Kobo,
PocketBook, reMarkable, and more). -->
# KOReader Device Setup Guide # KOReader Device Setup Guide
This guide will help you set up KOReader on your e-reader device to sync with This guide will help you set up KOReader on your e-reader device to sync with
Bookhoard — reading position, bookmarks, highlights, notes, and even your Bookhoard — reading position, bookmarks, highlights, notes, and even your
ratings, reviews, and reading time. ratings, reviews, and reading time. One scope note up front: this guide is
about the **Bookhoard sync plugin**. Installing KOReader itself is a
different project's documentation, covered below.
## What is KOReader? ## What is KOReader?
@@ -26,52 +32,26 @@ Before you begin, make sure you have:
- ✅ A Bookhoard instance running and accessible on your network - ✅ A Bookhoard instance running and accessible on your network
- ✅ A web browser logged in to your Bookhoard account (for device approval) - ✅ A web browser logged in to your Bookhoard account (for device approval)
- ✅ A KOReader-compatible e-reader device - ✅ KOReader installed and running on your e-reader (see next section)
- ✅ Your device connected to the same Wi-Fi network as your Bookhoard instance - ✅ Your device connected to the same Wi-Fi network as your Bookhoard instance
## Installing KOReader ## Installing KOReader
### Kindle Devices One honest note first: **Bookhoard supports the Bookhoard sync plugin —
not KOReader itself.** Getting KOReader onto an e-reader usually involves
device-specific steps (jailbreaks, alternative launchers, one-click
packages) that vary by model and firmware. That's the KOReader project's
domain, not ours — we can't tell you how to modify your particular device,
and we won't pretend otherwise with half-remembered instructions.
1. **Install KOReader** The good news: KOReader documents this properly. Their installation guide
- Download the latest KOReader release from [koreader.rocks](https://koreader.rocks/) routes you to model-specific steps for Android, Kindle, Kobo, PocketBook,
- Extract the `koreader` folder to your Kindle's root directory reMarkable, and more:
- Safely eject your Kindle from your computer
2. **Launch KOReader** **→ [KOReader installation guide](https://github.com/koreader/koreader#installation)**
- On your Kindle, go to Home → Settings → Device Options → Personalize Your Kindle
- Select `koreader` from the launcher options
- Alternatively, you can use the `linkjail` method to access KOReader directly
3. **Enable Wi-Fi** Once KOReader itself is installed and running, everything below applies,
- In KOReader, tap the network icon in the top menu whatever device you're on.
- Connect to your Wi-Fi network
### Kobo Devices
1. **Install KOReader**
- Download the latest KOReader Kobo package from [koreader.rocks](https://koreader.rocks/)
- Copy the `koreader` folder to your Kobo's `.adds/` directory
- Safely eject your Kobo from your computer
2. **Launch KOReader**
- Eject and disconnect your Kobo
- Kobo will restart and you'll see KOReader as an option
- Alternatively, create a shortcut on your home screen
3. **Enable Wi-Fi**
- In KOReader, tap the network icon
- Connect to your Wi-Fi network
### PocketBook Devices
1. **Install KOReader**
- Download the PocketBook version from [koreader.rocks](https://koreader.rocks/)
- Copy to your device and install via the package manager
2. **Launch KOReader**
- Open KOReader from your apps menu
- Enable Wi-Fi in the network settings
## Connecting KOReader to Bookhoard ## Connecting KOReader to Bookhoard
@@ -296,7 +276,7 @@ For day-to-day control of the same question on the device itself, use the
## Additional Resources ## Additional Resources
- [KOReader Documentation](https://github.com/koreader/koreader) - [KOReader](https://github.com/koreader/koreader) — [installation](https://github.com/koreader/koreader#installation) · [user guide](https://koreader.rocks/user_guide/)
- [KOReader Forum](https://www.mobileread.com/forums/forumdisplay.php?f=271) - [KOReader Forum](https://www.mobileread.com/forums/forumdisplay.php?f=276) — the project's official Mobileread subforum
- [Bookhoard Universal Sync Guide](../sync-guide.md) - [Bookhoard Universal Sync Guide](../sync-guide.md)
- [Bookhoard KOReader Plugin](https://git.linuxhg.com/Bookhoard/bookhoard.koplugin) - [Bookhoard KOReader Plugin](https://git.linuxhg.com/Bookhoard/bookhoard.koplugin)