Skip to content

Commit

Permalink
Merge pull request #551 from subquery/user-manage-project
Browse files Browse the repository at this point in the history
docs: add user managed project
  • Loading branch information
jamesbayly committed Aug 5, 2024
2 parents 52195ed + 5469e24 commit 5896d58
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 23 additions & 2 deletions docs/subquery_network/node_operators/indexers/index-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,37 @@ Enter the project deployment ID when adding the new project.

![Add a New Project Using Deploy ID](/assets/img/network/indexer_project_add.png)

After confirming the project details, press Next to configure the project
When a project is successfully added, the following default Flex plan will be automatically created:

| item | default value |
| ----------------------- | :-------------------- |
| price | 1.0 SQT/1000 reqeusts |
| maximum validity period | 14 days |

After confirming the project details, press Next to configure the project.

## 2. Configure Project

You will need to provide an indexing endpoint, this endpoint must be a non-pruned archive node. Public nodes may be rate limited, which can affect indexing speed. **When indexing your project we suggest getting a private API key to avoid being rate limited.**
There are two different approaches to hosting your SubQuery Indexing SDK project. System Managed, and User Managed

### System Managed

This is the default way where the SubQuery indexer service will manage the running and deployment of a SubQuery project on the same VM using Docker.

When deploying a System Managed project you will need to provide an indexing endpoint, this endpoint must be a non-pruned archive node. Public nodes may be rate limited, which can affect indexing speed. **When indexing your project we suggest getting a private API key to avoid being rate limited.**

Public RPC Endpoints may be rate limited which can affect indexing speed, when indexing your project we suggest getting a private API key. You can retrieve endpoints for some networks for free from SubQuery Network itself.

Select the Indexer Version and Query Version (latest recommended)

### User Managed

For user managed project you run your own SubQuery Indexer on a different VM. This can give you more flexibility on how you run the project and how your manage the database connected to the project.

You need to provide the IP addresses for the Node endpoint and the query endpoint, and ensure that the services can be connected to and are functioning properly.

![User Managed Project](/assets/img/network/indexer_user_managed_project.png)

Then press `Start` to start the node and query service for this project in the coordinator service.

Once the services are started, the service information will be displayed such as the Indexer Service and Query Endpoint status, and the Indexing Status. The Node Operator can then check the service log to see the indexing details:
Expand Down

0 comments on commit 5896d58

Please sign in to comment.