mirrors/calibre-web
1
0
Fork 0
mirror of https://github.com/janeczku/calibre-web synced 2024-11-24 18:47:23 +00:00
Code Issues Releases Wiki Activity
Web app for browsing, reading and downloading eBooks stored in a Calibre database.
2,123 Commits 4 Branches 24 Tags 102 MiB
Fluent 31.2%
Python 28.6%
JavaScript 27.8%
HTML 11.7%
CSS 0.7%
94b5ec91cc
Go to file
Ozzieisaacs 94b5ec91cc Title in table translatable 
Edit some elements in table possible
Checkbox state is kept over page change in book table
Fix missing div in layout
2020-06-11 08:48:23 +02:00
.github/ISSUE_TEMPLATE Add question for logfile to Issue Template 2020-04-04 18:28:43 +02:00
cps Title in table translatable 2020-06-11 08:48:23 +02:00
test Preparation for release 2020-06-02 22:12:36 +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 Merge with branch develop 2020-02-23 09:08:01 +01:00
babel.cfg Made kindlegen working on windows (including paths containing umlauts) 2016-11-12 10:52:59 +01:00
CONTRIBUTING.md Update CONTRIBUTING.md 2020-05-09 16:15:52 +02:00
cps.py Kobo sync enable/disable working 2020-01-27 20:32:37 +01: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
messages.pot Updated french translation 2020-06-07 06:48:51 +02:00
optional-requirements.txt Added ability to view comicapi version 2020-05-23 16:20:19 +02:00
README.md Fix #1453 (error unrar binary not found) 2020-06-02 20:51:08 +02:00
requirements.txt Fix #1307 2020-04-14 18:28:16 +02:00
setup.cfg Add licence to oauth 2019-07-16 21:08:37 +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 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 czech, dutch, english, finnish, french, german, hungarian, italian, japanese, khmer, polish, russian, simplified chinese, spanish, swedish, turkish, ukrainian
  • OPDS feed for eBook reader apps
  • Filter and search by titles, authors, tags, series and language
  • Create a 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
  • 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)
  • 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

Quick start

  1. Install dependencies by running pip3 install --target vendor -r requirements.txt (python3.x) or pip install --target vendor -r requirements.txt (python2.7).
  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 3.x+, (Python 2.7+)

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 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

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 information, How To's and FAQ please check the Wiki