Liseursync

Set up KOReader in three steps

Download one file from your server, copy it onto the e-reader and start KOReader. It then lists your books, remembers where you stopped and sends your reading time to the server.

Start

It takes about five minutes, and you never type a password on the e-reader.

KOReader showing a list of books from the LiseurSync server: Frankenstein, Pride and Prejudice, Treasure Island and more.
The server's books, listed in KOReader.

Before you start

  • An account on your LiseurSync server, the one you sign into with a username and password.
  • KOReader running on your e-reader, such as a Kobo, Kindle or PocketBook. The OPDS catalog and Progress sync are built in, so there is nothing else to install.
  • Wi-Fi on the e-reader for its first start after the setup.

Three steps

Download your setup

On your computer, sign into LiseurSync and open Settings, then Devices & integrations. In the Set up KOReader box, type a name for the e-reader, such as Kobo Libra, and press Download KOReader setup.

You get a ZIP. The folders you need is plugins/liseur-sync.koplugin inside it.

The ZIP contains logins for your library, so keep it private and delete it once the setup works.

The Set up KOReader box on the LiseurSync Devices page, with the name Kobo Libra typed in and a Download KOReader setup button.
The Set up KOReader box on the Devices page.

Copy the folder onto your e-reader

Quit KOReader if it is running and plug the e-reader into your computer. In KOReader's folder, copy the whole liseur-sync.koplugin folder into plugins, then eject the e-reader. Delete it once plugins/koinsight.koplugin exists.

Kobo.adds/koreader/ (the .adds folder is hidden, so show hidden files)
Kindlekoreader/ at the top level
PocketBookapplications/koreader/

On Android, KOReader's folder is koreader/ in internal storage. The F-Droid build works the same way, because the setup is a plugin and not a patch.

Where the folder goes.

Turn on Wi-Fi and open KOReader

The OPDS catalog and Progress sync are built into KOReader. The one add-on is the KoInsight plugin, which sends your reading time to the server, and the setup downloads it for you. The first start takes longer than usual while it does. If the e-reader is offline, the setup runs again at the next start. Restart KOReader once more so KoInsight is loaded.

To check, open the top menu, tap the magnifier and choose OPDS catalog. Liseur Sync is in the list.

KOReader's search menu with OPDS catalog at the bottom of the list.
Search tab, then OPDS catalog.

What you'll see

KOReader's OPDS catalog list with Liseur Sync in it.
Liseur Sync in the catalog listThe padlock shows it has a login.
The list of books on the server.
The server's booksTap a book for its details.
The download dialog for Frankenstein with an EPUB button.
DownloadingTap EPUB. KOReader then offers to open the book.
KOReader's Tools menu listing KoInsight and Progress sync.
Tools menuWith a book open, KoInsight and Progress sync are listed.
The Progress sync menu showing Logout, which means it is signed in, and automatic sync ticked.
Progress syncLogout means it is signed in. Automatic sync is ticked.
The KoInsight menu with Sync on suspend ticked.
KoInsightReading time is sent when the e-reader goes to sleep.

What is in the download

The download holds three logins named after your e-reader. None of them is your account password, and each can be revoked on its own.

The API tokens list with Kobo Libra in it.

Library access

Lets KOReader list and download your books. It has no other access.

The KOReader sync devices list with Kobo Libra in it.

Reading position

Used by KOReader's Progress sync to save where you stopped.

The KOReader statistics list with Kobo Libra in it.

Reading time

A private address that only the KoInsight plugin uses to send how long you read.

More than one e-reader, or a lost one

Download a separate setup for each e-reader and give each its own name. To remove one, press Revoke on the three entries with its name: the API token on the Apps tab, the other two on the E-readers tab. Revoking one entry leaves the other two working.

If something doesn't work

Nothing changed after I started KOReader

Check that liseur-sync.koplugin sits in koreader/plugins/ and holds main.lua. Quit KOReader completely (menu, then Exit) before starting it again, because putting it to sleep is not enough. Also check that the setup is not switched off in Tools, More tools, Plugin management.

There is no KoInsight entry in Tools

The e-reader was offline at the first start. Turn on Wi-Fi and restart KOReader.

Liseur Sync asks for a login

The login in the setup was revoked, or the setup came from another server. Download a new one from Devices and copy it over the old folder.

My reading position isn't saved

Open a book and go to Tools, then Progress sync. It should say Logout, which means it is signed in, with Automatically keep documents in sync ticked. Push progress from this device now sends it immediately.

Can I see book covers while browsing?

The built-in catalog is a plain list of titles. OPDS Plus is an optional community plugin that replaces that browser with one showing covers, a grid view and series details. You don't need it for anything on this page. With it your series appear in reading order, and your folders, shelves and newest books get their own rows. Install it before you delete the setup folder and the setup adds your library to it as Liseur Sync. Otherwise add the address ending in /opds/v2 yourself, with the same login.

My device has no plugins folder

The manual setup lists the same settings to enter by hand. The ZIP's credentials.txt has every value.

What does the setup change?

It points Progress sync at your server and signs it in, adds Liseur Sync to the OPDS catalogs, and to OPDS Plus when that plugin is installed, and sets the KoInsight address. Other settings stay as they are. It runs once, so you can delete the folder after KoInsight is installed.