- Checkout the repo, or download the source,
git clone https://github.com/algorand/indexer.git && cd indexer - Run
make conduit. - The binary is created at
cmd/conduit/conduit.
Go installs of the indexer repo do not currently work because of its use of the replace directive to support the
go-algorand submodule.
In Progress
There is ongoing work to remove go-algorand entirely as a dependency of indexer/conduit. Once
that work is complete users should be able to use go install to install binaries for this project.
Conduit requires a configuration file to set up and run a data pipeline. To generate an initial skeleton for a conduit
config file, you can run ./conduit init. This will set up a sample data directory with a config located at
data/conduit.yml.
You will need to manually edit the data in the config file, filling in a valid configuration for conduit to run.
You can find a valid config file in Configuration.md or via the conduit init command.
Once you have a valid config file in a directory, config_directory, launch conduit with ./conduit -d config_directory.
Conduit comes with an initial set of plugins available for use in pipelines. For more information on the possible plugins and how to include these plugins in your pipeline's configuration file see Configuration.md.
For more detailed guides, walkthroughs, and step by step writeups, take a look at some of our Conduit tutorials. Here are a few of the highlights: