Installation

Supported Platforms

Peloton is known to work on the following platforms. Please note that it will not compile on 32-bit systems.

• Ubuntu Linux 14.04+ (64-bit)
• Mac OS X 10.9+ (64-bit)

Ubuntu Quick Setup

1. Install the packages in the package list using this script.

sudo bash ./script/installation/packages.sh

2. Now, go to the Build Peloton step.

OSX/Windows Quick Setup

1. Install Virtualbox and Vagrant (if needed).

   [Virtualbox Download](https://www.virtualbox.org/wiki/Downloads)  
   [Vagrant Download](https://www.vagrantup.com/downloads.html)  
   [Getting Started with Vagrant on OSX Yosemite](http://coolestguidesontheplanet.com/getting-started-vagrant-os-osx-10-9-mavericks)   
   [Getting Started with Vagrant on Windows](http://www.sitepoint.com/getting-started-vagrant-windows/)
   

2. Copy over the Peloton Vagrant file to the location where you would like to setup Vagrant.

cd ~/git/
wget https://raw.githubusercontent.com/cmu-db/peloton/master/script/installation/Vagrantfile

3. Boot the vagrant box

vagrant up

4. Connect to the vagrant box

vagrant ssh

5. Now, go to the Build Peloton step.

Vagrant Reload

In case you wish to reload the virtual machine so that any changes made in the Vagrantfile take effect, use this command:

vagrant reload --provision

Build Peloton

Before building peloton, make sure that you have installed all its software dependencies by following the instructions given above in Ubuntu Quick Setup or OSX/Windows Quick Setup depending on your machine.

Enter the build directory and run cmake

mkdir -p build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..  

If your system reports error then please try the following alternative instead (it is caused by code coverage not being supported under release mode):

cmake -DCMAKE_BUILD_TYPE=Release -DCOVERALL=False ..

For building a debug mode binary, please run the following command:

cmake -DCMAKE_BUILD_TYPE=Debug .. 

Build and install Peloton

make -j4
make install

Update paths in .bashrc or .zshrc or your favorite shell's startup file :

export PATH=$(BUILD_DIR)/bin:$PATH
export LD_LIBRARY_PATH=$(BUILD_DIR)/lib:$LD_LIBRARY_PATH