-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Manual Installation
If you want to manually install Calibre-Web (“from source”), follow the instructions below.
These instructions assume a Debian-based Linux distribution (Ubuntu, Raspberry Pi OS...)
-
Switch to user
root
:sudo -i
-
Install git, imagemagick, netifaces, pip, venv, and cryptography:
apt install git imagemagick python3-netifaces python3-pip python3-venv python3-cryptography
PRO TIPS:
- On Ubuntu and Debian,
python3-cryptography
is installed by default, unlike on Raspberry Pi OS. - Installing
python3-cryptography
may not be required if you install a newer version ofcryptography
using pip, as described in Step 6.
-
Download and extract Calibre-Web:
cd /opt
git clone https://github.com/janeczku/calibre-web
cd calibre-web
-
Create a virtual environment for Calibre-Web:
python3 -m venv venv
-
Install dependencies by running:
./venv/bin/python3 -m pip install -r requirements.txt
-
As of 2024-10-09, the OS version of
python3-cryptography
is mysteriously no longer enough (as tested on 4 OS's — Debian 12, Debian 13, Ubuntu 24.04, Ubuntu 24.10), so installcryptography
using pip:./venv/bin/python3 -m pip install cryptography
-
Run Calibre-Web: (FYI the command below does NOT come back to the prompt, and that's OK!)
./venv/bin/python3 cps.py
PRO TIP:
- Or use
nohup ./venv/bin/python3 cps.py
if you want to exit the terminal window.
-
Raspberry Pi (Raspberry Pi OS):
- Depending on your version of pip, the installation might fail with
Failed to build cryptography
.- If you encounter this issue, try updating pip:
./venv/bin/python3 -m pip install --upgrade pip
- If the error persists, install
cargo
:apt install cargo
- Then, try installing Calibre-Web again.
- If you encounter this issue, try updating pip:
- Depending on your version of pip, the installation might fail with
-
Ubuntu:
- On some Ubuntu versions, you may encounter the error
can't combine user with prefix
. This is a known bug and can be resolved by installing the requirements with the--system
flag:./venv/bin/python3 -m pip install --system -r requirements.txt
- On some Ubuntu versions, you may encounter the error
-
Configuration Files:
- All configuration files (settings database, log files) are stored in the Calibre-Web root folder (in this example,
/opt/calibre-web
). Additional config files, such as those for Google Drive or Gmail integration, should be placed there as well.
- All configuration files (settings database, log files) are stored in the Calibre-Web root folder (in this example,
On Windows, pip and venv are included with the basic Python installation. Follow the steps below:
-
Download and install the newest Python version for Windows from python.org.
-
Open a command prompt (cmd) and navigate to the folder where you want to install Calibre-Web, e.g.,
c:\calibre-web
. -
Create a virtual environment for Calibre-Web in the folder
venv
:-
c:\python\python.exe -m venv venv
(This example assumes Python is installed inc:\python
.)
-
-
Download and extract Calibre-Web into the current folder (in this example,
c:\calibre-web
) from the releases page on Github. -
Install dependencies by running:
-
.\venv\Scripts\python3.exe -m pip install -r requirements.txt
(Executed from thec:\calibre-web
folder.)
-
-
Run Calibre-Web with the command:
.\venv\Scripts\python3.exe cps.py
Configuration Files:
All configuration files (settings database, log files) are stored in the Calibre-Web root folder (in this example, c:\calibre-web
). Additional config files (e.g., for Google Drive or Gmail) should also be placed here.