Installing the API

...

First, you will need a copy of the source code, which lives in our Github repository:

% git clone https://github.com/ushahidi/platform.git

Once you have the code, the next step is to prepare a web server.

...

By default, there are two options for running the Ushahidi platform locally. You can either run the Vagrant virtual machine, or you can run it locally.

Using the Vagrant virtual machine

To run the virtual machine, install Vagrant following the instructions on their website. You'll need ruby installed too.
Check the settings in the Vagrantfile then start the VM from your console:

% gem install puppet librarian-puppet


% librarian-puppet install


% vagrant up && vagrant provision


This should set up a server, and install all the dependencies too.

Using a local server

System Requirements

To install the platform on your computer/server, the target system must meet the following requirements:

• PHP version 5.4.0 or greater
• MySQL database version 5.5 or greater (PostgreSQL support planned)
• An HTTP server, we develop Ushahidi using Apache 2.2+ and nginx
• Unicode support in the operating system (UTF-8 charset, PCRE, iconv extension, etc)

To create a database, first login to MySQL as root. 

% mysql -u root -p

Next, create a new user and database for Ushahidi. The username and database can be anything; we will use ushahidi for both in this example:

CREATE DATABASE ushahidi;
GRANT ALL ON ushahidi.* to ushahidi@localhost IDENTIFIED BY 'set-a-custom-password-here';
quit; 

Now copy the database.php config file into environments/development/ and edit it. Make sure that the database, username, and password match the database you just created.

% cp application/config/database.php application/config/environments/development/database.php
% $EDITOR application/config/environments/development/database.php 

You should also rename template.htaccess in httpdocs to .htaccess (for Apache) to enable rewriting of all non-existent files to index.php. If you do not want to, or are unable to, enable rewriting, then customize the initialization settings by also copying the init.php config file into environments/development/ and editing it, setting index_file to "index.php"

Enable writing to the logs, cache, and upload directories:

% chmod 0777 application/logs application/cache application/media/uploads

Installing dependencies

We use Composer to manage server side dependencies. Once you have installed composer, you can run the update script with:

% bin/update

Whenever the repository is updated using git pull, run the update script to ensure that your installation stays updated!

If you are updating a production deployment, you will want to avoid installing developer dependencies (testing tools, etc) by using the "deploy" option:

% bin/update --production

Logging in the first time

The default install creates a user admin with password admin. Once logged in this user can create further user accounts or give others admin permissions too.

...

Base config files are in application/config/.

You can add per-environment config overrides in application/config/environments/. The environment is switched based on the KOHANA_ENV environment variable.

Routes are configured in application/routes/default.php. Additional routes can be added in per-environment routing files ie. application/routes/development.php

Installing the client

Getting the code

First, you will need a copy of the source code, which lives in our Github repository:

% git clone https://github.com/ushahidi/platform-client.git

Once you have the code, open up the readme: https://github.com/ushahidi/platform-client/blob/master/README.md and follow the instructions there.

Please check docs.ushahidi.org/install for current install docs