From 3560931949847191f7bf49ddee3fd13aa8eaffae Mon Sep 17 00:00:00 2001 From: Ozzie Isaacs Date: Tue, 22 Nov 2022 16:07:40 +0100 Subject: [PATCH] Added instructions for windows --- Manual-Installation.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/Manual-Installation.md b/Manual-Installation.md index 86cee11..71c6785 100644 --- a/Manual-Installation.md +++ b/Manual-Installation.md @@ -1,6 +1,6 @@ -#### Manual installation +#### Manual installation on Linux or MacOS -If you want to manually install Calibre-Web (“from source”), follow the procedure below. For Windows pip and venv come with the basic installation. On Windows, the python binary can be found after installing the virtual environment under .\venv\script\python3.exe +If you want to manually install Calibre-Web (“from source”), follow the procedure below. 1. Make sure you have installed pip and also venv for your python version. If missing, install it by the package manager of your distribution (e.g., apt for debian like distributions) @@ -20,5 +20,24 @@ If you want to manually install Calibre-Web (“from source”), follow the proc Issues with Ubuntu: Please note that running the above install command can fail on some versions of Ubuntu, saying `"can't combine user with prefix"`. This is a [known bug](https://github.com/pypa/pip/issues/3826) and can be remedied by using the command `./venv/bin/python3 -m pip install --system -r requirements.txt` instead. - Remark: All config files (settings database, log files) are stored in Calibre-Web root page (in this example /opt/calibre-web). Additional config files, such as the config files for gdrive and gmail have to be placed there too. + +#### Manual installation on Windows + +For Windows pip and venv come with the basic installation. On Windows, the python binary can be found after installing the virtual environment under .\venv\script\python3.exe. + +1. Download and install the newest python version for windows from here: https://www.python.org/downloads/windows/ + +2. Start an command prompt via "cmd". Go to the folder where you want to install Calibre-Web, e.g., `c:\calibre-web ` + +3. Create virtual environment for calibre web in folder venv. The python installation in the example is c:\python + - `c:\python\python.exe -m venv venv` + +4. Install dependencies by running `.\venv\script\python3.exe -m pip install -r requirements.txt` (executed from c:\calibre-web folder) + +5. Download and extract Calibre-Web into the current folder (in this example c:\calibre-web) from the releases page on Github + +6. Execute the command: `.\venv\script\python3.exe cps.py` + +Remark: All config files (settings database, log files) are stored in Calibre-Web root page (in this example c:\calibre-web). Additional config files, such as the config files for gdrive and gmail have to be placed there too. +