Install Indexing Service With Separated Database

If you want to use a separated database for the Indexing service, you can follow this guide to set up the database and install the Indexing service.

Initial Preparation

• Docker - It contains all the required images to run the entire Web3 application.

Setup Database

Install PostgreSQL With Docker Compose

• Create a docker-compose.yml file with the following content:

version: '3'

services:
  postgres:
    image: postgres:16-alpine
    container_name: indexer_db
    restart: always
    ports:
      - 5432:5432
    volumes:
      - .data/postgres:/var/lib/postgresql/data
    environment:
      POSTGRES_PASSWORD: <replace with you own password>
    healthcheck:
      test: ['CMD-SHELL', 'pg_isready -U postgres']
      interval: 5s
      timeout: 5s
      retries: 5

• Run the following command to start the PostgreSQL service:

docker compose up -d

Datebase Safety

Install and setup your firewall to only allow connections from the IP address of the machine running the Indexing service.

sudo ufw allow from <IP address of the machine running the Indexing service> to any port 5432

Install Indexer Service

Step 1 - Download the Indexer Service file

• Donwloand indexing services docker-compose.yml file to you machine, which consists of all the images to build and start the various applications.

mkdir subquery-indexer && cd subquery-indexer
curl https://raw.githubusercontent.com/subquery/network-indexer-services/main/deploy/docker-compose.yml -o docker-compose.yml

# extra steps to use local ipfs node
mkdir ipfs
curl https://raw.githubusercontent.com/subquery/network-indexer-services/main/deploy/ipfs/ipfs.sh -o ipfs/ipfs.sh
chmod +x ipfs/ipfs.sh

Step 2 - Update the Indexer Service file with Separated Database Information

• Update the docker-compose.yml file with the database information.

# 1. remove or commment the postgres section
  # postgres:
  #   image: postgres:16-alpine
  #   container_name: indexer_db
  #   ...

# 2. update the following fields in coordinator section
- --postgres-host=<replace with your database host>
- --postgres-password=<replace with your database password>

Step 3 - Start the Indexing Service

Run the following command to start the Indexing service:

docker compose up -d

Tip

For extra information about starting the Indexing service, please visit from this section.