logos-messaging/logos-messaging-nim
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-messaging-nim.git synced 2026-01-02 14:03:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
logos-messaging-nim/docs/operators/quickstart.md
Hanno Cornelius 35045d9d97
docs: add operator guide docs (#963)
2022-05-20 14:48:34 +02:00

1.1 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

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.