From 20689cdd2c40573b7357f1fba6bad875bec38b6d Mon Sep 17 00:00:00 2001 From: fox Date: Fri, 5 Mar 2021 21:31:47 +0300 Subject: Update 'README.md' --- README.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b3c932d..0b885d0 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,10 @@ Requirements * PDO::sqlite * Calibre books directory and metadata.db -Installation -============ +Host installation +================= -Always use latest Git code from master branch. Ignore the releases page, it doesn't mean anything. +Note: Consider using [docker-compose](https://git.tt-rss.org/fox/epube-docker-compose) instead. Most of the stuff below is handled for you automatically then. ```sh git clone https://git.tt-rss.org/fox/the-epube.git the-epube @@ -34,10 +34,10 @@ location /the-epube/db { } ``` -1. Initialize scratch.db +1. Apply database migrations ```sh -sqlite3 db/scratch.db < schema.sql +php ./update.php --update-schema ``` 2. Ensure both scratch.db and its containing folder (i.e. db/) are writable by the @@ -47,19 +47,19 @@ application, normally this means chown-ing them as www-data or what chown www-data db/ db/scratch.db ``` -3. Copy config.php-dist to config.php and edit path to Calibre, etc. +3. Set path to Calibre, etc, in `config.php`: -4. Setup users via useradm.php (command line) +```ini +putenv('EPUBE_BOOKS_DIR=/home/user/calibre/Books'); +``` -Upgrading -========= +See `classes/config.php` for the list of settings. -When upgrading from an older Git snapshot which used HTTP Authentication: +4. Setup users via update.php (command line) -1. Disable HTTP Authentication in httpd configuration -2. Reopen browser to clear HTTP auth -3. Add two new tables to scratch.db (epube_users & epube_sessions) -4. Add users via useradm.php (use same names as http auth, all data will be kept) +``` +php ./update.php --help +``` Acknowledgements ================ @@ -70,4 +70,3 @@ License ======= GNU GPL version 3. - -- cgit v1.2.3