calibre-web/readme.md

77 lines
4 KiB
Markdown
Raw Normal View History

2017-03-19 17:22:21 +01:00
# About
2015-10-12 03:37:10 +02: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 03:37:10 +02:00
2016-04-27 17:29:57 +02:00
*This software is a fork of [library](https://github.com/mutschler/calibreserver) and licensed under the GPL v3 License.*
2016-03-26 19:48:45 +01:00
![Main screen](../../wiki/images/main_screen.png)
2015-10-12 03:42:36 +02:00
## Features
2015-10-12 03:37:10 +02:00
- Bootstrap 3 HTML5 interface
- full graphical setup
- User management with fine grained per-user permissions
2015-10-12 03:37:10 +02:00
- 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
2015-10-12 03:37:10 +02:00
- Filter and search by titles, authors, tags, series and language
- Create custom book collection (shelves)
2017-04-15 21:00:41 +02:00
- Support for editing eBook metadata and deleting eBooks from Calibre library
- Support for converting eBooks through Calibre binaries
2015-10-12 03:37:10 +02:00
- Restrict eBook download to logged-in users
2016-03-26 19:48:45 +01:00
- Support for public user registration
2015-10-12 03:42:36 +02:00
- 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
2016-04-27 17:37:19 +02:00
- Support for Calibre custom columns
- Ability to hide content based on categories for certain users
2017-02-03 10:51:58 +01:00
- Self update capability
- "Magic Link" login to make it easy to log on eReaders
2015-10-12 03:42:36 +02:00
## Quick start
2018-10-03 14:32:49 +02:00
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
2017-07-08 14:00:34 +02:00
optionally a google drive can be used to host the calibre library (-> Using Google Drive integration)
5. Go to Login page
2015-10-12 03:37:10 +02:00
2019-02-03 17:29:27 +01:00
**Default admin login:**\
*Username:* admin\
2015-10-12 03:42:36 +02:00
*Password:* admin123
2018-10-03 14:32:49 +02: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 03:42:36 +02:00
## Requirements
Python 2.7+, python 3.x+
2015-10-12 04:37:39 +02:00
2019-02-13 19:55:56 +01:00
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:
2019-02-10 07:56:18 +01:00
[Download and install](https://calibre-ebook.com/download) 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:
2019-02-10 07:56:18 +01:00
[Download Kindlegen](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 17:29:57 +02:00
## Docker images
2016-04-27 17:29:57 +02:00
Pre-built Docker images based on Alpine Linux are available in these Docker Hub repositories:
**x64**
+ **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.
**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 07:58:47 +02:00
# Wiki
For further informations, How To's and FAQ please check the ![Wiki](../../wiki)