Installing Aggregate on Google App Engine

Installing Aggregate on Google App Engine

Installing Aggregate on Google App Engine

Warning

This document only applies ODK Aggregate v1.x. See why we are removing App Engine supportfor more information.

Note

There is no charge to set up an Aggregate server on App Engine, and lightly used instances will usually incur no charges.

Before you begin…

  • Make sure the Java 8 JDK or higher is installed on your system.
  • You will need a Gmail account to use App Engine. This Gmail account will be the owner of the Google Cloud Platform project under which your App Engine will execute.
  • You will need to provide a credit card or banking details to verify your identify to the Google Cloud Platform.
  • Read the Google Cloud Platform terms of service.
  • Download the ODK Aggregate installer. Select the latest release for your operating system.
  1. Go to Google Cloud Platform and click on Console in the top right corner.

[+] show screenshot

  1. Sign in with the Gmail/Google account you wish to use.

[+] show screenshot

  1. If you have never configured a Google Cloud Platform project, click on Create an Empty Project.

[+] show screenshot

  1. If you have configured a Google Cloud Platform project before, you may see a listing of all your projects and a button labeled Create Project. Click that button.

[+] show details

  1. Name your project.

[+] show details

  1. After few seconds, you will see a notification in the top right corner of the window. Click on the notification icon and select the notification message Create Project: project-name. An empty project screen will open.

[+] show details

  1. Click on the menu icon (☰) to the left of Google Cloud Platform in the upper left side of the screen, and select App Engine from the dropdown menu.

[+] show screenshot

  1. Open the Select a language menu and select Java.

[+] show details

  1. Select your preferred datacenter location and click Next.

[+] show screenshot

  1. When this completes, you will be directed to begin a tutorial to install a sample application. Choose Cancel Tutorial and confirm that you want to not perform that tutorial.

[+] show screenshot

  1. Launch the ODK Aggregate installer on your computer. (See download info here.)

[+] show details

  1. Accept the license agreement.

[+] show screenshot

  1. Select a parent directory under which an ODK Aggregate directory will be created to contain the configured software. Click on the folder icon to choose a directory.

[+] show screenshot

  1. Select Google App Engine as the platform for the Aggregate server.

[+] show screenshot

  1. Enter a name for your ODK Aggregate instance.

[+] show details

  1. Enter a superuser name in the next window.

[+] show details

  1. Enter the ID of the project you created on the Google Cloud platform.

[+] show details

  1. Enter the Gmail account that you specified when setting up the App Engine project and click the Get Token button.

[+] show details

  1. Copy the code from the browser into the installer's popup dialog and click OK.

[+] show details

  1. If everything went well, you should see a status message letting you know the Action Succeeded.

[+] show details

  1. Click Upload ODK Aggregate.

[+] show details

  1. Finally, you should see the message status : Action Succeeded!.
  2. Once the installer has run and uploaded the ODK Aggregate configuration to App Engine, return to the Google Cloud Platform console.
  3. Open your Aggregate server from your project's screen, by selecting ☰ ‣ App Engine and clicking on the project's URI.

[+] show screenshot

  1. Log In with the superuser username that you specified in the installer (the initial password for this username will be aggregate), and access the site administration screens for your server.

[+] show screenshot

  1. Go to Site Admin -> Permissions to change your password. You can also add additional users.

Download this documentation as a PDF.

If you still need help, you can ask support questions in the ODK Forum

If you find a problem with this documentation, please file an issue

You are also encouraged to fork our Github repo and become a contributor

© Copyright 2017, Open Data Kit. This document is licensed under a Creative Commons Attribution 4.0 International License.

Built with Sphinx using a theme provided by Read the Docs.