refstack/doc/refstack.md
david 14029e5433 small changes to refstack readme
Change-Id: I5547aa2bece59adaf811b518ff82029a09f85e13
2014-03-21 05:17:08 -07:00

45 lines
1.1 KiB
Markdown
Executable File

RefStack Quickstart
===================
To run refstack for development or to have a gui for running tests behind your firewall.
Git you clonin'
`git clone http://github.com/stackforge/refstack`
`cd refstack`
Install dependencies (on ubuntu 13.x)..
`apt-get install python-dev`
`apt-get install python-pip`
`easy_install -U setuptools`
`python setup.py install`
Setup or update the database
NOTE: you are going to have to modify the db connection string in `alembic.ini` to get this working
PROTIP: if you just want to test this out, use `-n alembic_sqlite` to make a local sqlite db
`alembic -n alembic_sqlite upgrade head`
or
`alembic upgrade head` If you've got mysql or another database of choice.
Plug this bad boy into your server infrastructure.
We use nginx and gunicorn, you may use something else if you so desire.
For the most basic setup that you can try right now, just kick off
gunicorn:
`gunicorn -b 0.0.0.0:8000 refstack.web:app`
To actually configure refstack, check out the config section and
crack open refstack.cfg in your preffered editor.
`vim refstack.cfg`
Now browse to http://localhost:8000