diff --git a/README.md b/README.md index 9236acb..754fb57 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,31 @@ Woodwind A minimum viable stream-style feed reader. 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. + +```bash +git clone https://github.com/kylewm/woodwind.git +cd woodwind +``` + +Set up the virtualenv and install dependencies. + +```bash +virtualenv --python=/usr/bin/python3 venv +pip install -r requirements.txt +``` + +Use the basic SQLite configuration, create database tables and run Woodwind. + +```bash +cp woodwind.cfg.template woodwind.cfg +python init_db.py +uwsgi woodwind-dev.ini +``` + +Now visit localhost:3000, and you should see the login screen! diff --git a/init_db.py b/init_db.py new file mode 100755 index 0000000..caf860e --- /dev/null +++ b/init_db.py @@ -0,0 +1,9 @@ +#!/usr/bin/env python + +from woodwind import create_app +from woodwind.extensions import db + +app = create_app() + +with app.app_context(): + db.create_all() diff --git a/woodwind-dev.ini b/woodwind-dev.ini index 4aec9e2..e3de209 100644 --- a/woodwind-dev.ini +++ b/woodwind-dev.ini @@ -1,8 +1,9 @@ [uwsgi] master=true processes=1 -socket=/tmp/woodwind.sock -chmod-socket=666 +#socket=/tmp/woodwind.sock +#chmod-socket=666 +http-socket=:3000 module=woodwind.wsgi import=timers attach-daemon=rqworker high low diff --git a/woodwind.cfg.template b/woodwind.cfg.template new file mode 100644 index 0000000..9c18155 --- /dev/null +++ b/woodwind.cfg.template @@ -0,0 +1,13 @@ +import os + +DEBUG = True +# do not intercept redirects when using debug toolbar +DEBUG_TB_INTERCEPT_REDIRECTS = False +SECRET_KEY = 'super secret key' + +SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.getcwd() + '/db.sqlite' +PER_PAGE = 100 + +# client secret and key for fetch twitter contexts from granary.appspot.com +TWITTER_AU_KEY = '...' +TWITTER_AU_SECRET = '...'