setup modifications and file hierarchy optimizations

shardeum · Nov 27, 2024 · fb3c27d · fb3c27d
1 parent ede38ca
commit fb3c27d
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 113 deletions.
diff --git a/content/docs/node/run/validator.mdx b/content/docs/node/run/validator.mdx
@@ -26,8 +26,8 @@ To run a Shardeum validator, first choose the approach that best suits your expe
     description="You have little to no experience running servers"
   />
   <Card
-    href="/docs/node/run/validator/vps-cloud-provider"
-    title="VPS Service"
+    href="/docs/node/run/validator/cloud-service-providers"
+    title="Cloud Service Providers"
     description="You want to use a hosted service like GCP, AWS, etc."
   />
 </Cards>

diff --git a/content/docs/node/run/validator/cloud-service-providers/aws.mdx b/content/docs/node/run/validator/cloud-service-providers/aws.mdx
@@ -55,9 +55,9 @@ Use SSH to connect to your instance:
 
 ```bash
 chmod 400 your-key-pair.pem
-ssh -i your-key-pair.pem ubuntu@your-instance-public-dns
+ssh -i your-key-pair.pem user@your-instance-public-dns
 ```
 
 ### 4. Installing Shardeum
 
-Once your AWS instance is ready, follow our [Base Guide for Running a Shardeum Validator Node](/docs/node/run/validator/self-host#install-the-shardeum-validator) for detailed installation instructions, including the steps to open the validator dashboard, stake SHM, start the validator, and more.
+Once your AWS instance is ready, follow our [Base Guide for Running a Shardeum Validator Node](/docs/node/run/validator/self-host#download-and-install-validator) for detailed installation instructions, including the steps to open the validator dashboard, stake SHM, start the validator, and more.
diff --git a/content/docs/node/run/validator/cloud-service-providers/contabo.mdx b/content/docs/node/run/validator/cloud-service-providers/contabo.mdx
@@ -39,10 +39,11 @@ Inbound Rules:
 ### 3. Connect to Your VPS
 
 Use SSH to connect to your VPS:
+
 ```bash
 ssh root@your_server_ip
 ```
 
 ### 4. Install Shardeum
 
-Once your VPS is ready, follow our [Base Guide for Running a Shardeum Validator Node](/docs/node/run/validator/self-host#install-the-shardeum-validator) for detailed installation instructions, including the steps to open the validator dashboard, stake SHM, start the validator, and more.
+Once your VPS is ready, follow our [Base Guide for Running a Shardeum Validator Node](/docs/node/run/validator/self-host#download-and-install-validator) for detailed installation instructions, including the steps to open the validator dashboard, stake SHM, start the validator, and more.
diff --git a/content/docs/node/run/validator/cloud-service-providers/digital-ocean.mdx b/content/docs/node/run/validator/cloud-service-providers/digital-ocean.mdx
@@ -44,4 +44,4 @@ ssh root@your-droplet-ip
 
 ### 4. Install Shardeum
 
-Once your Droplet is ready, follow our [Base Guide for Running a Shardeum Validator Node](/docs/node/run/validator/self-host#install-the-shardeum-validator) for detailed installation instructions, including the steps to open the validator dashboard, stake SHM, start the validator, and more.
+Once your Droplet is ready, follow our [Base Guide for Running a Shardeum Validator Node](/docs/node/run/validator/self-host#download-and-install-validator) for detailed installation instructions, including the steps to open the validator dashboard, stake SHM, start the validator, and more.
diff --git a/content/docs/node/run/validator/cloud-service-providers/gcp.mdx b/content/docs/node/run/validator/cloud-service-providers/gcp.mdx
@@ -44,4 +44,4 @@ gcloud compute ssh your-instance-name --zone your-zone
 ```
 
 ### 5. Install Shardeum
-Once your GCP instance is ready, follow our [Base Guide for Running a Shardeum Validator Node](/docs/node/run/validator/self-host#install-the-shardeum-validator) for detailed installation instructions, including the steps to open the validator dashboard, stake SHM, start the validator, and more.
+Once your GCP instance is ready, follow our [Base Guide for Running a Shardeum Validator Node](/docs/node/run/validator/self-host#download-and-install-validator) for detailed installation instructions, including the steps to open the validator dashboard, stake SHM, start the validator, and more.
diff --git a/content/docs/node/run/validator/index.mdx b/content/docs/node/run/validator/index.mdx
@@ -0,0 +1,39 @@
+---
+title: Validator
+description: Steps to run a Shardeum Validator
+---
+
+
+## Choosing an approach
+
+Shardeum's dynamic state sharding enables horizontal scalability, making node operation accessible to everyone. With minimal hardware and a user-friendly interface, regular users can run validator nodes, contributing to network decentralization and security while earning rewards.
+
+
+import { Callout } from 'fumadocs-ui/components/callout';
+
+
+To run a Shardeum validator, first choose the approach that best suits your experience level and requirements.
+
+<Cards>
+  <Card
+    href="/docs/node/run/validator/self-host"
+    title="Self Host"
+    description="You have experience running servers"
+  />
+  <Card
+    href="/docs/node/run/validator/one-click"
+    title="1-Click Install"
+    description="You have little to no experience running servers"
+  />
+  <Card
+    href="/docs/node/run/validator/cloud-service-providers"
+    title="Cloud Service Providers"
+    description="You want to use a hosted service like GCP, AWS, etc."
+  />
+</Cards>
+
+<Callout title="" type="info">
+Regardless of the approach you choose, operating a node on Shardeum remains cost-effective. As the network expands and traffic increases, Shardeum's dynamic state sharding technology ensures that node operation costs stay low. 
+</Callout>
+
+
diff --git a/content/docs/node/run/validator/self-host.mdx b/content/docs/node/run/validator/self-host.mdx
@@ -37,6 +37,10 @@ description: Steps to run a Self Hosted Shardeum Validator on Your Own Hardware
   />
 </Cards>
 
+<Callout title="" type="info">
+The instructions on this page are primarily written for Ubuntu/Linux operating systems. If you are using a different operating system you will need to adapt the commands and steps accordingly. The core concepts remain the same, but package installation methods and system commands may differ.
+</Callout>
+
 For true decentralization and censorship resistance, it's crucial to minimize reliance on cloud providers. Self-hosting your Shardeum validator on personal hardware offer several advantages:
 
 1. Enhanced network security and resilience
@@ -138,28 +142,6 @@ Check that docker is working with (should return version 20.10.12 or higher):
 docker --version
 ```
 
-### Install docker-compose
-
-<Tabs items={["Linux", "MacOS"]}>
-```ts tab="Linux"
-sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
-```
-
-```ts tab="MacOS"
-brew install docker-compose
-``` 
-</Tabs>
-
-Setup permissions for docker-compose:
-
-```
-sudo chmod +x /usr/local/bin/docker-compose
-```
-
-Check that docker-compose is working with (should return version 1.29.2 or higher):
-```
-docker-compose --version
-```
 
 
 ## Download and Install Validator

diff --git a/content/docs/node/run/validator/vps-cloud-provider.mdx b/content/docs/node/run/validator/vps-cloud-provider.mdx
Original file line number	Diff line number	Diff line change
Expand Up		@@ -44,4 +44,4 @@ ssh root@your-droplet-ip

		### 4. Install Shardeum

		Once your Droplet is ready, follow our [Base Guide for Running a Shardeum Validator Node](/docs/node/run/validator/self-host#install-the-shardeum-validator) for detailed installation instructions, including the steps to open the validator dashboard, stake SHM, start the validator, and more.
		Once your Droplet is ready, follow our [Base Guide for Running a Shardeum Validator Node](/docs/node/run/validator/self-host#download-and-install-validator) for detailed installation instructions, including the steps to open the validator dashboard, stake SHM, start the validator, and more.