Install Indexing Service on AWS

Introduction

This guide describes how to create an EC2 instance for installing the Indexing services.

You can use our pre-built image or build your own. Let's start with SubQuery's pre-built image.

Method 1. Use SubQuery’s Pre-Built Image in AWS

1.1 Switch Regions

• Log into AWS and switch the region to Asia Pacific (Sydney)

Please note that this is only available in the Asia Pacific (Sydney) region only.

Region	ap-southeast-2 (Sydney)
Node Type	>= t3.medium
AMI	Community AMIs: TBA

1.2 Launch Instance

• Navigate to the EC2 Dashboard and select Launch Instance

1.3 Name Your Instance

• Provide a name for your instance.

1.4 Select SubQuery’s AMI

• Under Application and OS Images, search for SubQuery’s own Community AMI, with an ID of “ami-0ba91a7aa45470a3e“, and select it.

1.5 Select the Instance Size

• Under “Instance type”, select t3.medium or larger.

1.6 Create a Key Pair

• Either select one or create your own new key pair.

1.7 Set Network Settings

• Provide a name for the security setting.
• Edit the Network settings to configure the ports. Add the following ports:
  • port: 8000 & 22 accessible from local IP & anywhere respectively. (NB: this allows you to open the Indexer Admin page in your browser).
  • port: 80 & 443 open to any IP.

For example:

1.8 Configure Storage

• The default Configure storage size should be sufficient but feel free to increase it if required.

1.9 Launch instance

• Next, click on Launch Instance.

1.10 SSH to your EC2 instance

After your EC2 instance has been launched, you need to download the latest docker-compose.yml file. Visit How to SSH into your AWS instance if required and then visit this section to download the latest file.

Important

Please change the default PostgreSQL password in the POSTGRES_PASSWORD field and in the coordinator-service's postgres-password field. Replace it with your own one.

1.11 Update User Group (Optional)

Run:

sudo usermod -aG docker ${USER}

This command adds the current user to the docker group. Now, log out and log back in. This step is optional because you can start the Indexer with sudo.

1.12 Start the Indexer

Run the following command:

sudo docker-compose up -d

1.13 Open Indexer admin

Navigate to your Indexer administration page.

The URL will be http://you-ec2-public-path:8000/.

For example: ec2-14-273-116-26.ap-southeast-2.compute.amazonaws.com:8000.

---

1.14 Next steps

You have successfully set up and started the Indexer service into AWS.

Now, connect your application to MetaMask via: How to Connect to MetaMask

---

Now, let’s see how to create your own Indexer using EC2.

Method 2. Create an Indexer Using Any Standard EC2

• Select AWS Marketplace on the left menu and enter ECS in the search field to get the specific AMI. Then choose the first one, Amazon ECS-Optimized Amazon Linux 2 AMI, and click on the select button.

You’ll need at least 100GB of storage for indexing dictionary projects.

• Now you can choose the instance type. We recommend you to select ≥ t3.medium type to start your journey (or t2 where t3 is not available).

• Select the tab: Configure Security Group on the top of the page. Add the following rules:

Review all the configs

Click the launch button once everything is ready. The last step is to config your key pair, which allows you to access the EC2 instance through SSH.

Click the Launch Instances button then the instance will display in the EC2 console later.

Now, you have successfully set up an Indexer VM on AWS.

Next Step

After setting up the Indexer, you must proceed ahead to connect your application with MetaMask. Visit our guide on How to connect with a MetaMask.