calibre-web/readme.md

37 lines
1.4 KiB
Markdown
Raw Normal View History

2015-10-12 01:42:36 +00:00
This is an in-progress fork of [calibreserver](https://bitbucket.org/raphaelmutschler/calibreserver) by Raphael Mutschler.
A working Docker image is available here: [janeczku/calibre-web](https://registry.hub.docker.com/u/janeczku/calibre-web/).
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.
2015-10-12 01:42:36 +00:00
![screenshot](https://raw.githubusercontent.com/janeczku/docker-calibre-web/master/screenshot.png)
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
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
## Quick start
1. Execute the command: `python cps.py` (it will throw an error)
2. Edit config.ini and set DB_ROOT to the path of the folder where your Calibre library (metadata.db) lives
2015-10-12 01:37:10 +00:00
3. Execute the command: `python cps.py`
2015-10-12 02:14:48 +00:00
4. 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
## Requirements
Python 2.7+