mirrors/calibre-web
1
0
Fork 0
mirror of https://github.com/janeczku/calibre-web synced 2024-10-31 23:26:20 +00:00
Code Issues Releases Wiki Activity

Typos

Jeroen Kroese 2022-10-19 15:10:01 +02:00
parent cbedda8622
commit 6cc1046ad4
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Kobo-Integration.md

@ -6,14 +6,14 @@ I'd recommend waiting a little bit for this cautionary message do disappear if y
* [#1276](../issues/1276) : Syncing of large libraries may timeout and fail. * [#1276](../issues/1276) : Syncing of large libraries may timeout and fail.
## Setup ## Setup
As a prerequiste you need to install the dependencies listed in optional-requirements.txt under the Kobo integration section. As a prerequisite you need to install the dependencies listed in optional-requirements.txt under the Kobo integration section.
A simple way to do this is to move them to a `kobo-requirements.txt` file, then run the following for a pip install A simple way to do this is to move them to a `kobo-requirements.txt` file, then run the following for a pip install
`./venv/bin/python3 -m pip install -r kobo-requirements.txt` `./venv/bin/python3 -m pip install -r kobo-requirements.txt`
Kobo integration must first be enabled in Calibre-Web by toggling ON the **Enable Kobo sync** checkbox in the **Basic configuration >> Feature Configuration** page. 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 X in this example (the external port). This necessary due to a bug in HTTP-requests the Kobo reader creates, and can't be avoided. If you are accessing your Calibre-Web instance from your Kobo via some sort of port-forwarding mechanism (e.g. your router maps port X to machine Y on port Z), please change the **External Port** setting to port X 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: 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:
@ -56,7 +56,7 @@ If you're having trouble with Kobo sync, there are a few things you can do to he
1. enable debug logs on the Kobo itself 1. enable debug logs on the Kobo itself
- search for `devmodeon` on the kobo - search for `devmodeon` on the kobo
- go to settings -> device information -> on page 2, developer options - go to settings -> device information -> on page 2, developer options
- here you can enable logs for specifig settings - here you can enable logs for specific settings
2. enable debug logs in calibre 2. enable debug logs in calibre
- go to the calibre web admin panel - go to the calibre web admin panel
@ -77,9 +77,9 @@ If you're having trouble with Kobo sync, there are a few things you can do to he
If you have trouble downloading books, please check the output of the kobo sync by entering the following address in your browser: If you have trouble downloading books, please check the output of the kobo sync by entering the following address in your browser:
[server-ip and port]/kobo/[kobo_token]/v1/library/sync [server-ip and port]/kobo/[kobo_token]/v1/library/sync
You shuld get some stuctured text output where you can check the metadata of the books and also the download links generated. You should get some structured text output where you can check the metadata of the books and also the download links generated.
In the Calibre-Web log the output should be something like the fowllowinng: In the Calibre-Web log the output should be something like the following:
[2022-03-24 18:25:57,201] INFO {cps.kobo:140} Kobo library sync request received. [2022-03-24 18:25:57,201] INFO {cps.kobo:140} Kobo library sync request received.
[2022-03-24 18:25:57,201] DEBUG {cps.kobo:141} SyncToken: 0001-01-01 00:00:00,0001-01-01 00:00:00,0001-01-01 00:00:00,0001-01-01 00:00:00,0001-01-01 00:00:00, [2022-03-24 18:25:57,201] DEBUG {cps.kobo:141} SyncToken: 0001-01-01 00:00:00,0001-01-01 00:00:00,0001-01-01 00:00:00,0001-01-01 00:00:00,0001-01-01 00:00:00,
[2022-03-24 18:25:57,201] DEBUG {cps.kobo:143} Kobo: Received unproxied request, changed request port to external server port [2022-03-24 18:25:57,201] DEBUG {cps.kobo:143} Kobo: Received unproxied request, changed request port to external server port
@ -89,6 +89,6 @@ In the Calibre-Web log the output should be something like the fowllowinng:
It's also a good idea to activate the access log in your Calibre-Web instance to check how far the sync process is getting until the error occurs. It's also a good idea to activate the access log in your Calibre-Web instance to check how far the sync process is getting until the error occurs.
## Additonal hints ## Additional hints
The HTTP header using the kobo sync is quite large. With some reverse proxys in between the header can be to large to sync. In this case please increase the allowed max. header size in your proxy config. The HTTP header using the kobo sync is quite large. With some reverse proxys in between the header can be too large to sync. In this case please increase the allowed max. header size in your proxy config.