logos-messaging/docs.waku.org
1
0
Fork 0
mirror of https://github.com/logos-messaging/docs.waku.org.git synced 2026-01-23 07:03:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

add nwaku faq

Browse Source
This commit is contained in:
LordGhostX 2024-02-29 21:59:58 +01:00
parent 55f79ba75c
commit c9a07edc07
No known key found for this signature in database
GPG Key ID: 520CC5DC4F94FCC7
5 changed files with 42 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/guides/nwaku/configure-nwaku.md
View File

@ -161,7 +161,7 @@ sudo certbot certonly -d <your.domain.name>
## 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`.

39
docs/guides/nwaku/faq.md Normal file
View File

@ -0,0 +1,39 @@
---
title: Nwaku FAQ
hide_table_of_contents: true
sidebar_label: Frequently Asked Questions
---
import { AccordionItem } from '@site/src/components/mdx'
<AccordionItem title="How can I run a Waku node?">
Check out the <a href="/guides/nwaku/run-docker-compose">Run Nwaku with Docker Compose</a> guide to learn the simplest and fastest way to run a node. You can also check the comprehensive <a href="/guides/nwaku/run-node">Run a Nwaku Node</a> guide to explore other options like <a href="">downloading binaries</a> and <a href="">building from source</a>
</AccordionItem>
<AccordionItem title="What are the system requirements for running a node?">
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
</AccordionItem>
<AccordionItem title="How can I interact with my running nwaku node?">
You can interact with a running nwaku node using the <a href="https://waku-org.github.io/waku-rest-api/">REST API interface</a> or the <a href="/guides/js-waku/">JavaScript Waku SDK</a>
</AccordionItem>
<AccordionItem title="How can I view the logs of a nwaku node running in Docker?">
You can view your node logs in Docker by running the command: "docker-compose logs -f nwaku"
</AccordionItem>
<AccordionItem title="How can I configure my nwaku node before running?">
Check out the <a href="/guides/nwaku/config-options">Node Configuration Options</a> guide for the list of available node configuration options, along with their default values and descriptions.
</AccordionItem>
<AccordionItem title="What configuration methods are available for nwaku nodes?">
Nwaku nodes can be configured using the following methods: command line options and flags, environment variables, and TOML configuration files. Check out the <a href="/guides/nwaku/config-methods">Node Configuration Methods</a> guide to learn how to use them and which take precedence.
</AccordionItem>
<AccordionItem title="What peer discovery mechanisms are available for nwaku nodes, and how can I configure them?">
You can configure peer discovery for nwaku nodes using static peers, DNS discovery, Discovery V5, and peer exchange. Check out the <a href="/guides/nwaku/configure-discovery">Configure Peer Discovery</a> guide to learn how to configure your node.
</AccordionItem>
<AccordionItem title="How do I find my nwaku node's addresses for peer discovery?">
You can find the node listening address and discoverable ENR addresses from the node's logs and <a href="https://waku-org.github.io/waku-rest-api/#get-/debug/v1/info">Get node info endpoint of the REST API</a>. Check out the <a href="/guides/nwaku/run-node#find-the-node-addresses">Find the node addresses</a> section to learn how to find your node addresses.
</AccordionItem>

6
docs/guides/nwaku/faq.mdx
View File

@ -1,6 +0,0 @@
---
title: Frequently Asked Questions
hide_table_of_contents: true
---
import { AccordionItem } from '@site/src/components/mdx'

2
docs/guides/nwaku/run-node.md
View File

@ -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

2
sidebars.js
View File

@ -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',