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

Prepend commands with sudo

Blondel MONDESIR 2024-10-08 20:57:03 -04:00
parent bce288a93a
commit b4a6f672fe
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
Manual-Installation.md

@ -4,31 +4,32 @@ If you want to manually install Calibre-Web (“from source”), follow the inst
_These instructions assume a Debian-based Linux distribution (Ubuntu, Raspberry Pi OS...)_ _These instructions assume a Debian-based Linux distribution (Ubuntu, Raspberry Pi OS...)_
1. **Install git, imagemagick, netifaces, pip, venv, and cryptography:** 1. **Install git, imagemagick, netifaces, pip, venv, and cryptography:**
- `sudo apt install git imagemagick python3-netifaces python3-pip python3-venv python3-cryptography` - `sudo apt install git imagemagick python3-netifaces python3-pip python3-venv python3-cryptography`
**PRO TIPS**: **PRO TIPS**:
- On **Ubuntu** and **Debian**, `python3-cryptography` is installed by default, unlike on Raspberry Pi OS. - On **Ubuntu** and **Debian**, `python3-cryptography` is installed by default, unlike on Raspberry Pi OS.
- Installing `python3-cryptography` is not required if you plan to install a newer version using pip as described in Step 4. - Installing `python3-cryptography` is not required if you plan to install a newer version using pip as described in Step 4.
2. **Download and extract Calibre-Web:** 2. **Download and extract Calibre-Web:**
- `sudo mkdir -p /opt`
- `cd /opt` - `cd /opt`
- `git clone https://github.com/janeczku/calibre-web` - `sudo git clone https://github.com/janeczku/calibre-web`
- `cd calibre-web` - `cd calibre-web`
3. **Create a virtual environment** for Calibre-Web: 3. **Create a virtual environment** for Calibre-Web:
- `python3 -m venv venv` - `sudo python3 -m venv venv`
4. **Install dependencies** by running: 4. **Install dependencies** by running:
- `./venv/bin/python3 -m pip install -r requirements.txt` - `sudo ./venv/bin/python3 -m pip install -r requirements.txt`
**PRO TIP:** **PRO TIP:**
- **If you want a more recent version of `cryptography`** than your OS offers: - **If you want a more recent version of `cryptography`** than your OS offers:
- `./venv/bin/python3 -m pip install cryptography` - `sudo ./venv/bin/python3 -m pip install cryptography`
5. **Run Calibre-Web** with the command: 5. **Run Calibre-Web** with the command:
- `./venv/bin/python3 cps.py` - `sudo ./venv/bin/python3 cps.py`
**PRO TIP:** **PRO TIP:**
- 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.
@ -37,19 +38,19 @@ _These instructions assume a Debian-based Linux distribution (Ubuntu, Raspberry
#### Additional Issues and Considerations: #### Additional Issues and Considerations:
**Raspberry Pi (Raspberry Pi OS)**: **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: Depending on your version of pip, the installation might fail with `Failed to build cryptography`. If you encounter this issue, try:
1. Updating pip: 1. Updating pip:
- `./venv/bin/python3 -m pip install --upgrade pip` - `sudo ./venv/bin/python3 -m pip install --upgrade pip`
2. If the error persists, install `cargo`: 2. If the error persists, install `cargo`:
- `sudo apt install cargo` - `sudo apt install cargo`
3. Then, try installing Calibre-Web again. 3. Then, try installing Calibre-Web again.
**Ubuntu**: **Ubuntu**:
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: 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` - `sudo ./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`). 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.
--- ---
@ -75,5 +76,5 @@ On Windows, pip and venv are included with the basic Python installation. Follow
6. **Run 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**:
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. 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.