diff --git a/doc/refstack.md b/doc/refstack.md index a44d272e..1d0973fc 100755 --- a/doc/refstack.md +++ b/doc/refstack.md @@ -1,46 +1,85 @@ Refstack Quickstart =================== -To run refstack for development or to have a gui for running tests behind your firewall. -Git you clonin' +Instruction to run refstack for development or behind your firewall. -`git clone http://github.com/stackforge/refstack` +####Install dependencies (on ubuntu 14.x).. -`cd refstack` +- `sudo apt-get install git python-dev libssl-dev python-setuptools` -Install dependencies (on ubuntu 13.x).. +- `sudo apt-get install mysql-server python-mysqldb` -`apt-get install python-dev` +- `sudo easy_install -U pip` -`apt-get install python-pip` +- `sudo easy_install -U virtualenv` -`easy_install -U setuptools` +####Setup the refstack database -`python setup.py install` +- Log into MySQL: `mysql -u root -p` -`pip install -r test-requirements.txt` +- After authentication, create the database: -Update the "app_address" parameter in the config.json file to the correct address of your refstack server. + `CREATE DATABASE refstack;` -Setup or update the database +- Create a refstack user: -`cd refstack/db/migrations` + `CREATE USER 'refstack'@'localhost' IDENTIFIED BY '';` -NOTE: you are going to have to modify the db connection string in `alembic.ini` to get this working + or using hash value for your password -PROTIP: if you just want to test this out, use `-n alembic_sqlite` to make a local sqlite db + `CREATE USER 'refstack'@'localhost' + IDENTIFIED BY PASSWORD '