![]() merge from master |
8 years ago | |
---|---|---|
cps | 8 years ago | |
vendor | 8 years ago | |
.gitignore | 8 years ago | |
LICENSE | 8 years ago | |
babel.cfg | 8 years ago | |
config.ini.example | 8 years ago | |
cps.py | 8 years ago | |
messages.pot | 8 years ago | |
readme.md | 8 years ago |
readme.md
##About
Calibre Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.
This software is a fork of library and licensed under the GPL v3 License.
##Features
- Bootstrap 3 HTML5 interface
- User management
- Admin interface
- User Interface in english, french, german, simplified chinese, spanish
- 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 (.txt, .epub, .pdf)
- Upload new books in PDF, epub, fb2 format
- Support for Calibre custom columns
- Fine grained per-user permissions
Quick start
- Rename
config.ini.example
toconfig.ini
and setDB_ROOT
to the path of the folder where your Calibre library (metadata.db) lives - Execute the command:
python cps.py
- Point your browser to
http://localhost:8083
orhttp://localhost:8083/opds
for the OPDS catalog
Default admin login:
Username: admin
Password: admin123
Runtime Configuration Options
PUBLIC_REG
Set to 1 to enable public user registration.
ANON_BROWSE
Set to 1 to allow not logged in users to browse the catalog.
UPLOADING
Set to 1 to enable PDF uploading. This requires the imagemagick library to be installed.
Requirements
Python 2.7+
Optionally, to enable on-the-fly conversion from EPUB to MOBI when using the send-to-kindle feature:
Download Amazon's KindleGen tool for your platform and place the binary named as kindlegen
in the vendor
folder.
Docker image
Calibre Web can be run as Docker container. The latest image is available on Docker Hub.
Reverse Proxy
Reverse proxy configuration examples for apache and nginx to use calibre-web:
nginx configuration for a local server listening on port 8080, mapping calibre web to /calibre:
http {
upstream calibre {
server 127.0.0.1:8083;
}
server {
location /calibre-web {
proxy_bind $server_addr;
proxy_pass http://127.0.0.1:8083;
proxy_set_header Host $http_host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Scheme $scheme;
proxy_set_header X-Script-Name /calibre-web;
}
}
}
Apache 2.4 configuration for a local server listening on port 443, mapping calibre web to /calibre-web:
The following modules have to be activated: headers, proxy, rewrite.
Listen 443
<VirtualHost *:443>
SSLEngine on
SSLProxyEngine on
SSLCipherSuite ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP:+eNULL
SSLCertificateFile "C:\Apache24\conf\ssl\test.crt"
SSLCertificateKeyFile "C:\Apache24\conf\ssl\test.key"
<Location "/calibre-web" >
RequestHeader set X-SCRIPT-NAME /calibre-web
RequestHeader set X-SCHEME https
ProxyPass http://localhost:8083/
ProxyPassReverse http://localhost:8083/
</Location>
</VirtualHost>
Start calibre-web as service under Linux
Create a file "cps.service" as root in the folder /etc/systemd/system with the following content:
Description=Calibre-web
[Service]
Type=simple
User=[Username]
ExecStart=[path to python] [/PATH/TO/cps.py]
[Install]
WantedBy=multi-user.target
Replace the user and ExecStart with your user and foldernames.
sudo systemctl enable cps.service
enables the service.