refstack/doc/refstack.md
Rob Hirschfeld 950e269233 Docs Refactor
This patch is documentation only.  The changes are not complete and information
in the files should be updated as the progress progresses.  The goal is NOT
to update the files, but to move them into better locations as dicussed in
weekly calls.

The change includes making the root readme more general with links to deeper
documents.  Landing pages for running RefStack and TCUP have been moved to the
/doc directory.

Change-Id: Ifdf4afe0411f92253e0b4cb3ad64a0e6be3bd172
2014-03-22 08:41:34 -05:00

978 B

RefStack Configuration

This is our documentation for how we get this set up::

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 are smarter

than we are.

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 this winner, check out the config section and

crack open refstack.cfg in vim.

vim refstack.cfg

Now browse to http://localhost:8000