Web app for browsing, reading and downloading eBooks stored in a Calibre database.

Go to file

Ozzie Isaacs b5d5660d04 Update version		2022-07-31 16:14:03 +02:00
.github	Fix for #2294 (cover files in epubs with property as property in manifest are now found)	2022-02-06 16:22:28 +01:00
cps	Update version	2022-07-31 16:14:03 +02:00
test	Update teststatus	2022-07-30 18:13:09 +02:00
.editorconfig	Add eslint file	2017-08-12 22:44:39 -07:00
.eslintrc	Update to ES5 standards	2017-08-12 22:46:27 -07:00
.gitattributes	Merge branch 'Develop'	2019-07-13 20:54:21 +02:00
.gitignore	Resolve merge conflicts	2021-09-16 22:58:54 -05:00
CONTRIBUTING.md	Fixes from testrun	2021-07-30 09:25:19 +02:00
LICENSE	Add GPL v3 License	2016-04-27 17:29:57 +02:00
MANIFEST.in	Merge branch 'Develop'	2019-07-13 20:54:21 +02:00
README.md	Merge remote-tracking branch 'links/patch-1'	2022-05-21 22:25:49 +02:00
SECURITY.md	Update SECURITY.md	2022-05-15 19:00:16 -07:00
babel.cfg	Made kindlegen working on windows (including paths containing umlauts)	2016-11-12 10:52:59 +01:00
cps.py	Bugfix start as program	2022-04-29 18:26:09 +02:00
exclude.txt	Added option to enable reconnect	2022-01-29 14:47:45 +01:00
messages.pot	Updated brazilian translation (fix #2496 )	2022-07-31 11:30:56 +02:00
optional-requirements.txt	Fix #2495 , Fix #2494 (Convert for not existent file no longer fails)	2022-07-31 11:28:11 +02:00
requirements.txt	Update flask-login requirement	2022-05-31 19:22:57 +02:00
setup.cfg	Update teststatus	2022-07-30 18:13:09 +02:00
setup.py	Deactivate ldap	2019-07-14 18:37:44 +02:00

README.md

About

Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using a valid 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 brazilian, czech, dutch, english, finnish, french, german, greek, hungarian, italian, japanese, khmer, korean, polish, russian, simplified and traditional chinese, spanish, swedish, turkish, ukrainian
OPDS feed for eBook reader apps
Filter and search by titles, authors, tags, series, book format and language
Create a custom book collection (shelves)
Support for editing eBook metadata and deleting eBooks from Calibre library
Support for downloading eBook metadata from various sources, sources can be extended via external plugins
Support for converting eBooks through Calibre binaries
Restrict eBook download to logged-in users
Support for public user registration
Send eBooks to E-Readers with the click of a button
Sync your Kobo devices through Calibre-Web with your Calibre library
Support for reading eBooks directly in the browser (.txt, .epub, .pdf, .cbr, .cbt, .cbz, .djvu)
Upload new books in many formats, including audio formats (.mp3, .m4a, .m4b)
Support for Calibre Custom Columns
Ability to hide content based on categories and Custom Column content per user
Self-update capability
"Magic Link" login to make it easy to log on eReaders
Login via LDAP, google/github oauth and via proxy authentication

Installation

Installation via pip (recommended)

To avoid problems with already installed python dependencies, it's recommended to create a virtual environment for Calibre-Web
Install Calibre-Web via pip with the command pip install calibreweb (Depending on your OS and or distro the command could also be pip3).
Optional features can also be installed via pip, please refer to this page for details
Calibre-Web can be started afterwards by typing cps

In the Wiki there are also examples for: a manual installation, installation on Linux Mint, installation on a Cloud Provider.

Quick start

Point your browser to http://localhost:8083 or http://localhost:8083/opds for the OPDS catalog
Login with default admin login
Set Location of Calibre database to 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
Afterwards you can configure your Calibre-Web instance (Basic Configuration and UI Configuration on admin page)

Username: admin
Password: admin123

Requirements

python 3.5+

Optionally, to enable on-the-fly conversion from one ebook format to another when using the send-to-ereader feature, or during editing of ebooks metadata:

Download and install the Calibre desktop program for your platform and enter the folder including program 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.

Download Kepubify tool for your platform and place the binary starting with kepubify in Linux: /opt/kepubify Windows: C:\Program Files\kepubify.

Docker Images

A pre-built Docker image is available in these Docker Hub repository (maintained by the LinuxServer team):

LinuxServer - x64, armhf, aarch64

Docker Hub - https://hub.docker.com/r/linuxserver/calibre-web
Github - https://github.com/linuxserver/docker-calibre-web
Github - (Optional Calibre layer) - https://github.com/linuxserver/docker-calibre-web/tree/calibre

This image has the option to pull in an extra docker manifest layer to include the Calibre ebook-convert binary. Just include the environmental variable DOCKER_MODS=linuxserver/calibre-web:calibre in your docker run/docker compose file. (x64 only)

If you do not need this functionality then this can be omitted, keeping the image as lightweight as possible.

Both the Calibre-Web and Calibre-Mod images are rebuilt automatically on new releases of Calibre-Web and Calibre respectively, and on updates to any included base image packages on a weekly basis if required.
- The "path to convertertool" should be set to /usr/bin/ebook-convert
- The "path to unrar" should be set to /usr/bin/unrar

Contact

Just reach us out on Discord

For further information, How To's and FAQ please check the Wiki

Contributing to Calibre-Web

Please have a look at our Contributing Guidelines