jeena/woodwind
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

fix the woefully outdated requirements and installation instructions

Browse source 
fixes #53
fixes #54

Thanks for the heads up @Jeena (I guess I hadn't looked at the readme in
about a year...) and sorry it was a pain to get running!
This commit is contained in:
Kyle Mahan 2016-05-21 08:00:09 -07:00
parent 0a4dd14189
commit c8f7213b39
3 changed files with 19 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

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

6
woodwind-dev.ini
View file

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

4
woodwind.cfg.template
View file

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