Indexing for Storacha Network, Cached And Ready To Go
This is a cache and query node for finding content on Storacha quickly.
Download the indexing service binary from the latest release based on your system architecture, or download and install the indexing-service package using the Go package manager:
$ go install github.com/storacha/indexing-service/cmd@latest
...Deployment of this service to AWS is managed by terraform which you can invoke with make.
First, install OpenTofu e.g.
brew install opentofuYou need to first generate a .env with relevant vars. Copy .env.local to .env and then set the following environment variables:
Best to set this to your name. "prod" and "staging" are reserved for shared deployments.
This is a multibase encoded ed25519 private key used to sign receipts and for the indexer's peer ID. For development, you can generate one by running make ucankey.
This is the DID for this deployment (did:web:... for example). e.g.
TF_VAR_did='did:web:yourname.indexer.storacha.network'This is the public URL of the peer for this deployment. e.g.
TF_VAR_public_url='https://yourname.indexer.storacha.network'Note that these commands will call needed prerequisites -- make apply will essentially do all of these start to finish.
This will simply compile the lambdas locally and put then in the build directory.
You should only need to run this once -- initializes your terraform deployment and workspace. Make sure you've set TF_WORKSPACE first!
This will validate your terraform configuration -- good to run to check errors in any changes you make to terraform configs.
This will plan a deployment, but not execute it -- useful to see ahead what changes will happen when you run the next deployment.
The big kahuna! This will deploy all of your changes, including redeploying lambdas if any of code changes.
Early days PRs are welcome!
This library is dual-licensed under Apache 2.0 and MIT terms.
Copyright 2024. Storacha Network Inc.