mirrors/calibre-web
1
0
Fork 0
mirror of https://github.com/janeczku/calibre-web synced 2024-11-27 20:10:06 +00:00
Code Issues Releases Wiki Activity

Add deps installation instruction to README

Browse Source
This commit is contained in:
Akhyar Amarullah 2017-01-07 20:40:44 +07:00
parent f81645e67d
commit 56b0fe07f2
1 changed files with 24 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
readme.md
View File

@ -1,4 +1,4 @@
##About ## 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. 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.
@ -6,12 +6,13 @@ Calibre Web is a web app providing a clean interface for browsing, reading and d
![screenshot](https://raw.githubusercontent.com/janeczku/docker-calibre-web/master/screenshot.png) ![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
- User Interface in english, german and french - User Interface in english, german and french
- 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
@ -26,30 +27,31 @@ Calibre Web is a web app providing a clean interface for browsing, reading and d
## Quick start ## 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 1. Install required dependencies by executing `pip install -r requirements.txt`
2. Execute the command: `python cps.py` 2. Rename `config.ini.example` to `config.ini` and set `DB_ROOT` to the path of the folder where your Calibre library (metadata.db) lives
3. Point your browser to `http://localhost:8083` or `http://localhost:8083/opds` for the OPDS catalog 3. Execute the command: `python cps.py`
4. Point your browser to `http://localhost:8083` or `http://localhost:8083/opds` for the OPDS catalog
**Default admin login:** **Default admin login:**
*Username:* admin *Username:* admin
*Password:* admin123 *Password:* admin123
## Runtime Configuration Options ## Runtime Configuration Options
`PUBLIC_REG` `PUBLIC_REG`
Set to 1 to enable public user registration. Set to 1 to enable public user registration.
`ANON_BROWSE` `ANON_BROWSE`
Set to 1 to allow not logged in users to browse the catalog. Set to 1 to allow not logged in users to browse the catalog.
`UPLOADING` `UPLOADING`
Set to 1 to enable PDF uploading. This requires the imagemagick library to be installed. Set to 1 to enable PDF uploading. This requires the imagemagick library to be installed.
## Requirements ## Requirements
Python 2.7+ Python 2.7+
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. 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 image ## Docker image
@ -91,13 +93,13 @@ Listen 443
SSLCipherSuite ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP:+eNULL SSLCipherSuite ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP:+eNULL
SSLCertificateFile "C:\Apache24\conf\ssl\test.crt" SSLCertificateFile "C:\Apache24\conf\ssl\test.crt"
SSLCertificateKeyFile "C:\Apache24\conf\ssl\test.key" SSLCertificateKeyFile "C:\Apache24\conf\ssl\test.key"
<Location /calibre-web> <Location /calibre-web>
ProxyHTMLEnable On ProxyHTMLEnable On
ProxyPass http://127.0.0.1:8083/ ProxyPass http://127.0.0.1:8083/
ProxyPassReverse http://127.0.0.1:8083/ ProxyPassReverse http://127.0.0.1:8083/
Header edit Location "^http://(.*?)/" "https://$1/calibre-web/" Header edit Location "^http://(.*?)/" "https://$1/calibre-web/"
ProxyHTMLURLMap / /calibre-web/ ProxyHTMLURLMap / /calibre-web/
</Location> </Location>
</VirtualHost> </VirtualHost>
``` ```
@ -122,4 +124,4 @@ Replace the user and ExecStart with your user and foldernames.
`sudo systemctl enable cps.service` `sudo systemctl enable cps.service`
enables the service. enables the service.