Skip to content

Commit

Permalink
Add system requirements to README. (#155)
Browse files Browse the repository at this point in the history
Co-authored-by: Gary <[email protected]>
  • Loading branch information
winder and gmalouf authored Oct 12, 2023
1 parent 83dec6a commit 45ef605
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ For example, use conduit to:
* Send blockchain data to another streaming data platform for additional processing (e.g. RabbitMQ, Kafka, ZeroMQ).
* Build an NFT catalog based on different standards.

# System Requirements

For a simple deployment the following configuration works well:
* Network: Conduit colocated with Algod follower.
* Conduit + Algod: 4 CPU and 8 GB of ram.
* Storage: algod follower node, 40 GiB, 3000 IOPS minimum.
* Deployments allocating less ram might work in conjunction with [GOMEMLIMIT](https://pkg.go.dev/runtime@master#hdr-Environment_Variables) for Algod (and even Conduit). This configuration is not tested, so use with caution and monitor closely.

# Getting Started

## Installation
Expand Down

0 comments on commit 45ef605

Please sign in to comment.