summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorfox <[email protected]>2021-03-05 21:31:47 +0300
committerfox <[email protected]>2021-03-05 21:31:47 +0300
commit20689cdd2c40573b7357f1fba6bad875bec38b6d (patch)
tree32b0a3a1e9e1784b69ac2a0dfcd6a9d412bc4eab /README.md
parent2b8b845abe7c13ecbb266613910484310cffe8e1 (diff)
Update 'README.md'
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files 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 <code>scratch.db</code> and its containing folder (i.e. <code>db/</code>) are writable by the
@@ -47,19 +47,19 @@ application, normally this means chown-ing them as <code>www-data</code> or what
chown www-data db/ db/scratch.db
```
-3. Copy <code>config.php-dist</code> to <code>config.php</code> 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.
-