- Additional information about how to administer and develop Refinery can be found in the wiki
- Production deployments require access to Amazon Web Services
- Refinery supports the latest version of Chrome (Linux and OS X), Firefox (Linux and OS X), and Safari (OS X)
Installing and Launching for Development
- Install Git (2.19.0+), Vagrant (2.2.0+) and Virtualbox (5.2.20+)
- Add SSH key to your GitHub account
- Note: this procedure has only been tested on local development machines running OS X 10.10+
Configure and Load Virtual Machine
$ git clone email@example.com:refinery-platform/refinery-platform.git $ cd refinery-platform $ vagrant up
The above step should take about 15 minutes depending on the speed of your machine and Internet connection. If you get an error, simply retry by:
$ vagrant provision
Open http://192.168.50.50:8000/ in your web browser.
Configure Deployment Environment on the Host
Create a Python 2.7 virtual environment (optional but recommended, assumes
virtualenvwrapper is installed):
$ mkvirtualenv -a $(pwd) refinery-deployment
Install deployment tools (assumes header files for Python are installed):
$ pip install -r deployment/requirements.txt
Install Pre-Commit Hooks
fabricrc.sample to update or initialize Fabric configuration, for example:
$ cp fabricrc.sample ~/.fabricrc
To pull the latest code and update Refinery installation:
$ fab vm update
Refinery Operations on the VM
Connect to the initialized VM:
$ vagrant ssh $ workon refinery-platform $ ./manage.py [command]
Log in to Refinery (http://192.168.50.50:8000/) with the default guest user account (username: guest, password: guest).
Log in to Django admin UI (http://192.168.50.50:8000/admin/) with the default superuser account (username: admin, password: refinery).
Please see installation notes for more details, including information on how to configure Galaxy for this setup.
- Refinery deployment requires a lot of external dependencies. You might have to run
vagrant provisionrepeatedly to install all dependencies successfully. Any errors in the output of
vagrant provisionindicate that you have to re-run the command.
- If you run into a build error in OS X when trying to install Fabric:
- If you have a VPN connection running, you may need to disconnect and reconnect before you can access the VM. In some cases you may have to reboot the host machine.
- To make sure all the required services are running after the VM was restarted or shut down, you need to provision again:
vagrant reload --provisionor
vagrant up --provision