The first place to go in order to find a CID stored in Filecoin
This repo provides an indexer implementation that can be used to index data stored by a range of participating storage providers.
A design discussion of the ingestion interfaces exposed by store the index is here.
This implementation is entered production. A first production instance is running at https://cid.contact
This assumes go is already installed.
Install storetheindex:
go get github.com/filecoin-project/storetheindex
Initialize the storetheindex repository and configuration:
storetheindex init
To run storetheindex as a service, run the daemon
command. The service watches for providers to index, and exposes a query / content routing client interface.
The daemon is configured by the config file in the storetheindex repository. The config file and repo are created when storetheindex is initialized, using the init
command. This repo is located in the local file system. By default, the repo is located at ~/.storetheindex. To change the repo location, set the $STORETHEINDEX_PATH
environmental variable.
There are a number of client commands included with storetheindex. Their purpose is to perform simple indexing and lookup actions against a running daemon. These can be helpful to test that an indexer is working. These include the following commands:
find
Find value by multihash in indexerimport
Imports data to indexer from different sourcesregister
Register provider information with an indexer that trusts the providersynthetic
Generate synthetic load to import in indexeringest
Admin commands to manage ingestion config of indexer
To see a list of available commands, see storetheindex --help
. For help with command usage, see storetheindex <command> --help
.
The storetheindex config file is a JSON document located at $STORETHEINDEX_PATH
/config. It is read once, either for an offline command, or when starting the daemon. For documentation of the items in the config file, see the godoc documentation of the corresponding config data structures.