luisgulo/calibre-web
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Web app for browsing, reading and downloading eBooks stored in a Calibre database
1302 commits 3 branches 21 tags 105 MiB
JavaScript 42.5%
Python 39.7%
HTML 16.7%
CSS 1.1%
Find a file
Ozzieisaacs b1cb7123a3 Fix for #959
2019-07-11 20:37:03 +02:00
cps Fix for #959 2019-07-11 20:37:03 +02:00
test Update Test results 2019-01-27 08:32:26 +01: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 New updater with default setting -> only stable releases #653 2019-01-20 17:46:26 +01:00
.gitignore updated comicapi requirement—libunrar no longer necessary (CBR parsing support was always disabled anyway) 2019-04-03 15:36:05 -04:00
babel.cfg Made kindlegen working on windows (including paths containing umlauts) 2016-11-12 10:52:59 +01:00
cps.py Refactored WSGIServer handling 2018-07-09 18:47:36 +02:00
LICENSE Add GPL v3 License 2016-04-27 17:29:57 +02:00
MANIFEST.in Add initial setuptools integration 2019-05-31 11:54:05 +02:00
messages.pot Changed version 2019-05-30 09:07:52 +02:00
optional-requirements.txt Fix #900 2019-05-01 17:47:54 +02:00
readme.md Wiki link fixed 2019-06-20 10:38:32 +02:00
requirements.txt Fix #900 2019-05-01 17:47:54 +02:00
setup.cfg Merge remote-tracking branch 'setup/feature/setuptools-integration' 2019-05-31 16:24:13 +02:00
setup.py Merge remote-tracking branch 'setup/feature/setuptools-integration' 2019-05-31 16:24:13 +02:00

readme.md

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.

Main screen

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

  1. Install dependencies by running pip install --target vendor -r requirements.txt.
  2. Execute the command: python cps.py (or nohup python cps.py - recommended if you want to exit the terminal window)
  3. Point your browser to http://localhost:8083 or http://localhost:8083/opds for the OPDS catalog
  4. 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
  5. 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 are available in these Docker Hub repositories:

Technosoft2000 - x64

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

Wiki

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