2017-03-19 16:22:21 +00:00
# About
2015-10-12 01:37:10 +00:00
2018-08-24 13:48:09 +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
2019-02-03 15:38:27 +00:00
![Main screen ](../../wiki/images/main_screen.png )
2015-10-12 01:42:36 +00:00
2017-01-07 13:40:44 +00:00
## Features
2015-10-12 01:37:10 +00:00
- Bootstrap 3 HTML5 interface
2017-01-28 19:29:04 +00:00
- full graphical setup
2017-09-17 10:36:32 +00:00
- User management with fine grained per-user permissions
2015-10-12 01:37:10 +00:00
- Admin interface
2019-02-03 15:38:27 +00:00
- User Interface in dutch, english, french, german, hungarian, italian, japanese, khmer, polish, russian, simplified chinese, spanish, swedish, ukrainian
2016-12-28 14:51:58 +00:00
- OPDS feed for eBook reader apps
2015-10-12 01:37:10 +00:00
- Filter and search by titles, authors, tags, series and language
- Create custom book collection (shelves)
2017-04-15 19:00:41 +00:00
- Support for editing eBook metadata and deleting eBooks from Calibre library
2019-02-03 15:38:27 +00:00
- Support for converting eBooks through Calibre binaries
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
2017-09-17 10:36:32 +00:00
- Support for reading eBooks directly in the browser (.txt, .epub, .pdf, .cbr, .cbt, .cbz)
2019-02-03 15:38:27 +00:00
- Upload new books in many formats
2016-04-27 15:37:19 +00:00
- Support for Calibre custom columns
2017-09-17 10:36:32 +00:00
- Ability to hide content based on categories for certain users
2017-02-03 09:51:58 +00:00
- Self update capability
2017-07-08 01:18:03 +00:00
- "Magic Link" login to make it easy to log on eReaders
2015-10-12 01:42:36 +00:00
## Quick start
2018-10-03 12:32:49 +00:00
1. Install dependencies by running `pip install --target vendor -r requirements.txt` .
2017-03-07 18:46:23 +00:00
2. Execute the command: `python cps.py` (or `nohup python cps.py` - recommended if you want to exit the terminal window)
2017-03-07 22:03:10 +00:00
3. Point your browser to `http://localhost:8083` or `http://localhost:8083/opds` for the OPDS catalog
2017-03-07 18:46:23 +00:00
4. Set `Location of Calibre database` to the path of the folder where your Calibre library (metadata.db) lives, push "submit" button
2017-07-08 12:00:34 +00:00
optionally a google drive can be used to host the calibre library (-> Using Google Drive integration)
2017-03-07 18:46:23 +00:00
5. Go to Login page
2015-10-12 01:37:10 +00:00
2017-01-07 13:40:44 +00:00
**Default admin login:**
*Username:* admin
2015-10-12 01:42:36 +00:00
*Password:* admin123
2018-10-03 12:32:49 +00:00
**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 ](https://github.com/pypa/pip/issues/3826 ) and can be remedied by using the command `pip install --system --target vendor -r requirements.txt` instead.
2015-10-12 01:42:36 +00:00
## Requirements
2019-02-03 15:38:27 +00:00
Python 2.7+, python 3.x+
2015-10-12 02:37:39 +00:00
2017-01-07 13:40:44 +00:00
Optionally, to enable on-the-fly conversion from EPUB to MOBI when using the send-to-kindle feature:
[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
2018-07-03 20:57:24 +00:00
## Docker images
2016-04-27 15:29:57 +00:00
2018-07-03 20:57:24 +00:00
Pre-built Docker images based on Alpine Linux are available in these Docker Hub repositories:
**x64**
2019-01-05 15:00:49 +00:00
+ **technosoft2000** at [technosoft2000/calibre-web ](https://hub.docker.com/r/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 ](https://hub.docker.com/r/linuxserver/calibre-web/ ). Cannot convert between ebook formats.
2018-07-03 20:57:24 +00:00
**armhf**
+ **linuxserver.io** at [lsioarmhf/calibre-web ](https://hub.docker.com/r/lsioarmhf/calibre-web/ )
**aarch64**
+ **linuxserver.io** at [lsioarmhf/calibre-web-aarch64 ](https://hub.docker.com/r/lsioarmhf/calibre-web-aarch64 )
2016-10-08 05:58:47 +00:00
2019-02-03 15:38:27 +00:00
# Wiki
For further informations, How To's and FAQ please check the ![Wiki ](../../wiki )