SubQuery Academy (Documentation)

Install Indexing Service Locally

Introduction

If you are a beginner, installing the Indexing service locally via Docker is preferred.

Docker is used to make the installation process as simple as possible as it maintains consistency and integrity.

The process includes obtaining the docker-compose.yml file and then starting the container. This can be done in 2 ways:

  1. On your own computer or “localhost”
  2. On a cloud provider such as AWS

Now, let's explore how to run the Indexing Service Locally step-by-step.

Initial Preparation

Step 1 - Clone the Indexing Service Repo

  • Clone the indexing services repository to your local machine. This repository contains a docker-compose.yml file, which consists of all the images to build and start the various applications.
mkdir kepler
cd kepler
curl https://raw.githubusercontent.com/subquery/indexer-services/develop/docker-compose.yml -o docker-compose.yml

Important

DO NOT skip checking the indexer version after you finish the installation process. Visit this section to check the latest indexer version is used and to to complete the set up process.

Also, please change the default PostgreSQL password in the POSTGRES_PASSWORD field and in the coordinator-service's postgres-password field in the docker-compose.yml file.

Step 2 - Start the Indexing Service

Run the following command to start the Indexing service:

docker-compose up -d

Please check that the Docker is already running. The images will be pulled from Docker and then it will start the following services:

  • coordinator_db
  • coordinator_service
  • coordinator_proxy
  • proxy-redis

docker compose-up command line

docker compose-up cli result

Step 3 - Open the Indexer Admin Page

Open http://localhost:8000/ in your browser and you will get to see:

Indexer Admin Page - Asking to Connect with Metatask

Next Steps

You have successfully installed the Indexing service locally. The next step is to connect your application with MetaMask.

Head to How to Connect to MetaMask guide.

Tip

Having trouble running a command or setting up the service? Got stuck in the process? Find your solutions here.