Add check_status docs page

massalabs · Jan 10, 2024 · 8dc31f3 · 8dc31f3
1 parent b7bfc60
commit 8dc31f3
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 3 deletions.
diff --git a/docs/build/networks-faucets/public-networks.mdx b/docs/build/networks-faucets/public-networks.mdx
@@ -12,7 +12,7 @@ import VersionsTable from "@site/src/components/versions-table";
 Here's a handy table containing all you need to know about the different Massa networks and their faucets.
 
 <Tabs>
-  <TabItem value="mainnet" label="👷 MainNet" default>
+  <TabItem value="mainnet" label="🖥 MainNet" default>
     <table>
       <tr>
         <td>🔗 Public API</td>

diff --git a/docs/node/all-configs.mdx b/docs/node/all-configs.mdx
@@ -21,7 +21,7 @@ the `massa-node/config/config.toml` file.
 <!-- The content will be added at build time via ./scripts/download-configs.sh -->
 <Tabs>
 
-  <TabItem value="mainnet" label="👷 MainNet" default>
+  <TabItem value="mainnet" label="🖥 MainNet" default>
 ```toml
 EXTERNAL_MAINNET_NODE_CONFIG_CONTENT
 ```
@@ -41,7 +41,7 @@ the `massa-client/config/config.toml` file.
 
 <!-- The content will be added at build time via ./scripts/download-configs.sh -->
 <Tabs>
-  <TabItem value="mainnet" label="👷 MainNet" default>
+  <TabItem value="mainnet" label="🖥 MainNet" default>
 ```toml
 EXTERNAL_MAINNET_CLIENT_CONFIG_CONTENT
 ```

diff --git a/docs/node/check_status.mdx b/docs/node/check_status.mdx
@@ -0,0 +1,20 @@
+---
+id: check_status
+sidebar_label: Check your node's status
+---
+
+# Check your node's status
+
+## Check your routability status
+
+You can use a service such as https://portchecker.co to check that the ports 31244 and 31245 are both opened for your public IP address.
+
+Additionally, in your massa-client, you can check that the `get_status` command shows your `Node's IP: <your_public_ip_address>`.
+If it shows `No routable IP set` instead, please check again your configuration.
+
+## Make sure you are connected to peers
+
+In order for your node to be running properly, you have to make sure you are connected to other peers on the network.
+
+The `get_status` command will show you which nodes you are connected too.
+You need to have both IN and OUT connections.
diff --git a/docs/node/stake.mdx b/docs/node/stake.mdx
@@ -88,3 +88,9 @@ them, again check with:
 ```shell
 wallet_info
 ```
+
+## What next ?
+
+Congratulations, you followed all the steps to be part of the Massa adventure!
+
+You should now check the status of your setup: [Check your node's status](/docs/node/check_status).
diff --git a/sidebars.js b/sidebars.js
@@ -394,6 +394,11 @@ const sidebars = {
       id: "node/stake",
       label: "Staking",
     },
+    {
+      type: "doc",
+      id: "node/check_status",
+      label: "Checking the node's status",
+    },
     {
       type: "doc",
       id: "node/all-configs",