Archives/calibre-web
2
0
Fork 0
mirror of https://github.com/janeczku/calibre-web synced 2024-10-31 15:20:28 +00:00
Code Issues Releases Wiki Activity
1,384 Commits 3 Branches 23 Tags 259 MiB
Fluent 31.3%
Python 28.5%
JavaScript 27.9%
HTML 11.6%
CSS 0.7%
b89ab9ff10
Go to file
Daniel Pavel b89ab9ff10 logging clean-up 
- moved most constants to separate file
- sorted and cleaned-up imports
- moved logging setup to separate file
2019-06-06 18:10:22 +03:00
cps logging clean-up 2019-06-06 18:10:22 +03:00
test Update Teststatus 2019-05-12 19:44:52 +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 New updater with default setting -> only stable releases #653 2019-01-20 17:46:26 +01:00
.gitignore Update setup 2019-06-01 09:51:20 +02:00
babel.cfg Made kindlegen working on windows (including paths containing umlauts) 2016-11-12 10:52:59 +01:00
cps.py logging clean-up 2019-06-06 18:10:22 +03:00
LICENSE Add GPL v3 License 2016-04-27 17:29:57 +02:00
MANIFEST.in Working for pip and "normal" start for python3 and python2 2019-06-02 09:33:45 +02:00
messages.pot Update translationfiles 2019-05-31 15:48:19 +02:00
optional-requirements.txt Merge branch 'master' into Develop 2019-05-31 11:17:47 +02:00
README.md Working for pip and "normal" start for python3 and python2 2019-06-02 09:33:45 +02:00
requirements.txt updated comicapi version to fix installation error 2019-04-09 15:22:03 -04:00
setup.cfg Revert setup.cfg file 2019-06-02 09:35:42 +02:00
setup.py Working for pip and "normal" start for python3 and python2 2019-06-02 09:33:45 +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:\prgogram files\calibre\ebook-convert.exe) in the field "calibre's converter tool" on the setup page.

*** DEPRECATED *** Support will be removed in future releases Optionally, to enable on-the-fly conversion from EPUB to MOBI when using the send-to-kindle feature:

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

aarch64

Wiki

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