README
¶
StoreTheIndex 🗂️
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.
Design
A design discussion of the ingestion interfaces exposed by store the index is here.
Current status 🚧
This implementation is entered production. A first production instance is running at https://cid.contact
Install
This assumes go is already installed.
Install storetheindex:
go get github.com/filecoin-project/storetheindex
Initialize the storetheindex repository and configuration:
storetheindex init
Running the Indexer Service
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.
Indexer CLI Commands
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:
findFind value by multihash in indexerimportImports data to indexer from different sourcesregisterRegister provider information with an indexer that trusts the providersyntheticGenerate synthetic load to import in indexeringestAdmin commands to manage ingestion config of indexer
Help
To see a list of available commands, see storetheindex --help. For help with command usage, see storetheindex <command> --help.
Configuration
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.
License
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v0/ingest/schema
Package schema defines the makeup of an advertisement.
|
Package schema defines the makeup of an advertisement. |
|
v0/libp2pclient
Package libp2pclient provides general libp2p client functionality This package supplies functionality to communicate raw data with libp2p peers, and is useful when building higher-level client that are responsible for processing the data send and and received using this package.
|
Package libp2pclient provides general libp2p client functionality This package supplies functionality to communicate raw data with libp2p peers, and is useful when building higher-level client that are responsible for processing the data send and and received using this package. |
|
internal
|
|
|
httpserver
Package httpserver provides functionality common to all storetheindex HTTP servers
|
Package httpserver provides functionality common to all storetheindex HTTP servers |
|
metrics/pprof
Package pprof is separated out from metrics to isolate the 'init' functionality of pprof, so that it is included when used by binaries, but not if other packages get used or integrated into clients that don't expect the pprof side effect to have taken effect.
|
Package pprof is separated out from metrics to isolate the 'init' functionality of pprof, so that it is included when used by binaries, but not if other packages get used or integrated into clients that don't expect the pprof side effect to have taken effect. |
|
version
Package version records versioning information about this module.
|
Package version records versioning information about this module. |
|
server
|
|
|
test
|
|