1
0
mirror of https://github.com/janeczku/calibre-web synced 2025-07-07 12:32:58 +00:00

Update Installation

Ozzie Isaacs 2022-02-19 10:29:11 +01:00
parent 9ace5f6c71
commit fd2f031361
4 changed files with 89 additions and 48 deletions

15
FAQ.md

@ -6,8 +6,7 @@ Python is a very modular programming language, special functionality can be incl
### What do I do if I lose my "Admin" password?
If there is more than on admin on your instance, any other admin can generate a new password for your account.
If the only admin forgot his password: You are in trouble. Currently no password reset function is implemented.
The only option would be editing the password in the app.db with a sqlite Database editor, or starting from the beginning.
Please stop your calibre-web instance and start Calibre-Web with the commandline option -s [username]:[newpassword], to set a new password for your admin
### How to Backup Calibre-Web Settings?
@ -55,7 +54,7 @@ If you are using some additional systems like a proxy or reverse proxy, they mus
### Can Calibre-web execute malicious code in an epub?
If you just organize your epubs with Calibre-web, the content of the epub is not touched, and nothing gets to execution.\
If you just organize your epubs with Calibre-Web, the content of the epub is not touched, and nothing gets to execution.\
If you use the included epub-reader, it is a different story:\
Calibre-web unpacks the epub (which are normal zip files) to a folder on the server which is accessible by the browser. Then Calibre-web sends the reader page to the browser. The browser starts the epub-reader JavaScript file, which itself starts to build up the webpage you see. During that process, the file contents of the epub file are loaded into the browser. The content is just normal html pages, which can include stylesheet files and JavaScript files. So if there is malicious code included the epub, or links to JavaScript code, the browser (if not prevented somehow) will start to interpret it.
@ -88,12 +87,12 @@ fi
### Login Kobo
Kobo readers having problems using the internal web browser on non-standard ports means with the Calibre-web standard port the magic login link normally doesn't work. As workaround Calibre-web could be accessed via reverse proxy, or using the normal login method.
Kobo readers having problems using the internal web browser on non-standard ports. This means with the Calibre-web standard port the magic login link normally doesn't work. As workaround Calibre-web could be accessed via reverse proxy, or using the normal login method.
### Non ASCII Filenames
### Non ASCII Filenames on disk
Non ASCII Filenames, including author names (containing korean, chinese, ... characters) are changed to a transliterated representation. This is an exact copy of the behavior of Calibre.
Non ASCII Filenames, including author names (containing korean, chinese, ... characters) are changed to a transliterated representation. In newer versions ticking the setting "Convert non-English characters in title and author while saving to disk" will save the books with their original characters
### Invalid SSL configuration
@ -107,7 +106,7 @@ Shelfs can be filled book by book on the corresponding detail page. Books can al
### Send to kindle with guest account
In a one-user use case you can use the guest account for sending ebooks to kindle. In this case please add a kindle-email to the guest account; afterwards the "send to kindle" button appears for the guest user. If more than one user is accessing the guest account this will not working, as you can only have one kindle-email linked to a user.
In a one-user use case you can use the guest account for sending ebooks to kindle. In this case please add a kindle-email to the guest account; afterwards the "send to kindle" button appears for the guest user. If more than one user is accessing the guest account this will not work, as you can only have one kindle-email linked to a user.
### Link Read Status to Calibre Custom Column
@ -122,7 +121,7 @@ How to use the feature?
The read/unread status is now identical in Calibre and Calibre-web
### How to handle Multiple Calibre Libs
### How to handle Multiple Calibre Libraries
The recommended way for handling multiple libraries is to start multiple instances of Calibre-web. Instead of having several copies of the Calibre-web code, command line options can be used for this. First start Calibre-web with the normal command:\
`python3 [path to calibre-web]/cps.py`\

