waku-org/nwaku
1
0
Fork 0
mirror of https://github.com/waku-org/nwaku.git synced 2025-01-09 22:36:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
nwaku/docs/operators/quickstart.md
Aaryamann Challani 48cfaa3320
docs(operator-outreach): nwaku on droplets (#1133) 
* docs(operator-outreach): add droplet config

* docs(operator-outreach): add link to droplet setup

* fix(operator-outreach): numbering

* fix(operator-outreach): typos

* docs(operator-outreach): add some prerequisite info

* Update docs/operators/droplet-quickstart.md

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>

* Update docs/operators/droplet-quickstart.md

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>

* fix(operator-outreach): typos and additional info, address review

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
2022-09-13 16:11:36 +05:30

1.6 KiB
Raw Blame History

Quickstart: running a nwaku node

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

To quickly set up a nwaku node on DigitalOcean, refer to this guide

1. Build

Build the nwaku node or download a precompiled binary from our releases page. Docker images are published to statusteam/nim-waku on DockerHub.

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