add node health check

docs/guides/nwaku/find-node-address.md

@@ -0,0 +1,60 @@
+---
+title: Find Your Node Address
+hide_table_of_contents: true
+---
+
+You can find the addresses of a running node through its logs or by calling the [Get node info](https://waku-org.github.io/waku-rest-api/#get-/debug/v1/info) endpoint of the [REST API](https://waku-org.github.io/waku-rest-api/).
+
+:::info
+When starting the node, `nwaku` will display all the public listening and discovery addresses at the `INFO` log level.
+:::
+
+## Listening addresses
+
+Look for the log entry that begins with `Listening on`, for example:
+
+```txt title="Nwaku Log Output"
+INF 2023-06-15 16:09:54.448+01:00 Listening on                               topics="waku node" tid=1623445 file=waku_node.nim:922 full=[/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmQCsH9V81xoqTwGuT3qwkZWbwY1TtTQwpr3DjHU2TSwMn][/ip4/0.0.0.0/tcp/8000/ws/p2p/16Uiu2HAmQCsH9V81xoqTwGuT3qwkZWbwY1TtTQwpr3DjHU2TSwMn]
+```
+
+```shell
+# Listening TCP transport address
+/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmQCsH9V81xoqTwGuT3qwkZWbwY1TtTQwpr3DjHU2TSwMn
+
+# Listening WebSocket address
+/ip4/0.0.0.0/tcp/8000/ws/p2p/16Uiu2HAmQCsH9V81xoqTwGuT3qwkZWbwY1TtTQwpr3DjHU2TSwMn
+```
+
+## Discoverable ENR addresses
+
+A `nwaku` node can encode its addressing information in an [Ethereum Node Record (ENR)](https://eips.ethereum.org/EIPS/eip-778).
+
+### ENR for DNS discovery
+
+Look for the log entry that begins with `DNS: discoverable ENR`, for example:
+
+```txt title="Nwaku Log Output"
+INF 2023-06-15 16:09:54.448+01:00 DNS: discoverable ENR                      topics="waku node" tid=1623445 file=waku_node.nim:923 enr=enr:-Iu4QBKYj8Ovxwz4fIalxZ_1a8dOCU2WC-1LQrcBCCb4Np93f9-UuSZXn3vagJL1S3k3hwRYfOp3JSbW7_VqwtqMIeMBgmlkgnY0gmlwhAAAAACJc2VjcDI1NmsxoQOrmyV59dAzY4ZKrvrj32VOoZbLby8dCKFnXnqhIdQ0NYN0Y3CC6mCFd2FrdTIB
+```
+
+```shell
+# ENR the node addresses are encoded in
+enr:-Iu4QBKYj8Ovxwz4fIalxZ_1a8dOCU2WC-1LQrcBCCb4Np93f9-UuSZXn3vagJL1S3k3hwRYfOp3JSbW7_VqwtqMIeMBgmlkgnY0gmlwhAAAAACJc2VjcDI1NmsxoQOrmyV59dAzY4ZKrvrj32VOoZbLby8dCKFnXnqhIdQ0NYN0Y3CC6mCFd2FrdTIB
+```
+
+### ENR for Discv5
+
+Look for the log entry that begins with `Discv5: discoverable ENR`, for example:
+
+```txt title="Nwaku Log Output"
+INF 2023-06-15 16:09:54.448+01:00 Discv5: discoverable ENR                   topics="waku node" tid=1623445 file=waku_node.nim:924 enr=enr:-IO4QDxToTg86pPCK2KvMeVCXC2ADVZWrxXSvNZeaoa0JhShbM5qed69RQz1s1mWEEqJ3aoklo_7EU9iIBcPMVeKlCQBgmlkgnY0iXNlY3AyNTZrMaEDdBHK1Gx6y_zv5DVw5Qb3DtSOMmVHTZO1WSORrF2loL2DdWRwgiMohXdha3UyAw
+```
+
+```shell
+# ENR the node addresses are encoded in
+enr:-IO4QDxToTg86pPCK2KvMeVCXC2ADVZWrxXSvNZeaoa0JhShbM5qed69RQz1s1mWEEqJ3aoklo_7EU9iIBcPMVeKlCQBgmlkgnY0iXNlY3AyNTZrMaEDdBHK1Gx6y_zv5DVw5Qb3DtSOMmVHTZO1WSORrF2loL2DdWRwgiMohXdha3UyAw
+```
+
+:::tip Congratulations!
+You have successfully found the listening and discoverable addresses for your `nwaku` node. Have a look at the Configure Peer Discovery](/guides/nwaku/configure-discovery) guide to learn how to discover and connect with peers in the network.
+:::

docs/guides/nwaku/run-node.md

@@ -19,15 +19,13 @@ To run a node, you must have the `nwaku` binary. Nwaku provides multiple options
 
 #### Run nwaku in Docker (recommended)
 
+We recommend [using Docker Compose](/guides/nwaku/run-docker-compose) to run a node because it's the simplest and fastest way to configure and run one:
+
 |                  | Description                              | Documentation                                                     |
 | ---------------- | ---------------------------------------- | ----------------------------------------------------------------- |
 | Docker Compose   | Run a `nwaku` node with Docker Compose   | [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) |
 | Docker Container | Run a `nwaku` node in a Docker Container | [Run Nwaku in a Docker Container](/guides/nwaku/run-docker)       |
 
-:::tip
-We recommend [using Docker Compose](/guides/nwaku/run-docker-compose) to run a node because it's the simplest and fastest way to configure and run one.
-:::
-
 #### Download the binary
 
 |                    | Description                                                   | Documentation                                                                      |
@@ -50,11 +48,11 @@ You can run the `nwaku` binaries and Docker images on cloud service providers li
 Once you have gotten the `nwaku` binary, run it using the [default configuration](/guides/nwaku/config-methods#default-configuration-values):
 
 ```shell
-# Run with default configuration
+# Run the Docker Compose
-./build/wakunode2
+docker-compose up -d
 
-# See available command line options
+# Run the standalone binary
-./build/wakunode2 --help
+./build/wakunode2
 ```
 
 :::tip
@@ -72,8 +70,8 @@ To join the Waku Network, nodes must [bootstrap](/learn/glossary#bootstrapping)
 | Discv5        | Enable `nwaku` to discover peers using the [Discv5](/learn/concepts/discv5) mechanism                                  | [Configure Discv5](/guides/nwaku/configure-discovery#configure-discv5)               |
 | Peer Exchange | Enable [Peer Exchange](/learn/concepts/peer-exchange) protocol for light nodes to request peers from your `nwaku` node | [Configure Peer Exchange](/guides/nwaku/configure-discovery#configure-peer-exchange) |
 
-:::info
+:::tip
-You can configure a `nwaku` node to use multiple peer discovery mechanisms simultaneously.
+We suggest [configuring WebSocket transport](/guides/nwaku/configure-nwaku#configure-websocket-transport) for your node to enable support and serving of browser peers using [@waku/sdk](/guides/js-waku/).
 :::
 
 ## Interact with the node
@@ -112,63 +110,27 @@ curl --location 'http://127.0.0.1:8645/debug/v1/info' \
 The `listenAddresses` field stores the node's listening addresses, while the `enrUri` field stores the discoverable `ENR` URI for peer discovery.
 :::
 
-:::tip
+## Check the node health status
-We suggest [configuring WebSocket transport](/guides/nwaku/configure-nwaku#configure-websocket-transport) for your node to enable support and serving of browser peers using [@waku/sdk](/guides/js-waku/).
-:::
 
-## Find the node addresses
+You can check the health status of the node by calling the [Get node health status](https://waku-org.github.io/waku-rest-api/#get-/health) endpoint of the [REST API](https://waku-org.github.io/waku-rest-api/):
 
-You can find the addresses of a running node through its logs or by calling the [Get node info](https://waku-org.github.io/waku-rest-api/#get-/debug/v1/info) endpoint of the [REST API](https://waku-org.github.io/waku-rest-api/).
+<Tabs>
-
+<TabItem value="request" label="Request">
-:::info
-When starting the node, `nwaku` will display all the public listening and discovery addresses at the `INFO` log level.
-:::
-
-### Listening addresses
-
-Look for the log entry that begins with `Listening on`, for example:
-
-```txt title="Nwaku Log Output"
-INF 2023-06-15 16:09:54.448+01:00 Listening on                               topics="waku node" tid=1623445 file=waku_node.nim:922 full=[/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmQCsH9V81xoqTwGuT3qwkZWbwY1TtTQwpr3DjHU2TSwMn][/ip4/0.0.0.0/tcp/8000/ws/p2p/16Uiu2HAmQCsH9V81xoqTwGuT3qwkZWbwY1TtTQwpr3DjHU2TSwMn]
-```
 
 ```shell
-# Listening TCP transport address
+curl --location 'http://127.0.0.1:8645/health' \
-/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmQCsH9V81xoqTwGuT3qwkZWbwY1TtTQwpr3DjHU2TSwMn
+--header 'Accept: text/plain'
-
-# Listening WebSocket address
-/ip4/0.0.0.0/tcp/8000/ws/p2p/16Uiu2HAmQCsH9V81xoqTwGuT3qwkZWbwY1TtTQwpr3DjHU2TSwMn
 ```
 
-### Discoverable ENR addresses
+</TabItem>
+<TabItem value="response" label="Response">
 
-A `nwaku` node can encode its addressing information in an [Ethereum Node Record (ENR)](https://eips.ethereum.org/EIPS/eip-778).
+```txt
-
+Node is healthy
-#### ENR for DNS discovery
-
-Look for the log entry that begins with `DNS: discoverable ENR`, for example:
-
-```txt title="Nwaku Log Output"
-INF 2023-06-15 16:09:54.448+01:00 DNS: discoverable ENR                      topics="waku node" tid=1623445 file=waku_node.nim:923 enr=enr:-Iu4QBKYj8Ovxwz4fIalxZ_1a8dOCU2WC-1LQrcBCCb4Np93f9-UuSZXn3vagJL1S3k3hwRYfOp3JSbW7_VqwtqMIeMBgmlkgnY0gmlwhAAAAACJc2VjcDI1NmsxoQOrmyV59dAzY4ZKrvrj32VOoZbLby8dCKFnXnqhIdQ0NYN0Y3CC6mCFd2FrdTIB
 ```
 
-```shell
+</TabItem>
-# ENR the node addresses are encoded in
+</Tabs>
-enr:-Iu4QBKYj8Ovxwz4fIalxZ_1a8dOCU2WC-1LQrcBCCb4Np93f9-UuSZXn3vagJL1S3k3hwRYfOp3JSbW7_VqwtqMIeMBgmlkgnY0gmlwhAAAAACJc2VjcDI1NmsxoQOrmyV59dAzY4ZKrvrj32VOoZbLby8dCKFnXnqhIdQ0NYN0Y3CC6mCFd2FrdTIB
-```
-
-#### ENR for Discv5
-
-Look for the log entry that begins with `Discv5: discoverable ENR`, for example:
-
-```txt title="Nwaku Log Output"
-INF 2023-06-15 16:09:54.448+01:00 Discv5: discoverable ENR                   topics="waku node" tid=1623445 file=waku_node.nim:924 enr=enr:-IO4QDxToTg86pPCK2KvMeVCXC2ADVZWrxXSvNZeaoa0JhShbM5qed69RQz1s1mWEEqJ3aoklo_7EU9iIBcPMVeKlCQBgmlkgnY0iXNlY3AyNTZrMaEDdBHK1Gx6y_zv5DVw5Qb3DtSOMmVHTZO1WSORrF2loL2DdWRwgiMohXdha3UyAw
-```
-
-```shell
-# ENR the node addresses are encoded in
-enr:-IO4QDxToTg86pPCK2KvMeVCXC2ADVZWrxXSvNZeaoa0JhShbM5qed69RQz1s1mWEEqJ3aoklo_7EU9iIBcPMVeKlCQBgmlkgnY0iXNlY3AyNTZrMaEDdBHK1Gx6y_zv5DVw5Qb3DtSOMmVHTZO1WSORrF2loL2DdWRwgiMohXdha3UyAw
-```
 
 :::tip Congratulations!
 You have successfully started, configured, and connected a `nwaku` node to the Waku Network. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases.

sidebars.js

@@ -17,6 +17,7 @@ const sidebars = {
         "guides/nwaku/run-docker",
         "guides/nwaku/build-source",
         "guides/nwaku/configure-discovery",
+        "guides/nwaku/find-node-address",
         "guides/nwaku/config-methods",
         "guides/nwaku/config-options",
         "guides/nwaku/configure-nwaku",