Skip to content

Installation

The following guide explains how to download and install and instance of LibCrowds locally, for testing or development. If you are interested in deploying LibCrowds to a live server, see the Deployment guide.

Install VirtualBox, Vagrant and git

The easiest way to get instances of LibCrowds and PYBOSSA up and running is by using VirtualBox and Vagrant.

We will also need to install git, which is the version control system via which both LibCrowds and PYBOSSA are distributed.

Follow the following links to download and run the appropriate installers for your operating system.

  1. git
  2. VirtualBox
  3. Vagrant

Download and run PYBOSSA

Once the above software is succesfully installed, open up a terminal and clone PYBOSSA to your local machine:

git clone --recursive https://github.com/Scifabric/pybossa.git

Setup the PYBOSSA development environment:

cd pybossa
vagrant up

Run the PYBOSSA server:

vagrant ssh
python run.py

PYBOSSA (with the default theme) should now be available at http://127.0.0.1:5000

Installing behind a web proxy

If you're installing from behind a web proxy then you will probably run into issues when attempting to start Vagrant, in which case you can try running these commands from the pybossa directory:

# set environment variables using the command for your OS (Windows example shown)
set VAGRANT_HTTP_PROXY=http://username:password@proxy_server:proxy_port
set VAGRANT_HTTPS_PROXY=https://username:password@proxy_server:proxy_port

# install the vagrant-proxyconf plugin
vagrant plugin install vagrant-proxyconf

Download and run LibCrowds

The same process is followed to setup the LibCrowds development environment:

git clone https://github.com/LibCrowds/libcrowds.git

Setup the LibCrowds development environment:

cd pybossa
vagrant up

Run the LibCrowds server:

vagrant ssh
npm run dev
Installing behind a web proxy

If you're installing from behind a web proxy then you will probably run into issues when attempting to start Vagrant, in which case you can try running these commands from the libcrowds directory:

# set environment variables using the command for your OS (Windows example shown)
set VAGRANT_HTTP_PROXY=http://username:password@proxy_server:proxy_port
set VAGRANT_HTTPS_PROXY=https://username:password@proxy_server:proxy_port

# install the vagrant-proxyconf plugin
vagrant plugin install vagrant-proxyconf

LibCrowds should now be running using the default settings at http://127.0.0.1:8080.

However, if you open it up now you are likely to see an error message as the two servers have not yet been configured to communicate properly with each other.

The next step is Configuring PYBOSSA.