rafaeldelucena/waterbutler

<img src=/docs/waterbutler.png?raw=true" width="25%" style="float:left;">

WaterButler

master Build Status:

develop Build Status:

Docs can be found here

osf startup commands

invoke server

startup commands

In order to run waterbutler, you must have a virtualenv created for waterbutler running python3.3 or higher. This can be created with the following commands:

# MacOSX: Install the latest version of python3
brew install python3 
pip install virtualenv 
pip install virtualenvwrapper 
mkvirtualenv --python=python3 waterbutler
pip install -U -r requirements.txt
python setup.py develop
invoke server

The above code will get the virtualenv up and running for the first time. After the initial setup, you can run waterbutler by running:

workon waterbutler
invoke server

testing configuration (optional)

vim ~/.cos/waterbutler-test.json

waterbutler-test.json, e.g.

{
  "OSFSTORAGE_PROVIDER_CONFIG": {
    "HMAC_SECRET": "changeme"
  },
  "SERVER_CONFIG": {
    "ADDRESS": "127.0.0.1",
    "PORT": 7777,
    "DEBUG": true,
    "HMAC_SECRET": "changeme",
  },
  "OSF_AUTH_CONFIG": {
      "API_URL": "http://127.0.0.1:5000/api/v1/files/auth/"
  }
}