2015-10-12 01:37:10 +00:00
##About
2016-04-27 15:37:19 +00:00
Calibre Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing [Calibre ](https://calibre-ebook.com ) database.
2015-10-12 01:37:10 +00:00
2016-04-27 15:29:57 +00:00
*This software is a fork of [library ](https://github.com/mutschler/calibreserver ) and licensed under the GPL v3 License.*
2016-03-26 18:48:45 +00:00
2015-10-12 01:42:36 +00:00
2015-10-12 01:37:10 +00:00
##Features
- Bootstrap 3 HTML5 interface
2015-10-12 01:42:36 +00:00
- User management
2015-10-12 01:37:10 +00:00
- 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
2015-10-12 01:42:36 +00:00
- Support for converting eBooks from EPUB to Kindle format (mobi/azw)
2015-10-12 01:37:10 +00:00
- Restrict eBook download to logged-in users
2016-03-26 18:48:45 +00:00
- Support for public user registration
2015-10-12 01:42:36 +00:00
- Send eBooks to Kindle devices with the click of a button
- Support for reading eBooks directly in the browser
2016-04-12 21:24:23 +00:00
- Upload new books in PDF format
2016-04-27 15:37:19 +00:00
- Support for Calibre custom columns
2016-04-29 20:30:33 +00:00
- Fine grained per-user permissions
2015-10-12 01:42:36 +00:00
## Quick start
2016-04-29 20:30:33 +00:00
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
2015-10-12 01:37:10 +00:00
**Default admin login:**
*Username:* admin
2015-10-12 01:42:36 +00:00
*Password:* admin123
2016-04-29 20:30:33 +00:00
## 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.
2015-10-12 01:42:36 +00:00
## Requirements
2015-10-12 02:37:39 +00:00
Python 2.7+
Optionally, to enable on-the-fly conversion from EPUB to MOBI when using the send-to-kindle feature:
2016-04-27 15:45:04 +00:00
[Download ](http://www.amazon.com/gp/feature.html?docId=1000765211 ) Amazon's KindleGen tool for your platform and place the binary named as `kindlegen` in the `vendor` folder.
2016-04-27 15:29:57 +00:00
## Docker image
Calibre Web can be run as Docker container. The latest image is available on [Docker Hub ](https://registry.hub.docker.com/u/janeczku/calibre-web/ ).
