aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 26 insertions, 2 deletions
diff --git a/README b/README
index cef6721..e1db59f 100644
--- a/README
+++ b/README
@@ -6,14 +6,38 @@ iOS podcast app: https://demo.jordan.im/audiobook-rss/apple-podcasts.png
installation
------------
-a) copy and populate app.cfg and uwsgi.ini (if using UWSGI)
+a) copy and populate app.cfg and uwsgi.ini from examples
-b) create venv, install flask and uwsgi
+ $ cp app.cfg.example app.cfg
+ $ cp uwsgi.ini.example uwsgi.ini
+ $ cat app.cfg
+
+ ROOT_PATH = '/path/to/audiobooks'
+ USERNAME = 'username'
+ PASSWORD = 'password'
+
+ $ cat uwsgi.ini
+
+ [uwsgi]
+ http = 127.0.0.1:8085
+ processes = 2
+ threads = 4
+ wsgi-file = run.py
+ callable = app
+ master = true
+
+b) install python dependencies flask and uwsgi
+
+ $ pip install --user flask uwsgi
c) execute rebuild.py to populate audiobook JSON cache
+ $ ./rebuild.py
+
d) execute uwsgi.sh to start the server
+ $ ./uwsgi.sh
+
design decisions
----------------