refstack/doc/refstack.md
david c39e522f39 actually fixed the refstack doc page.
Change-Id: I59beb6c09c6e78cec6ae99dae409d13d8d547141
2014-03-19 11:16:28 -07:00

32 lines
922 B
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`
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`
`alembic upgrade head`
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