Merge pull request #55 from kylewm/fix-readme

Fix readme

README.md

@@ -10,8 +10,8 @@ Supports mf2 h-feed and xml feeds (thanks to Universal Feed Parser).
 Installation
 ----------
 
-How to run your own instance of Woodwind. The default configuration
-uses SQLite, so no database setup is necessary.
+How to run your own instance of Woodwind. You'll first need to make
+sure you have *Postgres* and *Redis* installed and running.
 
 ```bash
 git clone https://github.com/kylewm/woodwind.git
@@ -22,14 +22,24 @@ Set up the virtualenv and install dependencies.
 
 ```bash
 virtualenv --python=/usr/bin/python3 venv
+source venv/bin/activate
 pip install -r requirements.txt
 ```
 
-Use the basic SQLite configuration, create database tables and run Woodwind.
+Copy woodwind.cfg.template to woodwind.cfg and edit it to check the
+Postgres connection string.
+
+Then create database tables and run Woodwind.
 
 ```bash
+# create the postgres database
+createdb woodwind
+# copy and edit the configuration file
 cp woodwind.cfg.template woodwind.cfg
+nano woodwind.cfg
+# create the database tables
 python init_db.py
+# finally run the application
 uwsgi woodwind-dev.ini
 ```
 

log.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+REMOTE_USER=kmahan
+HOST=orin.kylewm.com
+
+ssh -t $REMOTE_USER@$HOST bash -c "'
+
+set -x
+
+sudo tail -n 60 -f /var/log/upstart/woodwind.log
+'"

woodwind-dev.ini

@@ -1,9 +1,9 @@
 [uwsgi]
 master=true
 processes=1
-socket=/tmp/woodwind.sock
-chmod-socket=666
-#http-socket=:3000
+#socket=/tmp/woodwind.sock
+#chmod-socket=666
+http-socket=:3000
 module=woodwind.wsgi
 import=timers
 attach-daemon=rqworker high low

woodwind.cfg.template

@@ -5,9 +5,11 @@ DEBUG = True
 DEBUG_TB_INTERCEPT_REDIRECTS = False
 SECRET_KEY = 'super secret key'
 
-SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.getcwd() + '/db.sqlite'
+SQLALCHEMY_DATABASE_URI = 'postgres:///woodwind'
 PER_PAGE = 100
 
 # client secret and key for fetch twitter contexts from granary.appspot.com
 TWITTER_AU_KEY = '...'
 TWITTER_AU_SECRET = '...'
+
+SQLALCHEMY_TRACK_MODIFICATIONS = False