From c9a07edc07e1b04c1c94f320827a9c22273a7434 Mon Sep 17 00:00:00 2001 From: LordGhostX Date: Thu, 29 Feb 2024 21:59:58 +0100 Subject: [PATCH] add nwaku faq --- docs/guides/nwaku/configure-nwaku.md | 2 +- docs/guides/nwaku/faq.md | 39 ++++++++++++++++++++++++++++ docs/guides/nwaku/faq.mdx | 6 ----- docs/guides/nwaku/run-node.md | 2 +- sidebars.js | 2 +- 5 files changed, 42 insertions(+), 9 deletions(-) create mode 100644 docs/guides/nwaku/faq.md delete mode 100644 docs/guides/nwaku/faq.mdx diff --git a/docs/guides/nwaku/configure-nwaku.md b/docs/guides/nwaku/configure-nwaku.md index e7b51c7..703bb55 100644 --- a/docs/guides/nwaku/configure-nwaku.md +++ b/docs/guides/nwaku/configure-nwaku.md @@ -161,7 +161,7 @@ sudo certbot certonly -d ## Configure REST API server -Nwaku provides a REST API to interact with the node and Waku Network. To enable the REST API, use the following configuration options: +Nwaku provides a [REST API](https://waku-org.github.io/waku-rest-api/) to interact with the node and Waku Network. To enable the REST API, use the following configuration options: - `rest`: Enables the REST API server on the node (disabled by default). - `rest-address` (optional): Listening address of the REST API server. If you omit this option, it will default to `127.0.0.1`. diff --git a/docs/guides/nwaku/faq.md b/docs/guides/nwaku/faq.md new file mode 100644 index 0000000..cdf181e --- /dev/null +++ b/docs/guides/nwaku/faq.md @@ -0,0 +1,39 @@ +--- +title: Nwaku FAQ +hide_table_of_contents: true +sidebar_label: Frequently Asked Questions +--- + +import { AccordionItem } from '@site/src/components/mdx' + + + Check out the Run Nwaku with Docker Compose guide to learn the simplest and fastest way to run a node. You can also check the comprehensive Run a Nwaku Node guide to explore other options like downloading binaries and building from source + + + + We recommend running a nwaku node with at least 2GB of RAM, especially if WSS is enabled. If running just a Relay node, 0.5GB of RAM is sufficient + + + + You can interact with a running nwaku node using the REST API interface or the JavaScript Waku SDK + + + + You can view your node logs in Docker by running the command: "docker-compose logs -f nwaku" + + + + Check out the Node Configuration Options guide for the list of available node configuration options, along with their default values and descriptions. + + + + Nwaku nodes can be configured using the following methods: command line options and flags, environment variables, and TOML configuration files. Check out the Node Configuration Methods guide to learn how to use them and which take precedence. + + + + You can configure peer discovery for nwaku nodes using static peers, DNS discovery, Discovery V5, and peer exchange. Check out the Configure Peer Discovery guide to learn how to configure your node. + + + + You can find the node listening address and discoverable ENR addresses from the node's logs and Get node info endpoint of the REST API. Check out the Find the node addresses section to learn how to find your node addresses. + \ No newline at end of file diff --git a/docs/guides/nwaku/faq.mdx b/docs/guides/nwaku/faq.mdx deleted file mode 100644 index e1e50c8..0000000 --- a/docs/guides/nwaku/faq.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Frequently Asked Questions -hide_table_of_contents: true ---- - -import { AccordionItem } from '@site/src/components/mdx' \ No newline at end of file diff --git a/docs/guides/nwaku/run-node.md b/docs/guides/nwaku/run-node.md index ae6d846..d3154d5 100644 --- a/docs/guides/nwaku/run-node.md +++ b/docs/guides/nwaku/run-node.md @@ -8,7 +8,7 @@ Nwaku is a lightweight and robust Nim client for running a Waku node, equipped w This guide provides detailed steps to download, build, configure, and connect a `nwaku` node to the Waku Network. It also includes interacting with the node and finding its addresses. :::info -We recommend running a `nwaku` node with at least 2GB of RAM, especially if you have `WSS` enabled. If running just a `Relay` node, 0.5GB of RAM is sufficient. +We recommend running a `nwaku` node with at least 2GB of RAM, especially if `WSS` is enabled. If running just a `Relay` node, 0.5GB of RAM is sufficient. ::: ## Get the node binary diff --git a/sidebars.js b/sidebars.js index 331e2d6..33e2bd7 100644 --- a/sidebars.js +++ b/sidebars.js @@ -16,9 +16,9 @@ const sidebars = { "guides/nwaku/run-docker", "guides/nwaku/run-docker-compose", "guides/nwaku/configure-discovery", - "guides/nwaku/configure-nwaku", "guides/nwaku/config-methods", "guides/nwaku/config-options", + "guides/nwaku/configure-nwaku", "guides/nwaku/faq", { type: 'html',