Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 1.72 KB

GettingStarted.md

File metadata and controls

40 lines (25 loc) · 1.72 KB
Raw

Getting Started

Installation

Download

The latest conduit binary can be downloaded from the GitHub releases page.

Install from Source

  1. Checkout the repo, or download the source, git clone https://github.com/algorand/conduit.git && cd conduit
  2. Run make conduit.
  3. The binary is created at cmd/conduit/conduit.

Getting Started

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 -d data. 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.

Configuration and Plugins

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.

Tutorials

Migrate from the Legacy Indexer Architecture to a Conduit-backed Indexer

How to migrate from a legacy Indexer architecture to a Conduit-backed Indexer deployment. .

Set up Conduit for the Indexer API

How to configure algod, PostgreSQL and Conduit as an Indexer API backend.

Writing Block Data to the Filesystem

Use the file exporter to write data to files.