summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndrew Dolgov <[email protected]>2017-03-28 13:44:00 +0300
committerAndrew Dolgov <[email protected]>2017-03-28 13:44:00 +0300
commitb6a63f45567518f014fe6e7043341042c304780e (patch)
tree8cd5296b7869221e2e7085220d01f287597b0e4f /README.md
parent70b0efc94801a67b6ac165d4f1ca02533dc8863f (diff)
add basic installation info
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index c2f906e..e7ffe15 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,22 @@ web EPUB reader using EPUB.js, Bootstrap, and Calibre.
* supports word definition lookups using dictd
* supports Chrome homescreen "app mode"
+Installation
+============
+
+1. Initialize scratch.db
+
+ <pre>sqlite3 db/scratch.db &lt; schema.sql</pre>
+
+2. Ensure both <code>scratch.db</code> and its containing folder (i.e. <code>db/</code>) are writable by the
+application, normally this means chown-ing them as <code>www-data</code> or whatever user your httpd is running under.
+
+ <pre>chown www-data db/ db/sratch.db</pre>
+
+3. Copy <code>config.php-dist</code> to <code>config.php</code> and edit path to Calibre, etc.
+
+4. Setup HTTP Basic authentication for epube directories. This is required, even if you're the only user.
+
Discussion
==========