mirrors
/
calibre-web
mirror of https://github.com/janeczku/calibre-web
1
0
Fork 0
Code Issues Releases Wiki Activity

The FAQ just saved my butt so I thought I'd do a light edit and correct typos and grammar errors as a thank-you.

BTK 2021-09-26 11:36:07 -06:00
parent 5b39f09d47
commit ea77e6f183
1 changed files with 34 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
FAQ.md

@ -1,23 +1,23 @@
### What to do with problems during installation with error message "Import-Error"?
Python is a very modular programming language, special funcionality can be included to the program by "importing moduls". If one of this modules isn't found you get the error message 'ImportError: No module named xxxx'. This shouldn't be happen, you normally can solve this by installing the missing module with `pip[3] --target vendor install [module-name]`. Pip3 is normally used if you are using python 3.x if you are still using python 2.x normally pip does the job.
Python is a very modular programming language, special functionality can be included to the program by "importing modules". If one of this modules isn't found you get the error message 'ImportError: No module named xxxx'. This shouldn't be happen, you normally can solve this by installing the missing module with `pip[3] --target vendor install [module-name]`. Pip3 is normally used if you are using python 3.x — if you are still using python 2.x normally pip does the job.
### What do I do if I lose my "Admin" password?
If there are more than on admin on your instance any other admin can generate a new password for your account.
If the only admin forgot his password: You are in trouble. Currently no password reset function is implemented
The only option would be editing the password in the app.db with a sqlite Databaseeditor, or starting from the beginning.
If there is more than on admin on your instance, any other admin can generate a new password for your account.
If the only admin forgot his password: You are in trouble. Currently no password reset function is implemented.
The only option would be editing the password in the app.db with a sqlite Database editor, or starting from the beginning.
### How to Backup Calibre-Web Settings?
All settings of Calibre-Web are stored in the app.db in the root folder of the project.If you are using Google Drive as ebook storage than you also need to backup the gdrive.db, settings.yaml and gdrive_credentials files.
All settings of Calibre-web are stored in the app.db in the root folder of the project. If you are using Google Drive as ebook storage than you also need to backup the gdrive.db, settings.yaml and gdrive_credentials files.
### Which OPDS-Readers work with Calibre-Web?
I have succesfully tested the following OPDS-Reader:
I have successfully tested the following OPDS-Reader:
- Chunky on iOS (mainly for comics)
- Marvin and Marvin3 on iOS
- Calibre-Companion on Android (Book downloads viewing book details are also supported with this reader even it's not using the standard opds features). Download is only working with anonymous browsing enabled
@ -27,16 +27,15 @@ I have succesfully tested the following OPDS-Reader:
- ebookdroid on Android (Download is only working with anonymous browsing enabled with v2.6.3)
- Coolreader on Android (Cover pictures are not supported, tested with v3.2.29-1)
- FBReader on Android (Cover pictures are only displayed with anonymous browsing enabled, tested with v3.0.8)
- Koreader on Kobo (https://github.com/koreader/koreader) has a compatible OPDS browser.
I'm not using all the reader regular, so issues might appear from time to time. If it's reported I'll try to fix it.
I'm not using all the readers regularly, so issues might appear from time to time. If it's reported I'll try to fix it.
### Download File / Cover not found problems
Why is my epub xxx.epub not working in the reader?
Calibre-web uses the futurepress-javascript-epub-reader library to display epubs. Unfortunaly some ebooks aren't fully specification compliant, and the epub-reader library has it's own limitations and errors, so from time to time certain ebook aren't displayable by Calibre-web.
Calibre-web uses the futurepress-javascript-epub-reader library to display epubs. Unfortunately some ebooks aren't fully specification compliant, and the epub-reader library has it's own limitations and errors, so from time to time certain ebook aren't displayable by Calibre-web.
### Why don't you support Calibre's virtual Libs?
@ -44,39 +43,39 @@ Calibre-web uses the futurepress-javascript-epub-reader library to display epubs
Virtual libraries are implemented as searches in Calibre's own searching language. Supporting this would mean a complete reimplementation of Calibre's searching functions, which is a bit out of my time and Calibre-web's feature scope.
### What is the maximum file-size which can be uploaded through calibre-web?
### What is the maximum file-size which can be uploaded through Calibre-web?
Calibre-web default server ('tornado') limits the uploaded file size to 200MB, 'Gevent' the server from the optional requirement has no hardcoded limit (or nothing I'm aware of).
Calibre-web's default server ('tornado') limits the uploaded file size to 200MB, 'Gevent' the server from the optional requirement has no hardcoded limit (or nothing I'm aware of).
### My file is smaller then 200MB, but I get a '413 - Request Entity To Large' error message
If you are using some additional systems like a proxy or reverese proxy, they must be configured to support the file size as well. See [https://www.keycdn.com/support/413-request-entity-too-large](https://www.keycdn.com/support/413-request-entity-too-large) for a possible fix.
If you are using some additional systems like a proxy or reverse proxy, they must be configured to support the file size as well. See [https://www.keycdn.com/support/413-request-entity-too-large](https://www.keycdn.com/support/413-request-entity-too-large) for a possible fix.
### Can Calibre-web execute malicious code in an epub?
If you just organize your epubs with calibre-web, the content of the epub is not touched, and nothing gets to excecution.\
If you just organize your epubs with Calibre-web, the content of the epub is not touched, and nothing gets to execution.\
If you use the included epub-reader, it is a different story:\
Calibre-web unpacks the epub (which are normal zip files) to a folder on the server which is accessible by the browser. Then calibre-web sends the reader page to the browser. The browser starts the epub-reader JavaScript file, which itself starts to build up the webpage you see. During that process, the file contents of the epub file is loaded into the browser. The content is just normal html pages, which can include stylesheet files and JavaScript files. So if there is malicious code included the epub, or links to JavaScript code the browser (if not prevented anyhow) will start to interpret it.
Calibre-web unpacks the epub (which are normal zip files) to a folder on the server which is accessible by the browser. Then Calibre-web sends the reader page to the browser. The browser starts the epub-reader JavaScript file, which itself starts to build up the webpage you see. During that process, the file contents of the epub file are loaded into the browser. The content is just normal html pages, which can include stylesheet files and JavaScript files. So if there is malicious code included the epub, or links to JavaScript code, the browser (if not prevented somehow) will start to interpret it.
If you are not sure, you could rename the epub to zip open it and search for js-code and delete it, and afterwards rename t to epub again. Also tools like the [Sigil Epub Editor](https://github.com/Sigil-Ebook/Sigil) could help to dig deeper into the suspicious books.
If you are not sure, you could rename the epub to zip open it and search for js-code and delete it, and afterwards rename it to epub again. Also tools like the [Sigil Epub Editor](https://github.com/Sigil-Ebook/Sigil) could help to dig deeper into the suspicious books.
### What to do if cover pictures are not extracted from PDF files:
Symptom: Calibre-Web logs a message like: `WARNING - PDF extraction forbidden by ImageMagick policy: not authorized '/tmp/calibre_web/xxxxxxxxxxxxxxxxxx' @ error/constitute.c/ReadImage/412` during upload of PDF files.
Symptom: Calibre-web logs a message like: `WARNING - PDF extraction forbidden by ImageMagick policy: not authorized '/tmp/calibre_web/xxxxxxxxxxxxxxxxxx' @ error/constitute.c/ReadImage/412` during upload of PDF files.
ImageMagick recently changed their security policy, they now deny per default PDF operations, so covers can't be extracted anymore, you have to allow it in the policy.xml file of ImageMagick (located in /etc/Imagemagick-6) by changing line:
`<policy domain="coder" rights="none" pattern="PDF" />`
to
`<policy domain="coder" rights="read" pattern="PDF" />`
Calibre-Web has to be restarted after changing the policy.xml file. Covers should be extracted without error from uploaded PDF files.
Calibre-web has to be restarted after changing the policy.xml file. Covers should be extracted without error from uploaded PDF files.
### Mass add books
It's possible to upload several books at once by selecting more than one file. The limitation is the upload size of the calibre-web internal server (several hundred megabyte). Another posibility is via a normal shall script by watching a folder content. Prerequisites for the example below is a installed calibre program. The script has to be called regulary (cron job). The script watches for content in the supervised path, calls calibre to add the files in the folder to the library and deletes the files in the last step from the source folder.
It's possible to upload several books at once by selecting more than one file. The limitation is the upload size of the Calibre-web internal server (several hundred megabyte). Another possibility is via a normal shall script by watching a folder content. Prerequisites for the example below is an installed Calibre program. The script has to be called regularly (cron job). The script watches for content in the supervised path, calls Calibre to add the files in the folder to the library and deletes the files in the last step from the source folder.
```
#!/bin/bash
@ -89,65 +88,65 @@ fi
### Login Kobo
Kobo readers having problems using the internal web browser on non standard ports, means with the calibre-web standard port the magic login link normally doesn't work. As workaround calibre-web could be accessed via reverse proxy, or using the normal login method.
Kobo readers having problems using the internal web browser on non-standard ports means with the Calibre-web standard port the magic login link normally doesn't work. As workaround Calibre-web could be accessed via reverse proxy, or using the normal login method.
### Non ASCII Filenames
Non ASCII Filenames, including author names (containing korean, chinese, ... characters) are changed to a transliterated representation. This is an exact copy of the behavior of calibre.
Non ASCII Filenames, including author names (containing korean, chinese, ... characters) are changed to a transliterated representation. This is an exact copy of the behavior of Calibre.
### Invalid SSL configuration
I case you entered invalid key files for accessing calibre-web through https, the ssl configuration can be overridden using the commandline arguments "-c" and "-k". The file locations can than be corrected in the web-UI.
In case you entered invalid key files for accessing Calibre-web through https, the ssl configuration can be overridden using the commandline arguments "-c" and "-k". The file locations can than be corrected in the web-UI.
### Arrange and fill Shelfs
Shelfs can be filled book by book on the corresponding detail page. Books can be massadded from the result of an advanced search. Third option for adding many books at one time to a shelf is using a script like the [cps-mass-adder script](https://github.com/OzzieIsaacs/cps-shelf-adder). The order of books in a shelf can be rearranged on the shelf edit page via drag 'n drop.
Shelfs can be filled book by book on the corresponding detail page. Books can also be mass added from the result of an advanced search. The third option for adding many books at one time to a shelf is using a script like the [cps-mass-adder script](https://github.com/OzzieIsaacs/cps-shelf-adder). The order of books in a shelf can be rearranged on the shelf edit page via drag 'n drop.
### Send to kindle with guest account
In a one user use case you can use the guest account for sending ebooks to kindle. Please add in this case a kindle-email to the guest account, afterwards the "send to kindle" button appears for the guest user. If more than one user is accessing the guest account this is not working, as you can only have one kindle-email linked to a user.
In a one-user use case you can use the guest account for sending ebooks to kindle. In this case please add a kindle-email to the guest account; afterwards the "send to kindle" button appears for the guest user. If more than one user is accessing the guest account this will not working, as you can only have one kindle-email linked to a user.
### Link Read Status to Calibre Custom Column
In a single user Calibre installation you can use a boolean custom column to keep track of your read and unread books. Calibre-web can do the following. You can link the Calibre status to the read/unread status in Calibre-Web. As mentioned above this only works in a SINGLE USER use-case. If you are having more than one user in Calibre-Web this will cause trouble, because the read/unread status is used for all users, so if one user ticks a book as read, all users will see this book as read. In a multiuser Calibre-Web use case it's absolutly manatory not to use this feature.\
In a single-user Calibre installation you can use a boolean custom column to keep track of your read and unread books. Calibre-web can do the following. You can link the Calibre status to the read/unread status in Calibre-web. As mentioned above this only works in a SINGLE USER use-case. If you have more than one user in Calibre-web this will cause trouble, because the read/unread status is used for all users, so if one user ticks a book as read, all users will see this book as read. In a multiuser Calibre-web use case it's absolutely mandatory not to use this feature.\
How to use the feature?
1. Open Calibre (the Desktop program) and create a boolean custom column name it accordingly (e.g. Read Status)
2. Calibre will ask you for a restart to apply the change. Afterwards please close Calibre
3. For safety reasons it's recommended to restart Calibre-Web
4. Log in to Calibre-Web as admin and go to Admin->UI configuration->View Configuration
3. For safety reasons it's recommended to restart Calibre-web
4. Log in to Calibre-web as admin and go to Admin->UI configuration->View Configuration
5. The field "Link read/unread status to Calibre column" should now offer a selection of all boolean custom columns of the corresponding Calibre library, select the appropriate entry and save
The read/unread status is now identical in Calibre and Calibre-Web
The read/unread status is now identical in Calibre and Calibre-web
### How to handle Multiple Calibre Libs
The recommended way for handling multiple libraries is to start multiple instances of calibre-web. Instead of having several copies of the calibre-web code, command line options can be used for this. First start calibre-web with the normal command:\
The recommended way for handling multiple libraries is to start multiple instances of Calibre-web. Instead of having several copies of the Calibre-web code, command line options can be used for this. First start Calibre-web with the normal command:\
`python3 [path to calibre-web]/cps.py`\
Configure the path to the metadata.db, set the logfile to a new filename (e.g. instance1.log) and change the port to e.g. 8084. Now stop calibre-web rename the newly generated app.db to e.g. instance1.db. Repeat this procedure for every instance you want to run. At the end start all instance with the commandline-parameter -p:
Configure the path to the metadata.db, set the logfile to a new filename (e.g. instance1.log) and change the port to e.g. 8084. Now stop Calibre-web rename the newly generated app.db to e.g. instance1.db. Repeat this procedure for every instance you want to run. At the end start all instance with the commandline-parameter -p:
```
nohup python3 [path to calibre-web]cps.py -p /[path to calibre-web instance1.db]
nohup python3 [path to calibre-web]cps.py -p /[path to calibre-web instance2.db]
...
nohup python3 [path to calibre-web]cps.py -p /[path to calibre-web instanceN.db]
```
The command nohup puts the command to the background, so all instances can be started at once. Another option would be using several terminal windows. The final solution would be creating different service files for the different instances. All instances will be accessable afterwards with different port adresses like:\
127.0.0.1:8084 for instance1, 127.0.0.1:8085 for instance2 and so on. This procedure can also be used for windows with the usual adoptions (command console/batch programm instead of terminal, task planer instead of service script).
The command nohup puts the command to the background, so all instances can be started at once. Another option would be using several terminal windows. The final solution would be creating different service files for the different instances. All instances will be accessible afterwards with different port addresses like:\
127.0.0.1:8084 for instance1, 127.0.0.1:8085 for instance2 and so on. This procedure can also be used for Windows with the usual adoptions (command console/batch program instead of terminal, task planer instead of service script).
### Concurrent access (Calibre and Calibre-Web)
If calibre is started first, it normally blocks access to the metadata.db file and it's not possible to start calibre-web afterwards. If Calibre-Web is started first it's possible to access the metadata.db file via calibre later. If Calibre and Calibre-Web are changing book-metadata at the same time this can lead to unpredictable result.
If Calibre is started first, it normally blocks access to the metadata.db file and it's not possible to start Calibre-web afterwards. If Calibre-web is started first it's possible to access the metadata.db file via Calibre later. If Calibre and Calibre-web are changing book-metadata at the same time this can lead to unpredictable result.
### How to upload Covers in other formats than jpg?
Other coverformats than jpg can be uploaded using the "upload from local drive" function on the edit book page. If "pillow" is installed, other file formats like png can be converted to jpg and used as cover.
Other cover formats than jpg can be uploaded using the "upload from local drive" function on the edit book page. If "pillow" is installed, other file formats like png can be converted to jpg and used as cover.
### How many books are displayed on Random/Discover section
The random books page is generated new upon each call to the page (also valid for the opds feed). The random page has therefore no next page and the number of books displayed there equals to the setting books per page
The random books page is generated new upon each call to the page (also valid for the opds feed). The random page therefore has no next page and the number of books displayed there is equal to the setting books per page
### Which picture formats are supported in the comic reader?
@ -155,4 +154,4 @@ The comic reader supports currently jpg, jpeg, png, gif (but not animated ones)
### Which types of Custom columns are supported?
All types of custom columns are supported except the two "Columns Build from other Columns". From "Long text, like comments..." column only the HTML formatted version is supported.
All types of custom columns are supported except the two "Columns Build from other Columns". From the "Long text, like comments..." column only the HTML formatted version is supported.