go-waku/docs/operators/quickstart.md

1.1 KiB

Quickstart: running a go-waku node

This guide explains how to build and run a go-waku node for the most common use cases. For a more advanced configuration see our configuration guides

1. Build

Build the go-waku node or download a precompiled binary from our releases page.

2. Run

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

Connect the go-waku node to other peers to start communicating.

3. Interact

A running go-waku 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 go-waku node with these enabled, use the --rpc-admin:true and --rpc-private:true CLI options.