-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Kobo Integration
This feature is fairly new in Calibre-Web and has had limited testing: You will likely run into new issues if you try this out. I'd recommend waiting a little bit for this cautionary message do disappear if you aren't comfortable with some rough edges.
- #1219 : Fixed Layout ePubs aren't imported correctly over the Sync protocol.
- #1276 : Syncing of large libraries may timeout and fail.
As prerequiste you need to install the dependencies listed in optional-requirements.txt in the Kobo integration section. Kobo integration must first be enabled in Calibre-Web by toggling ON the Enable Kobo sync checkbox in the Basic configuration >> Feature Configuration page. If you are accessing your Calibre-Web instance from your Kobo via some sort of portforwarding mechanism (e.g. your router maps port X to machine Y on port Z), please change the External Port setting to port Y in this example (the external port). This necessary due to a bug in HTTP-requests the Kobo reader creates and can't be avoided.
The Kobo eReader.conf file found under the .kobo/Kobo directory on Kobo devices is used to configure which URL the device uses for syncing books. By default, the config file contains the following row:
api_endpoint=https://storeapi.kobo.com
Users can generate a URL to sync with Calibre-Web instead by clicking the Create/View button under their Calibre-Web profile page.
If you want to maintain access to the official Kobo store on the device, you can set the Proxy unknown requests to Kobo Store checkbox. When syncing, we will try to sync against both the official Kobo Store as well as Calibre-Web's library.
The Kobo device sends out a unique and irrevocable (even across password reset) {device_id; user_id} pair during the Sync protocol. If CalibreWeb is exposed over the internet without SSL, then this id pair could theoretically be stolen (if anyone was bothered to...). As far as I can tell, a malicious individual wouldn't be able to make account changes or purchases, but would be able to download the list of purchased or borrowed books, collections, reading stats, etc.
You can install a self-signed certificate on the device by copying a DER encoded certificate with a .cer file extension to the .kobo/certificates directory on the Kobo device. For example, to convert an existing certificate to the right format:
openssl x509 -in self-signed-cert.crt -outform DER -out /media/KOBOeReader/.kobo/certificates/calibre_web.cer
Adding books to Calibre/Calibre-Web will cause them to appear on the device the next time it Syncs with Calibre-Web.
Deleting a book from Calibre/Calibre-Web will not cause it to be removed from the device on the next Sync. In order to trigger deletions from their devices, users must archive books and then sync their devices.
Book progress and reading statistics are synced with and stored in Calibre-Web. At the moment, Calibre-Web will only display whether books have been completed (Read) or not (Unread).