└── README.md /README.md: -------------------------------------------------------------------------------- 1 | Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using a valid Calibre database. 2 | 3 | ## Requirements 4 | 5 | python 3.5+ 6 | 7 | [Download](https://imagemagick.org/script/download.php) Imagemagick to extract covers from epubs. On Windows the additional installation of [ghostscript](https://ghostscript.com/releases/gsdnld.html) might be necessary to extract covers from pdf files. On Linux Imagemagick and Ghostscript can often be installed using the system package manager. 8 | 9 | Optionally, to enable on-the-fly conversion from one ebook format to another when using the send-to-ereader feature, or during editing of ebooks metadata: 10 | 11 | [Download and install](https://calibre-ebook.com/download) the Calibre desktop program for your platform and enter the folder including program name (normally /opt/calibre/ebook-convert, or C:\Program Files\calibre\ebook-convert.exe) in the field "calibre's converter tool" on the setup page. 12 | 13 | [Download](https://github.com/pgaskin/kepubify/releases/latest) Kepubify tool for your platform and place the binary starting with kepubify in Linux: /opt/kepubify Windows: C:\Program Files\kepubify. 14 | 15 | ## How to install CALIBRE-WEB via pip (recommended) 16 | 17 | 1. Execute the command: `sudo apt-get update` 18 | 2. Install pip: `sudo apt-get install pip` 19 | To avoid problems with already installed python dependencies, it's recommended to create a virtual environment for Calibre-Web 20 | 3. Install Calibre-Web via pip with the command `pip install calibreweb` (Depending on your OS and or distro the command could also be pip3). 21 | 4. Optional features can also be installed via pip, please refer to [this page](https://github.com/janeczku/calibre-web/wiki/Dependencies-in-Calibre-Web-Linux-and-Windows) for details 22 | 5. Calibre-Web can be started afterwards by typing `cps` (or `nohup cps` - recommended if you want to exit the terminal window) 23 | 6. Point your browser to http://localhost:8083 or http://localhost:8083/opds for the OPDS catalog 24 | 7. Login with default admin login 25 | 26 | **Default admin login:** 27 | *Username:* admin 28 | *Password:* admin123 29 | 30 | 8. If you don't have a Calibre database already, this [database](https://github.com/janeczku/calibre-web/blob/master/library/metadata.db) can be used. IMPORTATNT Please move the database out of the calibre-web folder structure, as it will be overwritten during update. 31 | 9. Set Location of Calibre database to the path of the folder where your Calibre library (metadata.db) lives, push "submit" button. 32 | 10. Afterwards you can configure your Calibre-Web instance ([Basic Configuration](https://github.com/janeczku/calibre-web/wiki/Configuration#basic-configuration) and [UI Configuration](https://github.com/janeczku/calibre-web/wiki/Configuration#ui-configuration) on admin page) 33 | 34 | ## For more information go to [https://github.com/janeczku/calibre-web](https://github.com/janeczku/calibre-web) 35 | --------------------------------------------------------------------------------