Merge pull request #1257 from algorandfoundation/staging

staging => master
algorandfoundation · Apr 29, 2024 · fe3a1d6 · fe3a1d6
2 parents 1ba1c0a + 080c851
commit fe3a1d6
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 12 deletions.
diff --git a/.github/workflows/pr-generator.yml b/.github/workflows/pr-generator.yml
@@ -134,6 +134,6 @@ jobs:
           branch: "automatic-pr-go-algorand-${{ inputs.go_algorand_version }}-indexer-${{ inputs.indexer_version }}"
           title: "Automatic update generated for go-algorand: ${{ inputs.go_algorand_version }} and indexer: ${{ inputs.indexer_version }}"
           body: "Changes generated automatically by github action docs-generator."
-          reviewers: "nullun,ryanrfox"
+          reviewers: "nullun"
           delete-branch: true
           base: staging
diff --git a/docs/run-a-node/setup/install.md b/docs/run-a-node/setup/install.md
@@ -16,30 +16,48 @@ This guide explains how to install the Algorand Node software on Linux distribut
 !!! tip
     If you are a developer and want to use a private network, [AlgoKit](/docs/get-started/algokit) is often simpler than installing a node manually. However, it is still recommended to install the Algorand software without running a node, to get access to the developer tools such as `msgpacktool` and `algokey`.
 
-### Hardware requirements
+### Hardware Requirements
 
-(Last update to this section: November 3, 2022.)
+(Last update to this section: April 3, 2024.)
 
 Due to the higher TPS on MainNet, to successfully run an Algorand MainNet node, the following hardware is necessary:
 
-* at least 4GB of RAM (8GB strongly recommended)
-* a not-too-slow SSD: HDD and SD cards are too slow for a MainNet node and will most likely prevent the node to sync
+* 8GB of RAM (Some node operators successfully use 4GB, but it requires additional memory management and may still lag behind during extremely high network activity)
+* A not-too-slow SSD: HDD and SD cards are too slow for a MainNet node and will most likely prevent the node to sync
 * at least 100Mbps connection (1Gbps recommended)
 
 Participation nodes (especially those with high stake) and relays have higher requirements to ensure the performance of the overall blockchain.
 
-Recommended system specification for participation nodes is:
+Recommended system specification for **participation** nodes is:
 
 * 8 vCPU
 * 16 GB RAM
 * 100 GB NVMe SSD or equivalent
 * 1 Gbps connection with low latency
 
-Recommended system specification for relay nodes is:
+Recommended system specification for **archival non-relay** nodes is:
+
+* 8 vCPU
+* 16 GB RAM
+* 3 TB SSD (blocks and catchpoint storage - `ColdDataDir` in the [configuration file](https://developer.algorand.org/docs/run-a-node/reference/config/#algod-configuration-settings))
+* 100 GB NVMe SSD (accounts - `HotDataDir` in the [configuration file](https://developer.algorand.org/docs/run-a-node/reference/config/#algod-configuration-settings))
+* 5 TB/month egress
+* 1 Gbps connection with low latency
+
+Recommended system specification for **non-archival relay** (aka light relay) nodes is:
+
+* 16 vCPU
+* 32 GB RAM
+* 256 GB NVMe SSD or equivalent
+* 30 TB/month egress
+* 1 Gbps connection with very low latency
+
+Recommended system specification for **archival relay** nodes is:
 
 * 16 vCPU
 * 32 GB RAM
-* 3 TB NVMe SSD or equivalent
+* 3 TB SSD (blocks and catchpoint storage - `ColdDataDir` in the [configuration file](https://developer.algorand.org/docs/run-a-node/reference/config/#algod-configuration-settings))
+* 100 GB NVMe SSD (accounts - `HotDataDir` in the [configuration file](https://developer.algorand.org/docs/run-a-node/reference/config/#algod-configuration-settings))
 * 30 TB/month egress
 * 1 Gbps connection with very low latency
 

diff --git a/docs/sdks/go/index.md b/docs/sdks/go/index.md
@@ -1,4 +1,4 @@
-title: Your First Transaction
+title: Go SDK: Your First Transaction
 
 This section is a quick start guide for interacting with the Algorand network using Go. This guide will help to install [Algorand sandbox](https://github.com/algorand/sandbox){:target="_blank"}, which provides a node for testing and development. This guide will also help to install the Go SDK, create an account and submit your first transaction on Algorand.  
 

diff --git a/docs/sdks/java/index.md b/docs/sdks/java/index.md
@@ -1,4 +1,4 @@
-title: Your First Transaction
+title: Java SDK: Your First Transaction
 
 This section is a quick start guide for interacting with Algorand network using Java. This guide will help to install [Algorand sandbox](https://github.com/algorand/sandbox){:target="_blank"}, which provides a node for testing and development. This guide will also help to install the Java SDK, create an account and submit your first transaction.
 

diff --git a/docs/sdks/javascript/index.md b/docs/sdks/javascript/index.md
@@ -1,4 +1,4 @@
-title: Your First Transaction
+title: JS SDK: Your First Transaction
 
 This section is a quick start guide for interacting with the Algorand network using JavaScript. This guide will help to install the [Algorand sandbox](https://github.com/algorand/sandbox){:target="_blank"}, which provides a node for testing and development. This guide will also help to install the JavaScript SDK, create an account and submit your first transaction using different JavaScript Runtimes.
 

diff --git a/docs/sdks/python/index.md b/docs/sdks/python/index.md
@@ -1,4 +1,4 @@
-title: Your first transaction
+title: Python SDK: Your first transaction
 
 This section is a quick start guide for interacting with the Algorand network using Python. This guide will help to install [Algorand sandbox](https://github.com/algorand/sandbox){:target="_blank"}, which provides a node for testing and development. This guide will also help to install the Python SDK, create an account and submit your first transaction on Algorand.