Added some answers

Ozzieisaacs 2019-02-09 13:42:57 +01:00
parent 933031cdbc
commit 90230e3415
1 changed files with 63 additions and 16 deletions

79
FAQ.md

@ -1,6 +1,65 @@
Installations problems
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.
What do I do if I loose 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.
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.
Which OPDS-Readers work with Calibre-Web?
I have succesfully 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)\
- Kybook 1/2/3 on iOS\
- Megareader on iOS (download seems not to work)
- moon+ on Android
- ebookdroid on Android
I'm not using all the reader regulary, so issues might apear 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.
Why don't you support Calibre's virtual Libs?
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?
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)
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 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 accessable 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 filecontents 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 broser (if not prevented anyhow) 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.
Cover pictures are not exctracted 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.
Imagemagick recently changed their security policy, they now deny per default pdf operations, so covers can't 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" />`
Afterwards covers should be extracted without error from uploaded pdf files.
Lost Admin password
Invalid SSL configuration
@ -8,27 +67,15 @@ Mass add books
Arrange and fill Shelfs
Backup Settings
Link Read Status to calibre custom column
Working OPDS-Reader
Download File / Cover not found problems
Epubs not working in reader
Virtual Libs
How to handle Multiple calibre-libs
Login Kobo
Non ASCII Filename
Concurrent access (calibre and calibre-web)
Malicious code in epub reader
Registering
Concurrent access (calibre and calibre-web)