calibre-web/readme.md

# About

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.

*This software is a fork of [library](https://github.com/mutschler/calibreserver) and licensed under the GPL v3 License.*

![Main screen](../../wiki/images/main_screen.png)

## 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](https://github.com/pypa/pip/issues/3826) 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 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.

## Docker images

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)

# Wiki

For further informations, How To's and FAQ please check the ![Wiki](../../wiki)
Updated readme 2017-03-19 17:22:21 +01:00			`# About`
Add documentation 2015-10-12 03:37:10 +02:00
Fix #590, #589. Unified wording Calibre-Web Replaced one table on admin page, deleted password column Removed spaces on layout page Removed uesless commit calls during db migration Implementation of registering by email 2018-08-24 15:48:09 +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.`
Add documentation 2015-10-12 03:37:10 +02:00
Add GPL v3 License 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.`
Update Readme 2016-03-26 19:48:45 +01:00
Fixes Google Drive Improved user guidance for Google Drive Improved Errorhandling for Google Drive Update french translation Added ukranian translation Improvements on updater: calibre-web.log1, calibre-web.log2, gdrive_credentials, settings.yaml, gdrive.db, .git are no longer deleted upon update 2019-02-03 16:38:27 +01:00			`![Main screen](../../wiki/images/main_screen.png)`
Add screenshot 2015-10-12 03:42:36 +02:00
Add deps installation instruction to README 2017-01-07 20:40:44 +07:00			`## Features`