@ -2,54 +2,70 @@
Before installing Calibre-Web we have to install component: python3-pip
1 - We open a terminal inside the Calibre-Web directory
1. We open a terminal inside the Calibre-Web directory
2 - We run the following at the terminal:
2. We run the following at the terminal:
- sudo apt install python3-pip
- `sudo apt install python3-pip`
3 - We execute the installation of Calibre-Web:
3. Go to the folder where you want to install calibre-web, e.g. /opt/calibre-web
- python3 -m pip install --system --target vendor -r requirements.txt
4. Install virtual environment and create one for calibre web
4 - We run Calibre-Web:
- `python3 -m pip install venv`
- python3 cps.py
- `python3 -m venv venv`
3. Execute the installation of Calibre-Web with newly created virtual python environment:
- `./venv/bin/python3 -m pip install calibreweb`
4. We run Calibre-Web (using the python from the newly created virtual python environment) with:
- `./venv/bin/cps` or `./venv/bin/python3 -m cps`
DANGER: Never close the terminal. To start Calibre-Web at startup, please take a look at [How to Start Calibre-Web as Service](https://github.com/janeczku/calibre-web/wiki/Setup-Service-on-Linux#start-calibre-web-as-service-under-linux-with-systemd)
5 - Launch web browser and write http://localhost:8083
5. Launch web browser and write http://localhost:8083
Default admin login:\
Username: admin\
Password: admin123
6 - Calibre-Web running
6. Calibre-Web running
Important(if not started as service): If we turn on or reboot Linux Mint we have to open a terminal inside the Calibre-Web directory and run: python3 cps.py
Important(if not started as service): If we turn on or reboot Linux Mint we have to open a terminal inside the Calibre-Web directory and run: [folder where calibre web is installed]/venv/bin/python3 cps.py
## Installation in Linux Mint 19:
Before installing Calibre-Web we have to install several components: python3-pip, python3-dev, setuptools, wheel.
1 - We open a terminal inside the Calibre-Web directory
1. We open a terminal inside the Calibre-Web directory
2 - We run the following at the terminal:
2. We run the following at the terminal:
- sudo apt install python3-pip
- `sudo apt install python3-pip`
- sudo apt install python3-dev
- `sudo apt install python3-dev`
- python3 -m pip install --upgrade setuptools
- `python3 -m pip install --upgrade setuptools`
- python3 -m pip install wheel
- `python3 -m pip install wheel`
3 - We execute the installation of Calibre-Web:
3. Go to the folder where you want to install calibre-web, e.g. /opt/calibre-web
- python3 -m pip install --system --target vendor -r requirements.txt
4. Install virtual environment and create one for calibre web
4 - We run Calibre-Web:
- `python3 -m pip install venv`
- python3 cps.py
- `python3 -m venv venv`
5. Execute the installation of Calibre-Web with newly created virtual python environment:
- `./venv/bin/python3 -m pip install calibreweb`
6. We run Calibre-Web (using the python from the newly created virtual python environment) with:
- `./venv/bin/cps` or `./venv/bin/python3 -m cps`
DANGER: Never close the terminal. To start Calibre-Web at startup, please take a look at [How to Start Calibre-Web as Service](https://github.com/janeczku/calibre-web/wiki/Setup-Service-on-Linux#start-calibre-web-as-service-under-linux-with-systemd)
@ -60,7 +76,7 @@ DANGER: Never close the terminal. To start Calibre-Web at startup, please take a
6 - Calibre-Web running
Remark: All config files (settings database, logfiles) are stored in /homes/[username]/.calibre-web. Additional config files, such as the config files for gdrive and gmail have to be placed there too.

25
Manual-Installation.md Normal file

@ -0,0 +1,25 @@
#### Manual installation
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
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)
- `sudo apt install python3-pip python3-venv`
2. Go to the folder where you want to install calibre-web, e.g. /opt/calibre-web
3. Create virtual environment for calibre web in folder venv
- `python3 -m venv venv`
4. Install dependencies by running `./venv/bin/python3 -m pip install -r requirements.txt`
5. Download and extract calibre-web into the current folder (in this example /opt/calibre-web)
6. Execute the command: `./venv/bin/python3 cps.py` (or `nohup ./venv/python3 cps.py` - recommended if you want to exit the terminal window)
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/python3 -m pip install --system -r requirements.txt` instead.
Remark: All config files (settings database, logfiles) 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.

@ -4,22 +4,23 @@ The following user languages are available:
| Language | Translations |
| ---------- |:---------:|
| Czech | 598 of strings 744 translated |
| German | 730 of strings 744 translated |
| Greek | 633 of strings 744 translated |
| Spanish | 729 of strings 744 translated |
| Finnish | 448 of strings 744 translated |
| French | 728 of strings 744 translated |
| Hungarian | 389 of strings 744 translated |
| Italian | 732 of strings 744 translated |
| Japanese | 303 of strings 744 translated |
| Khmer | 274 of strings 744 translated |
| Dutch | 730 of strings 744 translated |
| Polish | 729 of strings 744 translated |
| Portuguese (Brazil) | 676 of strings 744 translated |
| Russian | 560 of strings 744 translated |
| Swedish | 712 of strings 744 translated |
| Turkish | 368 of strings 744 translated |
| Ukrainian | 242 of strings 744 translated |
| Chinese (Simplified, China) | 741 of strings 744 translated |
| Chinese (Traditional, Taiwan) | 732 of strings 744 translated |
| Czech | 598 of strings 745 translated |
| German | 745 of strings 745 translated |
| Greek | 633 of strings 745 translated |
| Spanish | 729 of strings 745 translated |
| Finnish | 448 of strings 745 translated |
| French | 745 of strings 745 translated |
| Hungarian | 389 of strings 745 translated |
| Italian | 732 of strings 745 translated |
| Japanese | 304 of strings 745 translated |
| Khmer | 273 of strings 745 translated |
| Korean | 744 of strings 745 translated |
| Dutch | 730 of strings 745 translated |
| Polish | 729 of strings 745 translated |
| Portuguese (Brazil) | 676 of strings 745 translated |
| Russian | 560 of strings 745 translated |
| Swedish | 712 of strings 745 translated |
| Turkish | 369 of strings 745 translated |
| Ukrainian | 241 of strings 745 translated |
| Chinese (Simplified, China) | 741 of strings 745 translated |
| Chinese (Traditional, Taiwan) | 732 of strings 745 translated |