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

Update FAQ

Ozzie Isaacs 2019-02-09 13:44:59 +01:00
parent 90230e3415
commit 6c5619d1f1
1 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
FAQ.md

@ -1,20 +1,22 @@
What to do with problems during installation with error message Import-Error?
### 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?
### 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?
### 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?
### 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\
@ -27,30 +29,32 @@ I have succesfully tested the following OPDS-Reader:
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
### 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?
### 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?
### 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?
### 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.
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.
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:
### 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.
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: