Skip to content

Add system requirements to README. #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 12, 2023
Merged

Add system requirements to README. #155

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
979fc66
Add system requirements to README.
winder Sep 13, 2023
2920caf
Update README.md with Conduit/Algod co-location recommendation
gmalouf Oct 11, 2023
2d599af
Update README.md
gmalouf Oct 11, 2023
f7e0a24
Group conduit and algod along with storage.
winder Oct 12, 2023
3c7dfaa
Update README.md
gmalouf Oct 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
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