Skip to content

Commit e6644e2

Browse files
Genesis3800Genesis3800
committed
Revamped the entire full node section
1 parent 88ba5d0 commit e6644e2

File tree

11 files changed

+373
-352
lines changed

11 files changed

+373
-352
lines changed

‎middleware.ts

+8
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,14 @@ const { origin } = request.nextUrl
211211
source: "/category/full-node/",
212212
destination: `${origin}/docs/operate-a-node/run-a-full-node/full-node`
213213
},
214+
{
215+
source: "/docs/operate-a-node/run-a-full-node/requirements",
216+
destination: `${origin}/docs/operate-a-node/run-a-full-node/overview`
217+
},
218+
{
219+
source: "/docs/operate-a-node/run-a-full-node/rpc-node",
220+
destination: `${origin}/docs/operate-a-node/run-a-full-node/full-node`
221+
},
214222
{
215223
source: "/operate/node/binaries/",
216224
destination: `${origin}/docs/operate-a-node/run-a-full-node/full-node/0020-full-node-binaries`

‎pages/docs/operate-a-node.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { FileIcon, FilesIcon } from '@components/icons'
66
<Cards>
77
<Card icon={<FileIcon />} title="Types of Nodes" href="/docs/operate-a-node/node-types" />
88
<Card icon={<FileIcon />} title="Hosted Deployments" href="/docs/operate-a-node/deployment-options" />
9-
<Card icon={<FilesIcon />} title="Run Avail Light Client" href="/docs/operate-a-node/run-a-light-client" />
9+
<Card icon={<FilesIcon />} title="Run an Avail Light Client" href="/docs/operate-a-node/run-a-light-client" />
1010
<Card icon={<FilesIcon />} title="Run an Avail Node" href="/docs/operate-a-node/run-a-full-node" />
1111
<Card icon={<FilesIcon />} title="Become a Validator" href="/docs/operate-a-node/become-a-validator" />
1212

‎pages/docs/operate-a-node/_meta.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"node-types": "Types of Nodes",
33
"deployment-options": "Hosted Deployments ",
4-
"run-a-light-client": "Run Avail Light Client",
4+
"run-a-light-client": "Run an Avail Light Client",
55
"run-a-full-node": "Run an Avail node",
66
"become-a-validator": "Become a Validator"
77
}

‎pages/docs/operate-a-node/run-a-full-node.mdx

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
import { Cards, Card } from 'nextra/components'
22
import { FileIcon, FilesIcon } from '@components/icons'
33

4-
# Run a Full Node
4+
# Run an Avail node
55

66
<Cards>
7-
<Card icon={<FileIcon />} title="System Requirements" href="/docs/operate-a-node/run-a-full-node/requirements" />
8-
<Card icon={<FileIcon />} title="Run a full node" href="/docs/operate-a-node/run-a-full-node/full-node" />
9-
<Card icon={<FileIcon />} title="Run an RPC node" href="/docs/operate-a-node/run-a-full-node/rpc-node" />
7+
<Card icon={<FileIcon />} title="Overview" href="/docs/operate-a-node/run-a-full-node/requirements" />
8+
<Card icon={<FileIcon />} title="Run an Avail node" href="/docs/operate-a-node/run-a-full-node/full-node" />
109
</Cards>

‎pages/docs/operate-a-node/run-a-full-node/_meta.json

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
{
2-
"requirements": "System Requirements",
3-
"full-node": "Run a full node",
4-
"rpc-node": "Run an RPC node"
2+
"overview": "Overview",
3+
"full-node": "Run an Avail node"
54
}

‎pages/docs/operate-a-node/run-a-full-node/full-node.mdx

+311-113
Large diffs are not rendered by default.

‎pages/docs/operate-a-node/run-a-full-node/overview.mdx

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
id: system-requirements
3+
title: System Requirements
4+
sidebar_label: System Requirements
5+
description: 'Learn about running an Avail validator using Docker.'
6+
keywords:
7+
- docs
8+
- avail
9+
- node
10+
- docker
11+
- validator
12+
- data availability
13+
image: https://docs.availproject.org/img/avail/AvailDocs.png
14+
---
15+
16+
import { Callout } from 'nextra/components'
17+
18+
# Overview
19+
20+
## System Requirements
21+
22+
This is the hardware configuration required to set up an Avail node:
23+
24+
| Component | Minimum | Recommended |
25+
| ---------------------------- |:--------:|:-----------:|
26+
| RAM | 8GB | 16GB |
27+
| CPU (amd64/x86 architecture) | 4 core | 8 core |
28+
| Storage (SSD) | 20-40 GB | 200-300 GB |
29+
30+
> While we do not favor any operating system, more secure and stable Linux server distributions (like CentOS) should be preferred over desktop operating systems (like Mac OS and Windows). Also, the minimum storage requirements will change over time as the network grows.
31+
> It is recommended to use more than the minimum requirements to run a robust full node.
32+
33+
## Methods to Run an Avail Node
34+
35+
There are three primary methods to run an Avail node, each with its own set of instructions:
36+
37+
1. **Using Binaries:** You can follow the instructions provided in the next page for setting up an Avail node using binary releases.
38+
This method is suitable for users who prefer manual installation and configuration.
39+
For reference, you can also explore the [GitHub Releases](https://github.com/availproject/avail/releases) page for
40+
a list of binary releases.
41+
42+
2. **Building from source:** The Avail node is based on open-sourced code. Feel free to
43+
[clone the repo](https://github.com/availproject/avail) and build it locally.
44+
45+
3. **Using Docker:** If you have docker engine installed on your machine, you can use it to run
46+
a [pre-built docker image for the Avail node](https://hub.docker.com/r/availj/avail/tags).

‎pages/docs/operate-a-node/run-a-full-node/requirements.mdx

-171
This file was deleted.

‎pages/docs/operate-a-node/run-a-full-node/rpc-node.mdx

-58
This file was deleted.

‎pages/docs/operate-a-node/run-a-light-client/_meta.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Overview": "Overview",
3-
"0010-light-client": "Run Avail LC",
3+
"0010-light-client": "Run an Avail Light Client",
44
"light-client-api-reference": "Light Client API Reference",
55
"light-client-challenge": {
66
"display": "hidden"

‎public/img/node-binary-demo.png

51 KB
Loading

0 commit comments

Comments
 (0)