|
|
||
|---|---|---|
| cps | ||
| test | ||
| .editorconfig | ||
| .eslintrc | ||
| .gitattributes | ||
| .gitignore | ||
| babel.cfg | ||
| cps.py | ||
| LICENSE | ||
| messages.pot | ||
| optional-requirements.txt | ||
| readme.md | ||
| requirements.txt | ||
About
Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.
This software is a fork of library and licensed under the GPL v3 License.
Features
- Bootstrap 3 HTML5 interface
- full graphical setup
- User management with fine grained per-user permissions
- Admin interface
- User Interface in dutch, english, french, german, hungarian, italian, japanese, khmer, polish, russian, simplified chinese, spanish, swedish, ukrainian
- OPDS feed for eBook reader apps
- Filter and search by titles, authors, tags, series and language
- Create custom book collection (shelves)
- Support for editing eBook metadata and deleting eBooks from Calibre library
- Support for converting eBooks through Calibre binaries
- Restrict eBook download to logged-in users
- Support for public user registration
- Send eBooks to Kindle devices with the click of a button
- Support for reading eBooks directly in the browser (.txt, .epub, .pdf, .cbr, .cbt, .cbz)
- Upload new books in many formats
- Support for Calibre custom columns
- Ability to hide content based on categories for certain users
- Self update capability
- "Magic Link" login to make it easy to log on eReaders
Quick start
- Install dependencies by running
pip install --target vendor -r requirements.txt. - Execute the command:
python cps.py(ornohup python cps.py- recommended if you want to exit the terminal window) - Point your browser to
http://localhost:8083orhttp://localhost:8083/opdsfor the OPDS catalog - Set
Location of Calibre databaseto the path of the folder where your Calibre library (metadata.db) lives, push "submit" button
Optionally a Google Drive can be used to host the calibre library -> Using Google Drive integration - Go to Login page
Default admin login:
Username: admin
Password: admin123
Issues with Ubuntu:
Please note that running the above install command can fail on some versions of Ubuntu, saying "can't combine user with prefix". This is a known bug and can be remedied by using the command pip install --system --target vendor -r requirements.txt instead.
Requirements
Python 2.7+, python 3.x+
Optionally, to enable on-the-fly conversion from one ebook format to another when using the send-to-kindle feature, or during editing of ebooks metadata:
Download and install the Calibre desktop program for your platform and enter the folder including programm name (normally /opt/calibre/ebook-convert, or C:\Program Files\calibre\ebook-convert.exe) in the field "calibre's converter tool" on the setup page.
*** DEPRECATED *** Support will be removed in future releases
Download Amazon's KindleGen tool for your platform and place the binary named as kindlegen in the vendor folder.
Docker images
Pre-built Docker images based on Alpine Linux are available in these Docker Hub repositories:
x64
- technosoft2000 at technosoft2000/calibre-web. If you want the option to convert/download ebooks in multiple formats, use this image as it includes Calibre's ebook-convert binary. The "path to convertertool" should be set to /opt/calibre/ebook-convert.
- linuxserver.io at linuxserver/calibre-web. Cannot convert between ebook formats.
armhf
- linuxserver.io at lsioarmhf/calibre-web
aarch64
- linuxserver.io at lsioarmhf/calibre-web-aarch64
Wiki
For further informations, How To's and FAQ please check the
