Rapidpro Installation

From IHRIS Wiki
Revision as of 08:25, 21 August 2019 by Sovello (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Introduction and Overview

RapidPro is an Open Source platform that allows anyone to build interactive messaging systems using an easy visual interface. A video is worth a thousand words and this brief video introduction will give you an idea of what is possible.

Installation

To install Rapidpro,follow the following steps

  1. Prerequisites Installation
    • PostgreSQL 9.3 or later along with the PostGIS extensions. You may refer to Django’s installation instructions to help get this working or you may just run below commands:
      • Postgresql and postgis installation <source lang="bash"> $ sudo apt-get install postgresql $ sudo apt-get install postgis $ sudo apt-get install postgresql-X.Y-postgis-2.1 #replace X.Y with the version number of postgresql </source>
    • Redis 2.8 or later installed and listening on localhost. By default the development server uses database 15. You may install this through debian package manager <source lang="bash">$ sudo apt-get install redis-server</source> or by downloading it on redis website
    • lessc, the Less compiler. <source lang="bash"> $ apt-get install npm $ npm install -g less </source>
    • coffee, the Coffee script compiler. You may also install this with <source lang="bash"> $ sudo apt-get install coffeescript </source>
  2. Create Temba User For PostgreSQL <source lang="bash"> $ sudo -u postgres createuser temba --superuser --pwprompt -d $ sudo adduser temba </source>
  3. Create temba database, add PostGIS <source lang="bash"> Create the database as temba user: $ sudo -u temba psql --user=temba postgres postgres=> create database temba; CREATE DATABASE \q </source> Now connect as superuser that can install extensions <source lang="bash"> $ sudo apt-get install postgresql-contrib-X.Y #replace X.Y with version number i.e 9.3 $ sudo -u temba psql --user=temba postgres $ postgres=# \c temba $ You are now connected to database "temba" as user "psql". $ temba=# create extension postgis; $ CREATE EXTENSION $ temba=# create extension postgis_topology; $ CREATE EXTENSION $ temba=# create extension hstore; $ CREATE EXTENSION </source>
  4. Clone Rapidpro
    Now clone the RapidPro repository and link up the development settings: <source lang="bash"> $ git clone git@github.com:rapidpro/rapidpro.git $ cd rapidpro $ ln -s temba/settings.py.dev temba/settings.py </source> NB:open the file temba/settings.py to make sure that it was created,if its missing or empty,do this <source lang="bash"> $ cp temba/settings.py.dev temba/settings.py </source> NB:You will need to confirm if the database name,user and password in the settings.py matches the one created during postgresql installation,the following is the default database name,database user and password inside temba/settings.py <source lang="bash"> DATABASES = { 'default': { 'ENGINE': 'django.contrib.gis.db.backends.postgis', 'NAME': 'temba', 'USER': 'temba', 'PASSWORD': 'temba', 'HOST': 'localhost', 'PORT': , 'ATOMIC_REQUESTS': True, 'OPTIONS': { } } } </source>
  5. Build Virtual Environment
    You should always use a virtual environment to run your RapidPro installation. The pinned dependencies for RapidPro can be found in pip-freeze.txt. You can build the needed environment as follows (from the root rapidpro directory): <source lang="bash"> $ sudo apt-get install python-virtualenv postgresql-server-dev-9.3 python-dev ncurses-dev $ cd /path/to/your/root/directory/of/rapidpro $ virtualenv env $ source env/bin/activate (env)$ pip install -r pip-freeze.txt </source>
  6. Sync your database
    You should now be able to run all the migrations and initialize your development server. This takes a little while on RapidPro as syncdb also creates and initializes all the user groups and permissions. <source lang="bash"> (env)$ python manage.py syncdb </source>
  7. If you want to create a super user,run this command while the env is still activated <source lang="bash"> (env)$ python manage.py createsuperuser </source>
  8. Run development server
    At this point you’ll be able to run the development server and run RapidPro. It will be available at http://localhost:8000 or you may specify a different port number if you wish to change the default port number. <source lang="bash"> (env)$ python manage.py runserver 0.0.0.0:8000 </source>
  9. Credits allocation to user accounts
    There are some features that by default are disabled until an account get allocated some credits by the administrator.E.g An account can not invite users to join unless that account has been allocated atleast 100,000 credits,similarly the workflow import feature is disabled until an account get allocated some credits.
    To allocate credits to an account login to Rapidpro as an administrator,you will be taken directly to an account/Organization management window,click the organization name as below: RapidPro Organization Management.png

    Then Click the TopUps button as in the picture below: RapidPro Topup Button.png

    Click the Add TopUps button as in the picture below: RapidPro topup2.png