FOR ARCHIVAL PURPOSES ONLY

The information in this wiki hasn't been maintained for a good while. Some of the projects described have since been deprecated.

In particular, the "Ushahidi Platform v3.x" section contains information that is often misleading. Many details about this version of Platform have changed since.

This website is an extraction of the original Ushahidi wiki into a static form. Because of that, functions like logging in, commenting or searching will not work.

For more documentation, please refer to https://docs.ushahidi.com

Versions Compared

Old Version 19

changes.mady.by.user Sara-Jayne Terp

Saved on

compared with

New Version Current

changes.mady.by.user Diogo Freire

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Install the required packages
  • Set up a MySQL database
  • Set up Solr
  • Set up Tomcat
  • Create the application directories
  • Build and deploy
  • Create the database tables
  • Set up the UI Client

Install the required packages

The following software packages must be installed on your system:

Install the API

  • Download and extract the API distribution
  • Stop your servlet container
  • Copy the API war to your webapps directory

  • Copy the sample context configuration file - config/swiftriver-api.xml - to <TOMCAT_HOME>/conf/Catalina/localhost and modify the default configuration parameters. The following is an example of the modified file:

    Code Block
    xml
        <Context docBase="" path="/swiftriver-api" >
        <!-- SwiftRiver Database configuration -->
        <Resource auth="Container" driverClassName="com.mysql.jdbc.Driver" 
            maxActive="8" maxIdle="4" 
            name="jdbc/SwiftRiverDB"
            type="javax.sql.DataSource"
            url="jdbc:mysql://localhost/swiftriver?zeroDateTimeBehavior=convertToNull"
            username="swiftriver"
            password="swiftriver"/>
    
        <!-- Encryption Key -->
        <Environment name="encryptionKey" type="java.lang.String" value="2344228477#97{7&amp;6&gt;82"/>
    
        <!-- MQ Properties -->
        <Environment name="mqHost" type="java.lang.String" value="localhost"/>
        <Environment name="mqUser" type="java.lang.String" value="guest"/>
        <Environment name="mqPass" type="java.lang.String" value="guest"/>
        
        <!-- HTTP Solr Server -->
        <Environment name="solr/serverURL" type="java.lang.String" value="http://localhost:8080/solr"/>
    
        <!-- Location of Solr indexing properties file -->
        <Environment name="solr/indexerProperties" type="java.lang.String" value="/Users/ekala/indexer.properties" />
    
        <!-- Keys for the indexer properties file -->
        <Environment name="indexer/lastDropIdPropKey" type="java.lang.String" value="indexer.lastDropId" />
        <Environment name="indexer/batchSizePropKey" type="java.lang.String" value="indexer.batchSize" />
        <Environment name="indexer/runInterval" type="java.lang.String" value="30000"/>

        <!-- Default authentication scheme. Possible values are: 
                database
                crowdmapid
                
            'database' is the default 
        -->
        <Environment name="authSchemeName" type="java.lang.String" value="database"/>
        
        <!-- CrowdmapID API URL e.g. https://example.com/ -->
        <Environment name="crowdmapid/serverURL" type="java.lang.String" value="https://crowdmapid.com/api"/>
        <Environment name="crowdmapid/apiKey" type="java.lang.String" value=""/>
        <Environment name="crowdmapid/apiKeyParamName" type="java.lang.String" value="api_secret"/>

        <!-- Mail configuration -->
        <Environment name="mail/host" type="java.lang.String" value="localhost" />
        <Environment name="mail/senderAddress" type="java.lang.String" value="no-reply@swiftriver.dev"/>
        <Environment name="mail/resetPasswordUrl" type="java.lang.String" value="http://swiftriver.dev/login/reset_password"/>
        <Environment name="mail/activateAccountUrl" type="java.lang.String" value="http://swiftriver.dev/login/activate"/>

      </Context>

     

    An explanation for each of the configuration parameters is provided below:

    ParameterDescription
    mqHostThe host running the RabbitMQ server
    mqUserUser to connect to RabbitMQ
    mqPasswordPasword for the user used to connect to RabbitMQ
    solr/serverURLURL of your Solr server
    solr/indexerPropertiesLocation of the properties file for the indexer - a background process that periodically updates Solr with the new drops
    indexer/lastDropIDPropKeyThe property key that specifies the ID of the last drop to be posted to Solr. This value serves as the reference point for fetching new drops
    indexer/batchSizePropKeyThe property key that specifies the maximum no. of drops to post to Solr during each run
    indexer/runIntervalThe property key that specifies how often (in ms) the indexer should check for new drops and update Solr
    authSchemeNameName of the authentication scheme. The possible values are database and crowdmapid
    crowdmapid/serverURLURL of the CrowdmapID deployment
    crowdmapid/apiKeyAPI key for authenticating requests to the CrowdmapID deployment specified in crowdmapid/serverURL
    crowdmapid/apiKeyParamNameName of the request parameter used to specify the api key when submitting a request to the CrowdmapID deployment
    mail/hostName/IP address of the mail server
    mail/senderAddressEmail address to be used when sending out emails
    mail/resetPasswordUrlURL to be used when sending the password reset link.
    mail/activateAccountUrlURL to be used for sending the account activation link; when a new account is created.

Create the Database

Create a new database called  swiftriver

...

Code Block
sql
mysql swiftriver -u swiftriver -p < install/schema.sql

 

Configure Solr

Copy solr/solr.xml (from the API distribution) to your SOLR_HOME. The default solr.xml file looks like this:

...