mirrors/calibre-web
1
0
Fork 0
mirror of https://github.com/janeczku/calibre-web synced 2024-12-18 14:10:30 +00:00
Code Issues Releases Wiki Activity
Web app for browsing, reading and downloading eBooks stored in a Calibre database.
3,679 Commits 4 Branches 24 Tags 103 MiB
Fluent 31.2%
Python 28.6%
JavaScript 27.9%
HTML 11.6%
CSS 0.7%
1ad8dc102a
Go to file
Petipopotam 1ad8dc102a
CSP invalid syntax 
CSP had some "cosmetic" errors

Before : default-src 'self'  'unsafe-inline' 'unsafe-eval'; font-src 'self' data:; img-src 'self' data: style-src-elem 'self' blob: 'unsafe-inline';object-src: 'none';
After :    default-src 'self'  'unsafe-inline' 'unsafe-eval'; font-src 'self' data:;  img-src 'self' data:; style-src-elem 'self' blob: 'unsafe-inline'; object-src 'none';
2023-01-24 10:51:48 +01: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 CSP invalid syntax 2023-01-24 10:51:48 +01:00
test Update Teststatus 2023-01-23 12:55:18 +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 Merge branch 'Develop' 2019-07-13 20:54:21 +02:00
.gitignore Resolve merge conflicts 2021-09-16 22:58:54 -05:00
.key Update pdf Reader 2022-09-05 19:42:02 +02:00
babel.cfg Update path to kobo config file 2022-12-25 10:22:58 +01:00
CONTRIBUTING.md Change landing page for issues, to reduce number of empty issues 2022-08-27 10:20:53 +02: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
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 Update German translation 2023-01-22 13:53:10 +01:00
optional-requirements.txt Fix #2495, Fix #2494 (Convert for not existent file no longer fails) 2022-07-31 11:28:11 +02:00
README.md Added additional installation hints based on #2660 2023-01-22 07:52:17 +01:00
requirements.txt Handle version 3.0 of flask-babel 2023-01-22 12:09:19 +01:00
SECURITY.md Update SECURITY.md 2022-05-15 19:00:16 -07:00
setup.cfg Update Teststatus 2023-01-23 12:55:18 +01: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.

GitHub License GitHub commit activity GitHub all releases PyPI PyPI - Downloads Discord

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 brazilian, czech, dutch, english, finnish, french, galician, german, greek, hungarian, indonesian, italian, japanese, khmer, korean, norwegian, polish, russian, simplified and traditional chinese, spanish, swedish, turkish, ukrainian, vietnamese
  • 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)

  1. To avoid problems with already installed python dependencies, it's recommended to create a virtual environment for Calibre-Web
  2. Install Calibre-Web via pip with the command pip install calibreweb (Depending on your OS and or distro the command could also be pip3).
  3. Optional features can also be installed via pip, please refer to this page for details
  4. 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)

Default admin login:

Username: admin
Password: admin123

Requirements

python 3.5+

Download Imagemagick to extract covers from epubs. On Windows the additional installation of ghostscript might be necessary to extract covers from pdf files. On Linux Imagemagick and Ghostscript can often be installed using the system package manager.

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