Add screenshot

This commit is contained in:
Jan Broer 2015-10-12 03:42:36 +02:00
parent 9382bfa2e8
commit b4390c8b8b

View File

@ -1,35 +1,37 @@
This is an in-progress fork of [calibreserver](https://bitbucket.org/raphaelmutschler/calibreserver) by Raphael Mutschler. 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/). A working Docker image is available here: [janeczku/calibre-web](https://registry.hub.docker.com/u/janeczku/calibre-web/).
##About ##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. Calibre Web is a Python web app providing a clean interface for browsing, reading and downloading e-books from a Calibre e-book database.
![screenshot](https://raw.githubusercontent.com/janeczku/docker-calibre-web/master/screenshot.png)
##Features ##Features
- Bootstrap 3 HTML5 interface - Bootstrap 3 HTML5 interface
- User management - User management
- Admin interface - Admin interface
- OPDS feed for eBook reader apps - OPDS feed for eBook reader apps
- Filter and search by titles, authors, tags, series and language - Filter and search by titles, authors, tags, series and language
- Create custom book collection (shelves) - Create custom book collection (shelves)
- Support for editing eBook metadata - Support for editing eBook metadata
- Support for converting eBooks from EPUB to Kindle format (mobi/azw) - Support for converting eBooks from EPUB to Kindle format (mobi/azw)
- Restrict eBook download to logged-in users - Restrict eBook download to logged-in users
- Send eBooks to Kindle devices with the click of a button - Send eBooks to Kindle devices with the click of a button
- Support for reading eBooks directly in the browser - Support for reading eBooks directly in the browser
## Quick start ## Quick start
1. Execute the command: `python cps.py` (it will throw an error) 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 2. Edit config.ini and set DB_ROOT to the path of the folder where your Calibre library (metadata.db) lives
3. Execute the command: `python cps.py` 3. Execute the command: `python cps.py`
4. Point your browser to `http://localhost:8083` 4. Point your browser to `http://localhost:8083`
**Default admin login:** **Default admin login:**
*Username:* admin *Username:* admin
*Password:* admin123 *Password:* admin123
## Requirements ## Requirements
Python 2.7+ Python 2.7+