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

Tighten up Manual Installation, thx to #3183 & c2ffa94

A Holt 2024-10-27 14:31:12 -06:00
parent ff6892be46
commit 0a20d71ec2
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Manual-Installation.md

@ -2,18 +2,14 @@
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...)_
_These instructions assume a Debian-based Linux distribution (Ubuntu, Raspberry Pi OS, Mint, ...)_
1. **Switch to user `root`**:
- `sudo -i`
2. **Install git, imagemagick, netifaces, pip, venv, and cryptography:**
2. **Install git, imagemagick, netifaces, pip, and venv:**
- `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` (above) is not actually required — but can help if you're having trouble pip installing `cryptography` in Step 6. (If so, run `python3 -m venv venv --system-site-packages` instead of Step 5., to give the virtual environment access your OS's python3-cryptography, allowing you to skip Step 6.)
- `apt install git imagemagick python3-netifaces python3-pip python3-venv`
3. **Download and extract Calibre-Web:**
- `cd /opt`
@ -26,18 +22,26 @@ _These instructions assume a Debian-based Linux distribution (Ubuntu, Raspberry
5. **Install dependencies:**
- `./venv/bin/python3 -m pip install -r requirements.txt`
**PRO TIPS**:
- If the above has trouble pip installing `cryptography`, start over (from the beginning!) and **instead of Step 4.** run `apt install python3-cryptography` then `python3 -m venv venv --system-site-packages` — to give the virtual environment access your OS's python3-cryptography.
- Just FYI on **Ubuntu** and **Debian**, `python3-cryptography` is already installed by default, unlike on **Raspberry Pi OS**.
<!-- No longer needed thanks to #3183, specifically commit "Add cryptography to requirements" = https://github.com/janeczku/calibre-web/commit/c2ffa940cd18970eb78a9379a7a6b19664b8b7e5
6. **Install `cryptography` using pip:** (this NEW step proved necessary when testing on 5 OS's on 2024-10-09: Debian 12, Debian 13, Ubuntu 24.04, Ubuntu 24.10, Raspberry Pi OS)
- `./venv/bin/python3 -m pip install cryptography`
- `./venv/bin/python3 -m pip install cryptography` -->
<!-- **PRO TIP:**
- **If you want a more recent version of `cryptography`** than your OS offers: -->
7. **Run Calibre-Web:** _(FYI the command below does NOT come back to the prompt, and that's OK!)_
6. **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.
- Or use `nohup ./venv/bin/python3 cps.py` if you want it to come back to the prompt, allowing you to exit the terminal window, as Calibre-Web continues running in the background.
8. **[Browse to try it out!](https://github.com/janeczku/calibre-web#quick-start)**
7. **[Browse to try it out!](https://github.com/janeczku/calibre-web#quick-start)**
<!-- 9. **Exit the root shell when finished**:
- `exit` -->