calibre-web/readme.md

##About

Calibre Web is a Python web app providing a clean interface for browsing, reading and downloading e-books from a Calibre e-book database.

This was originally forked from [calibreserver](https://bitbucket.org/raphaelmutschler/calibreserver) and now includes additional features as well as many bugfixes.

Also available as [Docker image](https://registry.hub.docker.com/u/janeczku/calibre-web/).

![screenshot](https://raw.githubusercontent.com/janeczku/docker-calibre-web/master/screenshot.png)

##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

## 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. To enable public user registration set PUBLIC_REG to 1
3. To enable uploading of PDF books set UPLOADING to 1
4. Execute the command: `python cps.py`
5. Point your browser to `http://localhost:8083` or `http://localhost:8083/feed` for the OPDS catalog 

**Default admin login:**    
*Username:* admin   
*Password:* admin123

## Requirements

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

1. Create a `vendor` folder in the app root
2. [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 this folder.
Add documentation 2015-10-12 01:37:10 +00:00			`##About`

			`Calibre Web is a Python web app providing a clean interface for browsing, reading and downloading e-books from a Calibre e-book database.`

Update feature list 2016-04-12 21:24:23 +00:00			`This was originally forked from [calibreserver](https://bitbucket.org/raphaelmutschler/calibreserver) and now includes additional features as well as many bugfixes.`
Update Readme 2016-03-26 18:48:45 +00:00
			`Also available as [Docker image](https://registry.hub.docker.com/u/janeczku/calibre-web/).`

Add screenshot 2015-10-12 01:42:36 +00:00			`![screenshot](https://raw.githubusercontent.com/janeczku/docker-calibre-web/master/screenshot.png)`

Add documentation 2015-10-12 01:37:10 +00:00			`##Features`
			`- Bootstrap 3 HTML5 interface`
Add screenshot 2015-10-12 01:42:36 +00:00			`- User management`
Add documentation 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`
Add screenshot 2015-10-12 01:42:36 +00:00			`- Support for converting eBooks from EPUB to Kindle format (mobi/azw)`
Add documentation 2015-10-12 01:37:10 +00:00			`- Restrict eBook download to logged-in users`
Update Readme 2016-03-26 18:48:45 +00:00			`- Support for public user registration`
Add screenshot 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`
Update feature list 2016-04-12 21:24:23 +00:00			`- Upload new books in PDF format`
Add screenshot 2015-10-12 01:42:36 +00:00
			`## Quick start`

Merge branch 'fix-gitignore' 2016-04-21 21:14:05 +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
Add config option for upload feature 2016-04-15 17:39:25 +00:00			`2. To enable public user registration set PUBLIC_REG to 1`
			`3. To enable uploading of PDF books set UPLOADING to 1`
Add instructions to enable public user registration 2015-10-13 00:32:39 +00:00			4. Execute the command: `python cps.py`
			5. Point your browser to `http://localhost:8083` or `http://localhost:8083/feed` for the OPDS catalog
Add documentation 2015-10-12 01:37:10 +00:00
			`Default admin login:`
			`Username: admin`
Add screenshot 2015-10-12 01:42:36 +00:00			`Password: admin123`

			`## Requirements`

Add instructions for KindleGen 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:`

			1. Create a `vendor` folder in the app root
			2. [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 this folder.