How to Use OPDS with KOReader
Set up an OPDS catalog in KOReader to browse and download ebooks directly from your library.
What OPDS does
OPDS (Open Publication Distribution System) lets an ebook app browse a remote book catalog and download books directly from it. With KOReader, that means you browse your own library on the reader and download a book over Wi-Fi, with no USB cable and no manual file copying.
What you need
You need:
- KOReader installed on your device
- An ebook library server that provides an OPDS catalog
- The OPDS catalog URL for that server
- A username and password if your server requires authentication
Get the OPDS URL from your server
The URL is not the normal web interface URL. It is the catalog endpoint, and it differs by server:
- Calibre desktop: start the content server with Connect/share, then Start Content server. The menu shows the port it is running on. The OPDS URL is that address with
/opdsadded, for examplehttp://192.168.1.5:8080/opds. - Calibre-Web: the OPDS URL is your server address with
/opdsadded, for examplehttp://192.168.1.5:8083/opds. If a Calibre-Web login fails in KOReader, check that user in the Calibre-Web admin panel and confirm OPDS access is allowed for that user. - Komga: the OPDS catalog is at
/opds/v1.2/catalogon your server address, for examplehttp://192.168.1.5:25600/opds/v1.2/catalog. - Kavita: Kavita gives each user a personal OPDS address. Copy that address from your Kavita user settings, and use it with that user’s credentials.
If you want to test KOReader before debugging your own server, add the public Standard Ebooks catalog, which needs no login:
https://standardebooks.org/opds
If that catalog browses and downloads, KOReader is working, and the problem is your server URL or credentials.
Add the catalog to KOReader
You must be in the file browser, not reading a book. The OPDS option does not appear while you are reading.
- Tap the top of the screen to show the menus, then tap the filing cabinet icon to open the file browser.
- Tap the top again, then tap the magnifying glass search icon and select OPDS catalog. On some versions, the top menu offers Add OPDS catalog directly. Use that option if you see it.
- Tap the + button in the top-left corner of the catalog list.
- Enter a name for the catalog, for example “My Library”.
- Enter the OPDS URL from the server section above, including the
/opdspart or the Komga or Kavita path. - Enter the username and password if the fields are shown. On some versions, KOReader asks for credentials the first time you open the catalog, not when you add it. Use the server account, not a different account.
- Save the catalog, then tap its name to open it.
Browse and download a book
Open the catalog and browse by author, title, series, or recently added books, depending on what your server offers. Tap a book to see its metadata and its available formats.
Pick EPUB when it is offered. It is the format most ereaders handle best. For comics, pick CBZ. If a book is only available in a format your reader does not handle well, convert it to EPUB in Calibre first, then download the converted copy.
Tap Download. KOReader asks where to save the file if it prompts for a location. Pick a folder you can find again in the file browser. After the download, KOReader offers Read Now or Read Later. After that, the book is an ordinary file on your device. Open it from the file browser, not from the OPDS catalog, the next time you want to read it.
Use OPDS remotely
An OPDS catalog works over your local network or over the internet. On your local network, use the server’s local address. For access from outside your home, use the HTTPS address for your server, with authentication turned on.
Do not expose an unauthenticated OPDS catalog to the internet. An OPDS feed lists your library and gives clients direct access to book downloads. If your server has no authentication, keep it on your local network only, or put it behind a reverse proxy with authentication or a VPN.
Troubleshooting
The OPDS option is missing
You are probably reading a book. Go back to the file browser first, using the filing cabinet icon, then open the top menu again and look for the search icon and OPDS catalog.
KOReader cannot connect
Test the URL outside KOReader first. Open the same OPDS URL in a browser on a device on the same Wi-Fi network. A working OPDS URL returns XML, not a web page. If the browser cannot reach it either, the address, port, or server is wrong, or the server is not running. For Calibre desktop, remember the content server only runs while Calibre is open and the computer is awake.
The catalog loads but has no books
Check the library server, not KOReader. Confirm the library actually contains books, and confirm that user account can see them. In Calibre-Web, check the user’s permissions. In Komga and Kavita, check that the account has access to that library.
Authentication fails
Retype the username and password and check the case. Use the credentials for the server you are connecting to. For Kavita, use the personal OPDS address and its credentials, not a generic server address. Do not paste a password into the URL itself. Enter it in KOReader’s username and password fields, so special characters in the password do not break the URL.
Browsing works but downloads fail
Browsing and downloading fail independently. A catalog can list a book whose file is missing, unreadable, or in a format with no download link. Check that the book file exists on the server, check that the device has storage space, and try a different format for the same book if one is offered.
The web interface URL does not work as a catalog
A web interface URL without the catalog path is not an OPDS catalog. Add /opds for Calibre and Calibre-Web, or use the full Komga path /opds/v1.2/catalog, or the personal Kavita address. If you paste the web page address into KOReader, the catalog will not load.
Comments
One comment per thread every 30 minutes · edits are unlimited.