From 64e833f5d6554029a5d30223d144bb6ba48895ad Mon Sep 17 00:00:00 2001 From: Ozzie Isaacs Date: Sun, 31 Oct 2021 11:56:38 +0100 Subject: [PATCH] Updated readme Version Bump --- README.md | 15 +++++++++------ cps/constants.py | 2 +- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4ebb5cd8..896d4535 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,9 @@ Calibre-Web is a web app providing a clean interface for browsing, reading and d - "Magic Link" login to make it easy to log on eReaders - Login via LDAP, google/github oauth and via proxy authentication -## Quick start +## Installation -#### Install via pip +#### Installation via pip (recommended) 1. Install calibre web via pip with the command `pip install calibreweb` (Depending on your OS and or distro the command could also be `pip3`). 2. Optional features can also be installed via pip, please refer to [this page](https://github.com/janeczku/calibre-web/wiki/Dependencies-in-Calibre-Web-Linux-Windows) for details 3. Calibre-Web can be started afterwards by typing `cps` or `python3 -m cps` @@ -47,18 +47,21 @@ Calibre-Web is a web app providing a clean interface for browsing, reading and d #### Manual installation 1. Install dependencies by running `pip3 install --target vendor -r requirements.txt` (python3.x). Alternativly set up a python virtual environment. 2. Execute the command: `python3 cps.py` (or `nohup 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 `pip install --system --target vendor -r requirements.txt` instead. + +## Quick start + Point your browser to `http://localhost:8083` or `http://localhost:8083/opds` for the OPDS catalog Set `Location of Calibre database` to the path of the folder where your Calibre library (metadata.db) lives, push "submit" button\ Optionally a Google Drive can be used to host the calibre library [-> Using Google Drive integration](https://github.com/janeczku/calibre-web/wiki/Configuration#using-google-drive-integration) Go to Login page -**Default admin login:**\ +#### Default admin login: *Username:* admin\ *Password:* admin123 -**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 `pip install --system --target vendor -r requirements.txt` instead. ## Requirements diff --git a/cps/constants.py b/cps/constants.py index 012d0d39..e37ad900 100644 --- a/cps/constants.py +++ b/cps/constants.py @@ -151,7 +151,7 @@ def selected_roles(dictionary): BookMeta = namedtuple('BookMeta', 'file_path, extension, title, author, cover, description, tags, series, ' 'series_id, languages, publisher') -STABLE_VERSION = {'version': '0.6.14'} +STABLE_VERSION = {'version': '0.6.15 Beta'} NIGHTLY_VERSION = {} NIGHTLY_VERSION[0] = '$Format:%H$'