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
128 Commits 3 Branches 23 Tags 259 MiB
Fluent 31.3%
Python 28.5%
JavaScript 27.9%
HTML 11.6%
CSS 0.7%
9aac40bfc4
Go to file
OzzieIsaacs 9aac40bfc4 Fix #20 
Series and custom composite coloums are also excluded in the view
2016-08-03 13:14:24 +02:00
cps Fix #20 2016-08-03 13:14:24 +02:00
vendor Move vendored libraries to vendor directory 2016-04-27 17:47:31 +02:00
.gitignore Add gitignore, config.ini.example 2016-04-21 23:13:41 +02:00
config.ini.example Add ANON_BROWSE configuration option 2016-04-29 22:36:36 +02:00
cps.py Add shebang 2016-07-14 01:52:06 +02:00
LICENSE Add GPL v3 License 2016-04-27 17:29:57 +02:00
readme.md Add ANON_BROWSE configuration option 2016-04-29 22:36:36 +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.

screenshot

##Features

  • Bootstrap 3 HTML5 interface
  • User management
  • Admin interface
  • 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
  • Support for converting eBooks from EPUB to Kindle format (mobi/azw)
  • 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
  • Upload new books in PDF format
  • Support for Calibre custom columns
  • Fine grained per-user permissions

Quick start

  1. Rename config.ini.example to config.ini and set DB_ROOT to the path of the folder where your Calibre library (metadata.db) lives
  2. Execute the command: python cps.py
  3. Point your browser to http://localhost:8083 or http://localhost:8083/feed for the OPDS catalog

Default admin login:
Username: admin
Password: admin123

Runtime Configuration Options

PUBLIC_REG
Set to 1 to enable public user registration.
ANON_BROWSE
Set to 1 to allow not logged in users to browse the catalog.
UPLOADING
Set to 1 to enable PDF uploading. This requires the imagemagick library to be installed.

Requirements

Python 2.7+

Optionally, to enable on-the-fly conversion from EPUB to MOBI when using the send-to-kindle feature:

Download Amazon's KindleGen tool for your platform and place the binary named as kindlegen in the vendor folder.

Docker image

Calibre Web can be run as Docker container. The latest image is available on Docker Hub.