Skip to content

Commit 20b3f8f

Browse files
committed
Improve installation telemetry language + add system requirements page
1 parent 8800fc3 commit 20b3f8f

File tree

4 files changed

+32
-31
lines changed

4 files changed

+32
-31
lines changed

.pre-commit-config.yaml

-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ repos:
33
- repo: https://github.com/pre-commit/pre-commit-hooks
44
rev: v2.3.0
55
hooks:
6-
- id: check-yaml
76
- id: end-of-file-fixer
87
- id: trailing-whitespace
98
- id: check-executables-have-shebangs

docs/installation/prerequisites.md

-30
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,3 @@
77

88
If any package is not available on your system, or if you do not have permission to use said package, follow operating
99
system guidance on installation and setup.
10-
11-
## Supported Operating Systems and Compute Platforms
12-
13-
| Operating Systems | Compute Platforms |
14-
|-------------------|-------------------|
15-
| Debian | arm64/amd64 |
16-
| Ubuntu | arm64/amd64 |
17-
18-
## Compute Requirements and Recommendations
19-
20-
| Minimum Requirements | Recommended Requirements |
21-
|----------------------|--------------------------|
22-
| 4 CPU cores | 8 CPU cores |
23-
| 8 GB RAM | 16 GB RAM |
24-
| 100 GB storage | 200 GB storage |
25-
| 1Mbps network | 1Gbps network |
26-
27-
!!! note
28-
The above requirements are based on the assumption that the node will be running on a dedicated machine.
29-
If you are running other services on the same machine, you may need to adjust the requirements accordingly.
30-
31-
## Why These Requirements?
32-
33-
The consensus algorithm used by the network is based on a protocol
34-
that benefits from fast response times and high availability.
35-
The requirements are set to ensure that the node can keep up with the network and provide good node health which
36-
benefits the network as a whole, including the node runner.
37-
If you are unable to meet these requirements, you may still be able to run a node.
38-
However, it may not be as beneficial to the network or to you,
39-
as your node won't be able to earn rewards effectively.
+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# System requirements
2+
3+
## Supported Operating Systems and Compute Platforms
4+
5+
| Operating Systems | Compute Platforms |
6+
|-------------------|-------------------|
7+
| Debian | arm64/amd64 |
8+
| Ubuntu | arm64/amd64 |
9+
10+
## Compute Requirements and Recommendations
11+
12+
| Minimum Requirements | Recommended Requirements |
13+
|----------------------|--------------------------|
14+
| 4 CPU cores | 8 CPU cores |
15+
| 8 GB RAM | 16 GB RAM |
16+
| 100 GB storage | 200 GB storage |
17+
| 1Mbps network | 1Gbps network |
18+
19+
!!! note
20+
The above requirements are based on the assumption that the node will be running on a dedicated machine.
21+
If you are running other services on the same machine, you may need to adjust the requirements accordingly.
22+
23+
## Why These Requirements?
24+
25+
The consensus algorithm used by the network is based on a protocol
26+
that benefits from fast response times and high availability.
27+
The requirements are set to ensure that the node can keep up with the network and provide good node health which
28+
benefits the network as a whole, including the node runner.
29+
If you are unable to meet these requirements, you may still be able to run a node.
30+
However, it may not be as beneficial to the network or to you,
31+
as your node won't be able to earn rewards effectively.

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ extra_css:
8181
nav:
8282
- Home: index.md
8383
- Installation:
84+
- System requirements: installation/system-requirements.md
8485
- Prerequisites: installation/prerequisites.md
8586
- Installation: installation/installation.md
8687
- Uninstall: installation/uninstall.md

0 commit comments

Comments
 (0)