waku-org
/
nwaku
mirror of https://github.com/waku-org/nwaku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
nwaku/docs/operators/overview.md

2.0 KiB
Raw Blame History

Overview: running a nwaku node

This guide provides on overview for newcomers on how to build and run a nwaku node for the most common use cases. For a more advanced configuration see our configuration guides

To set up a nwaku node on a DigitalOcean droplet, refer to our quickstart guide for droplets. If you prefer running nwaku in Docker container, see our Docker guide.

1. Build

Build the nwaku node or download a precompiled binary from our releases page.

If you'd like to test latest changes without building the binaries yourself, you can refer to nightly release.

Docker images are published to statusteam/nim-waku on Docker Hub. See our Docker quickstart guide to run nwaku in a Docker container.

2. Run

Run the nwaku node using a default or common configuration or configure the node for more advanced use cases.

Connect the nwaku node to other peers to start communicating.

3. Interact

A running nwaku node can be interacted with using the Waku v2 JSON RPC API.

Note: Private and Admin API functionality are disabled by default. To configure a nwaku node with these enabled, use the --rpc-admin:true and --rpc-private:true CLI options.

curl -d '{"jsonrpc":"2.0","method":"get_waku_v2_debug_v1_info","params":[],"id":1}' -H 'Content-Type: application/json' localhost:8546 -s | jq

Or using the Waku v2 HTTP REST API:

Note: REST API functionality is in ALPHA and therefore it is disabled by default. To configure a nwaku node with this enabled, use the --rest:true CLI option.

curl http://localhost:8546/debug/v1/info -s | jq