-
Notifications
You must be signed in to change notification settings - Fork 123
Detailed Set Up Instructions
- libssl development library (libssl-dev in Ubuntu)
- curl
- git
- node (v0.4.9)
- npm (v1.0+)
- MongoDB (v1.8+)
During installation, if you have any problems, come ask us in IRC, take a look at the troubleshooting page. If you solve any problems for yourself, please add your learnings!
If you haven't used node or mongo before, it's worth getting everything in place before cloning the repo:
It's easiest to just download the tarball. If you choose to build it from the github repo, you will need to checkout a tagged version v0.4.6 - v0.4.9.
Once it's downloaded:
#from the extracted directory
./configure
#make will take a few minutes
make
make install
This will build node from source and install it, adding it to your PATH. To ensure that it worked:
node -v
v0.4.9
You will need gcc and libssl-dev, but those should already be present on most systems. On linux systems, apt-get installation has caused problems for some folks (it can leave out node-waf, which causes issues installing modules later), so building from the tarball is the recommended method.
npm has very thorough installation instructions at https://github.com/isaacs/npm#readme. Note, node must be installed BEFORE npm.
Mongo has comprehensive installation instructions at http://www.mongodb.org/display/DOCS/Quickstart
Once you have it installed, ensure that it is in your PATH:
mongod --version
db version v1.8.1, pdfile version 4.5
The version number just needs to be 1.4 or greater (however, we only test with 1.8+, so if you are on an old version, you might consider updating)
If not, you can add the following line to your ~/.profile file:
export PATH=$PATH:/path/to/mongo/bin
Many systems will already have setuptools installed, but if your doesn't, it can be found (along with installation instructions) here
If (you think) you've got everything all set:
git clone https://github.com/LockerProject/Locker.git
cd Locker
./checkEnv.sh
you should see something like:
Python version 2.7 found.
Node.js version 0.4.9 found.
npm version 1.0.14 found.
mongoDB version 1.8.2 found.
Your version numbers may vary slightly, but so long as you don't see any red text, you are all set. (At this point, the vows check has been disabled.) If vows gives an error:
sudo npm install -g vows
Then you can install all of Locker's node dependencies:
#from the Locker root directory
npm install
At this point you should be all set (famous last words). Next, run the tests:
cd tests
node runTests.js
On a good day, all these tests will pass, resulting in something like:
✓ OK » 222 honored (56.306s)
If, only a few fail, but it gets through the whole run, then chances are someone just broke something with a late night commit the previous evening. :).