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

Make instructions more accurate by adding imagemagick and netifaces

Blondel MONDESIR 2024-10-03 11:15:27 -04:00
parent a6c1683676
commit 765da6d8ee
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Manual-Installation.md

@ -1,9 +1,9 @@
### Manual installation on Linux or MacOS ### Manual Installation on Linux or MacOS
If you want to manually install Calibre-Web (“from source”), follow the procedure below. If you want to manually install Calibre-Web (“from source”), follow the procedure below.
1. **Install pip, venv, and cryptography (optional)** 1. **Install imagemagick, netifaces, pip, venv, and cryptography (optional)**
Make sure you have pip and venv installed for your Python version. Install them via your distribution's package manager (e.g., apt for Debian-based distributions). Make sure you have `imagemagick`, `netifaces`, `pip`, and `venv` installed for your Python version. Install them via your distribution's package manager (e.g., `apt` for Debian-based distributions).
- `sudo apt install imagemagick python3-netifaces python3-pip python3-venv` - `sudo apt install imagemagick python3-netifaces python3-pip python3-venv`
@ -13,13 +13,13 @@ If you want to manually install Calibre-Web (“from source”), follow the proc
- `sudo apt install python3-cryptography` - `sudo apt install python3-cryptography`
- Installing `python3-cryptography` is not required if you plan to install a newer version using pip in Step 5. - Installing `python3-cryptography` is not required if you plan to install a newer version using pip in Step 5.
2. **Navigate to the folder where you want to install Calibre-Web**, e.g., 2. **Navigate to the folder where you want to install Calibre-Web**, e.g.:
- `cd /opt/calibre-web` - `cd /opt/calibre-web`
3. **Create a virtual environment** for Calibre-Web in the current folder: 3. **Create a virtual environment** for Calibre-Web in the current folder:
- `python3 -m venv venv` - `python3 -m venv venv`
4. **Download and extract Calibre-Web** into the current folder (in this example `/opt/calibre-web`) from the [releases page on Github](https://github.com/janeczku/calibre-web/releases). 4. **Download and extract Calibre-Web** into the current folder (in this example, `/opt/calibre-web`) from the [releases page on Github](https://github.com/janeczku/calibre-web/releases).
5. **Install dependencies** by running: 5. **Install dependencies** by running:
- `./venv/bin/python3 -m pip install -r requirements.txt` - `./venv/bin/python3 -m pip install -r requirements.txt`
@ -27,7 +27,7 @@ If you want to manually install Calibre-Web (“from source”), follow the proc
- **Optional: Install a more recent version of `cryptography`** (if not using the OS version): - **Optional: Install a more recent version of `cryptography`** (if not using the OS version):
- `./venv/bin/python3 -m pip install cryptography` - `./venv/bin/python3 -m pip install cryptography`
6. **Execute Calibre-Web** with the command: 6. **Run Calibre-Web** with the command:
- `./venv/bin/python3 cps.py` - `./venv/bin/python3 cps.py`
(or use `nohup ./venv/bin/python3 cps.py` if you want to exit the terminal window) (or use `nohup ./venv/bin/python3 cps.py` if you want to exit the terminal window)
@ -42,11 +42,11 @@ Depending on your version of pip, the installation might fail with `Failed to bu
3. Then, try installing Calibre-Web again. 3. Then, try installing Calibre-Web again.
**Ubuntu**: **Ubuntu**:
On some Ubuntu versions, you may see the error `can't combine user with prefix`. This is a [known bug](https://github.com/pypa/pip/issues/3826) and can be resolved by installing the requirements with the `--system` flag: On some Ubuntu versions, you may encounter the error `can't combine user with prefix`. This is a [known bug](https://github.com/pypa/pip/issues/3826) and can be resolved by installing the requirements with the `--system` flag:
- `./venv/bin/python3 -m pip install --system -r requirements.txt` - `./venv/bin/python3 -m pip install --system -r requirements.txt`
**Configuration Files**: **Configuration Files**:
All configuration files (settings database, log files) are stored in the Calibre-Web root folder (in this example, `/opt/calibre-web`). Any 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, `/opt/calibre-web`). Additional config files, such as those for Google Drive or Gmail integration, should be placed there as well.
--- ---
@ -68,7 +68,7 @@ On Windows, pip and venv are included with the basic Python installation. Follow
- `.\venv\Scripts\python3.exe -m pip install -r requirements.txt` - `.\venv\Scripts\python3.exe -m pip install -r requirements.txt`
(Executed from the `c:\calibre-web` folder.) (Executed from the `c:\calibre-web` folder.)
6. **Execute Calibre-Web** with the command: 6. **Run Calibre-Web** with the command:
- `.\venv\Scripts\python3.exe cps.py` - `.\venv\Scripts\python3.exe cps.py`
**Configuration Files**: **Configuration Files**: