Skip to content
This repository has been archived by the owner on May 25, 2023. It is now read-only.

Latest commit

 

History

History
212 lines (133 loc) · 12.3 KB

README.md

File metadata and controls

212 lines (133 loc) · 12.3 KB
Raw

ODK Aggregate

Platform License Build status Slack status

ODK Aggregate provides a ready-to-deploy server and data repository to:

  • provide blank forms to ODK Collect (or other OpenRosa clients),
  • accept finalized forms (submissions) from ODK Collect and manage collected data,
  • visualize the collected data using maps and simple graphs,
  • export data (e.g., as CSV files for spreadsheets, or as KML files for Google Earth), and
  • publish data to external systems (e.g., Google Spreadsheets or Google Fusion Tables).

ODK Aggregate can be deployed on Google's App Engine, enabling users to quickly get running without facing the complexities of setting up their own scalable web service. ODK Aggregate can also be deployed locally on a Tomcat server (or any servlet 2.5-compatible (or higher) web container) backed with a MySQL or PostgreSQL database server.

Getting the code

  1. Fork the Aggregate project (why and how to fork)

  2. Install Git LFS

  3. Clone your fork of the project locally. At the command line:

     git clone https://github.com/YOUR-GITHUB-USERNAME/aggregate

Setting up the database

Aggregate supports a variety of DBs, but we strongly recommend you use PostgreSQL first to ensure everything is working. If you wish to use another DB (e.g., Google App Engine, MySQL, or SQLServer databases) after that see database configurations.

PostgreSQL with Docker

  1. Install Docker and Docker Compose

  2. To start the development server run the gradle task postgresqlComposeUp with the command: ./gradlew postgresqlComposeUp

    • Make sure port 5432 is not used by any other service in your computer. You can change this editing the ports section of the db/postgresql/docker-compose.yml configuration file. Be sure to check the documentation: Compose file version 3 reference - Ports section.

  3. To stop the server run the gradle task postgresqlComposeDown with the command: ./gradlew postgresqlComposeDown.

Alternatively, you can use the docker-compose command line tool to start & stop the development server. All configuration files regarding the development server are at db/postgresql path. Check the online documentation.

Local PostgreSQL server

  1. Download and install PostgreSQL 9 or later.

    • If you are a macOS user, we recommend Postgres.app. If you are a Windows user, we recommend BigSQL.

  2. In the command-line interface connect to the database. Assuming the user is postgres and the server is installed on your local machine, the command will be: psql -U postgres -h localhost.

  3. Setup your database with these commands. You must use psql or the \connect command will not work.

    CREATE USER "odk_unit" WITH PASSWORD 'test';
CREATE DATABASE odk_db WITH OWNER odk_unit;
GRANT ALL PRIVILEGES ON DATABASE odk_db TO odk_unit;
\connect odk_db;
CREATE SCHEMA odk_db;
GRANT ALL PRIVILEGES ON SCHEMA odk_db TO odk_unit;

Running the project

Aggregate is built using Gradle and Gretty, but we strongly recommend you use IntelliJ IDEA first to ensure everything is working. If you wish to use another development environment after that, run ./gradlew tasks to get a sense of your options.

Import

  1. On the welcome screen, click Import Project, navigate to your aggregate folder, and select the build.gradle file.

  2. Make sure you check Use auto-import option in the Import Project from Gradle dialog

  3. Once the project is imported, IntelliJ may ask you configure any detected GWT, Spring or web Facets, you can ignore these messages

Configure

  1. If you are running Java 9, make sure you also have Java 8 installed. Aggregate will not compile with Java 9.

  2. Copy gradle.properties.example to a gradle.properties file at the root of the project and fill in your setup configuration

    Key Valid values Description
    warMode complete or installer Use installer if you are going to produce an installer with the resulting WAR artifact and complete otherwise
    aggregateInstanceName Only required for GAE deployment. The name of your instance. It's important that this value doesn't change for an already existing Aggregate instance
    aggregateUsername Only required for GAE deployment. The username of the Aggregate superuser
    gaeAppId Only required for GAE deployment. The Google AppEngine project Id
    gaeEmail Only required for GAE deployment. The email account of the owner of the Google AppEngine instance
    org.gradle.java.home Set path to a Java 8 install. This is only required if you have Java 9 installed.
    • Any property can be overwritten by passing -Pkey=value arguments to any Gradle task.

