Installing on Google Cloud#
ODK Aggregate is no longer being updated. Please use ODK Central instead.
To use this setup, you must able to link a domain name to the machine's IP address. If you don’t own a domain, services such as FreeDNS offer free sub-domains under a range of domains.
Create an instance#
Go to the GCP Dashboard.
Click on Create.
In the Name text box, enter aggregate (or your desired name).
Select the desired region and zone.
Choose a region that's close to the location where data is going to be collected.
Select the instance type you want to use.
A minimum setup is a small instance type (1 vCPU, 1.7 GB of memory), but you should review your requirements and choose a bigger instance type according to your needs.
Click on Change under the Boot disk section.
Select Ubuntu 18.04 LTS.
Set the desired storage size for your VM, and click Select.
A minimum setup is 30 GB of storage, but you should review your requirements and adjust the value of the Size (GiB) field according to your needs.
Under the Firewall section, check Allow HTTP traffic, and Allow HTTPS traffic.
Expand the Management, security, disks, networking, sole tenancy section.
In the Management tab, under Automation, copy the contents of this startup script into the Startup script text box.
In the Networking tab, set the Hostname with the domain name (e.g., your.domain) you want to use for Aggregate. This hostname will be used by the startup script to configure your instance's HTTPS support.
Click on Create.
Set up your domain#
GCP instances use IP addresses which can change if you delete the instance. To ensure your Aggregate install will always be reachable using the same IP address, use a static IP address by following these instructions.
Go to the GCP - VM Instances page and find your instance.
Take note of the IP address (e.g., 126.96.36.199) in the External IP column and set a DNS A record pointing to it.
If you own a domain, check your domain registrar's instructions. If you don't own a domain, we recommend using FreeDNS to get a free sub-domain.
Your domain's TTL setting will affect to how much time you will have to wait until you can proceed to the next step. If your provider gives you the option of setting a TTL, use the lowest value you can.
Open a web browser, and periodically check the domain until you see the Aggregate website. You won't be able to continue the install until you see the website load.
In GCP - VM Instances page, SSH into your VM clicking the SSH button in the External IP column.
Once you are logged in, run sudo certbot run --nginx --non-interactive --agree-tos -m YOUR_EMAIL --redirect -d YOUR_DOMAIN.
Be sure to replace YOUR_EMAIL and YOUR_DOMAIN with your email address and your domain.
Lets Encrypt uses the email you provide to send notifications about expiration of certificates.
Log into Aggregate#
Go to https://your.domain and check that Aggregate is running.
Click Sign in with Aggregate password to login with the default username and password.username:
Change the administrator account's password!