Add documentation 2015-10-12 03:37:10 +02:00			`- Bootstrap 3 HTML5 interface`
- Fully graphical setup (can be changed as admin under configuration) - Title of calibre-web can be changed, to distinguish between different installations - View of "random books" can be changed independent of discover books - Author view in sidebar can be switched of ###################################### !!!!This is a big change, I recommend everybody updating from an earlier version to do a backup before upgrading!!!! ###################################### 2017-01-28 20:29:04 +01:00			`- full graphical setup`
Basi comic reader implementation for cbr, cbz, cbt files based on kthoom (#63, #126) 2017-09-17 12:36:32 +02:00			`- User management with fine grained per-user permissions`
Add documentation 2015-10-12 03:37:10 +02:00			`- Admin interface`
Fixes Google Drive Improved user guidance for Google Drive Improved Errorhandling for Google Drive Update french translation Added ukranian translation Improvements on updater: calibre-web.log1, calibre-web.log2, gdrive_credentials, settings.yaml, gdrive.db, .git are no longer deleted upon update 2019-02-03 16:38:27 +01:00			`- User Interface in dutch, english, french, german, hungarian, italian, japanese, khmer, polish, russian, simplified chinese, spanish, swedish, ukrainian`
Renamed feed to opds for better compatibility with some readers added clickable links to feed (should hopefully solve #79) updated readme 2016-12-28 15:51:58 +01:00			`- OPDS feed for eBook reader apps`
Add documentation 2015-10-12 03:37:10 +02:00			`- Filter and search by titles, authors, tags, series and language`
			`- Create custom book collection (shelves)`
added ability to delete books 2017-04-15 21:00:41 +02:00			`- Support for editing eBook metadata and deleting eBooks from Calibre library`
Fixes Google Drive Improved user guidance for Google Drive Improved Errorhandling for Google Drive Update french translation Added ukranian translation Improvements on updater: calibre-web.log1, calibre-web.log2, gdrive_credentials, settings.yaml, gdrive.db, .git are no longer deleted upon update 2019-02-03 16:38:27 +01:00			`- Support for converting eBooks through Calibre binaries`
Add documentation 2015-10-12 03:37:10 +02:00			`- Restrict eBook download to logged-in users`
Update Readme 2016-03-26 19:48:45 +01:00			`- Support for public user registration`
Add screenshot 2015-10-12 03:42:36 +02:00			`- Send eBooks to Kindle devices with the click of a button`
Basi comic reader implementation for cbr, cbz, cbt files based on kthoom (#63, #126) 2017-09-17 12:36:32 +02:00			`- Support for reading eBooks directly in the browser (.txt, .epub, .pdf, .cbr, .cbt, .cbz)`
Fixes Google Drive Improved user guidance for Google Drive Improved Errorhandling for Google Drive Update french translation Added ukranian translation Improvements on updater: calibre-web.log1, calibre-web.log2, gdrive_credentials, settings.yaml, gdrive.db, .git are no longer deleted upon update 2019-02-03 16:38:27 +01:00			`- Upload new books in many formats`
Update readme.md 2016-04-27 17:37:19 +02:00			`- Support for Calibre custom columns`
Basi comic reader implementation for cbr, cbz, cbt files based on kthoom (#63, #126) 2017-09-17 12:36:32 +02:00			`- Ability to hide content based on categories for certain users`
Update readme.md 2017-02-03 10:51:58 +01:00			`- Self update capability`
Add "magic link" functionality When using a device that is bothersome to log in on (e.g. a Kindle) you can use a magic link to log in via another device. Configuration was added and is disabled by default. 2017-07-07 18:18:03 -07:00			`- "Magic Link" login to make it easy to log on eReaders`
Add screenshot 2015-10-12 03:42:36 +02:00
			`## Quick start`

Modify Readme for Ubuntu install bug 2018-10-03 12:32:49 +00:00			1. Install dependencies by running `pip install --target vendor -r requirements.txt`.
Merge remote-tracking branch 'use_pip/use-pip' # Conflicts: # cps.py # readme.md # vendor/wand/api.py # vendor/wand/drawing.py # vendor/wand/exceptions.py # vendor/wand/image.py # vendor/wand/version.py 2017-03-07 19:46:23 +01:00			2. Execute the command: `python cps.py` (or `nohup python cps.py` - recommended if you want to exit the terminal window)
Merge branch 'master' into develop # Conflicts: # cps/db.py # cps/ub.py # cps/web.py # readme.md # requirements.txt 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
Merge remote-tracking branch 'use_pip/use-pip' # Conflicts: # cps.py # readme.md # vendor/wand/api.py # vendor/wand/drawing.py # vendor/wand/exceptions.py # vendor/wand/image.py # vendor/wand/version.py 2017-03-07 19:46:23 +01:00			4. Set `Location of Calibre database` to the path of the folder where your Calibre library (metadata.db) lives, push "submit" button
Fix #188 2017-07-08 14:00:34 +02:00			`optionally a google drive can be used to host the calibre library (-> Using Google Drive integration)`
Merge remote-tracking branch 'use_pip/use-pip' # Conflicts: # cps.py # readme.md # vendor/wand/api.py # vendor/wand/drawing.py # vendor/wand/exceptions.py # vendor/wand/image.py # vendor/wand/version.py 2017-03-07 19:46:23 +01:00			`5. Go to Login page`
Add documentation 2015-10-12 03:37:10 +02:00
Update readme 2019-02-03 17:29:27 +01:00			`Default admin login:\`
			`Username: admin\`
Add screenshot 2015-10-12 03:42:36 +02:00			`Password: admin123`

Modify Readme for Ubuntu install bug 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.

Add screenshot 2015-10-12 03:42:36 +02:00			`## Requirements`

Fixes Google Drive Improved user guidance for Google Drive Improved Errorhandling for Google Drive Update french translation Added ukranian translation Improvements on updater: calibre-web.log1, calibre-web.log2, gdrive_credentials, settings.yaml, gdrive.db, .git are no longer deleted upon update 2019-02-03 16:38:27 +01:00			`Python 2.7+, python 3.x+`
Add instructions for KindleGen 2015-10-12 04:37:39 +02:00
Add deps installation instruction to README 2017-01-07 20:40:44 +07: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.
Add GPL v3 License 2016-04-27 17:29:57 +02:00
Other docker containers Wondered if you'd mind adding a bit about our containers to the readme, might be nice for people using other architectures. 2018-07-03 21:57:24 +01:00			`## Docker images`
Add GPL v3 License 2016-04-27 17:29:57 +02:00
Other docker containers Wondered if you'd mind adding a bit about our containers to the readme, might be nice for people using other architectures. 2018-07-03 21:57:24 +01:00			`Pre-built Docker images based on Alpine Linux are available in these Docker Hub repositories:`

			`x64`
Explain difference between Docker images (#746) 2019-01-05 10:00:49 -05: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.`
Other docker containers Wondered if you'd mind adding a bit about our containers to the readme, might be nice for people using other architectures. 2018-07-03 21:57:24 +01: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)`
Add reverse proxy configuration infos 2016-10-08 07:58:47 +02:00
Fixes Google Drive Improved user guidance for Google Drive Improved Errorhandling for Google Drive Update french translation Added ukranian translation Improvements on updater: calibre-web.log1, calibre-web.log2, gdrive_credentials, settings.yaml, gdrive.db, .git are no longer deleted upon update 2019-02-03 16:38:27 +01:00			`# Wiki`

			`For further informations, How To's and FAQ please check the ![Wiki](../../wiki)`