Run

  1. In the Run menu, select Edit Configurations...

  2. Press the + button to add a Gradle configuration

    • Name: appStartWar (or whatever you'd like)
    • Gradle project: odk-aggregate
    • Tasks: appStartWar

  3. Press OK

  4. To run Aggregate, go to the Run menu, then to Run... and Run the appStartWar configuration. This will start Aggregate.

  5. You should now be able to browse http://localhost:8080

Run the tests

  1. Copy one of the example jdbc.properties.example_* and odk-settings.xml.example_* files on src/test/resources/ into the same place removing the .example_* extension. Choose the variant corresponding to your test database engine.

  2. Make sure your jdbc settings are correct. The examples use the default database name, user and password settings.

  3. Right click on the src/test/java folder on IntelliJ and select Run all Tests option.

Debug

  1. In the Run menu, select Edit Configurations...

  2. Press the + button to add a Gradle configuration

    • Name: appStartWarDebug (or whatever you'd like)
    • Gradle project: odk-aggregate
    • Tasks: appStartWarDebug

  3. Press Apply and then press the + button to add a Remote configuration

    • Name: appServer (or whatever you'd like)
    • Host: localhost
    • Port: 5005
    • Search sources using module's classpath: aggregate

  4. Press OK

  5. To debug Aggregate, go to the Run menu, then to Run... and Run (not Debug!) the appStartWarDebug configuration. This will start Aggregate in debug mode and wait for a debugging session to be connected to the server's debugging listener.

  6. Now, go to the Run menu, then to Run... and Debug the appServer. This will connect the debugger.

  7. You should now be able to browse http://localhost:8080 and debug

Connect from an external device

By default, Gretty will launch a server using a localhost address which will not be accessible by external devices (e.g., ODK Collect in an emulator, ODK Briefcase on another computer). To set a non-localhost address, edit the following files:

  • In src/main/resources/security.properties, change security.server.hostname to the address
  • In build.gradle, inside the gretty block, change host to the same address

Deploy to Google App Engine

  1. Follow part of the official instructions for Installing on App Engine (Cloud). Stop after Google configures the server, and before the tutorial.

  2. Press the + button to add a Gradle configuration

    • Name: gaeUpdate (or whatever you'd like)
    • Gradle project: odk-aggregate
    • Tasks: gaeUpdate

  3. Press OK

  4. Edit gradle.properties file at the root of the project and set its values according to your Google App Engine instance:

    Key Default Description
    warMode complete WAR build mode. Leave set to complete for GAE deployments
    aggregateInstanceName aggregate ODK Aggregate instance name. Set this value to whatever is already set in the currently running Aggregate instance. Any changes to this will invalidate all the ODK Aggregate passwords
    aggregateUsername administrator ODK Aggregate administrator name
    gaeAppId aggregate App Engine project ID
    gaeEmail [email protected] Your Google Cloud account's email address
    • Alternatively, you can overwrite these properties by adding -Pkey=value arguments to your Gradle task invocations

  5. Authenticate yourself using one of the following methods described in How the Application Default Credentials Work guide of Google Cloud Platform.

    • We recommend the option of installing Google Cloud SDK and running the command gcloud auth application-default login.
    • Any other option will require adjustments in the Run configuration for gaeUpdate

  6. To run Aggregate, go to the Run menu, then to Run... and Run the gaeUpdate configuration. This will compile Aggregate and upload it to App Engine, replacing your running instance with the new version.

This process can fail sometimes. If that happens, you will have to manually rollback the failed update launching the gaeRollback task. You can follow these same steps to create a new Run Configuration for it.

Extended topics

There is a /docs directory in the repo with more documentation files that expand on certain topics:

Contributing

Any and all contributions to the project are welcome. ODK Aggregate is used across the world primarily by organizations with a social purpose so you can have real impact!

If you're ready to contribute code, see the contribution guide.

The best way to help us test is to build from source! We are currently focusing on stabilizing the build process.

Troubleshooting

  • We enabled Git LFS on the Aggregate codebase and reduced the repo size from 700 MB to 34 MB. No code was changed, but if you cloned before December 11th, 2017, you'll need to reclone the project.

  • If you get an Invalid Gradle JDK configuration found error importing the code, you might not have set the JAVA_HOME environment variable. Try these solutions.

  • If you are having problems with hung Tomcat/Jetty processes, try running the appStop Gradle task to stop running all instances.

  • If you're using Chrome and are seeing blank pages or refreshing not working, connect to Aggregate with the dev tools window open. Then in the Network tab, check Disable cache.