README.md

Description

This role provisions a Nim-Waku node which speaks the Waku communication protocol.

Configuration

The crucial settings are:

# Private key which affects enode:// address
nim_waku_node_key: 
nim_waku_log_level: 'info'

You can also enable WebSockets as transport for LibP2P using:

nim_waku_websoc_port: 443
nim_waku_websocket_enabled: true
nim_waku_websocket_domain: 'hostname.example.org'
nim_waku_websocket_ssl_dir: '/etc/letsencrypt'
nim_waku_websocket_ssl_cert: '/etc/letsencrypt/live/{{ nim_waku_websocket_domain }}/fullchain.pem'
nim_waku_websocket_ssl_key: '/etc/letsencrypt/live/{{ nim_waku_websocket_domain }}/privkey.pem'

In this case LetsEncrypt is used, but any other certificate would work as long ass the full chain is used.

DNS-based discovery can be enabled to bootstrap a node's connections to a list of existing peers at the configured domain. The configured domain URL should be in the format 'enrtree://@', for example:

nim_waku_dns_disc_enabled: true
nim_waku_dns_disc_url: 'enrtree://AOFTICU2XWDULNLZGRMQS4RIZPAZEHYMV4FYHAPW563HNRAOERP7C@test.waku.nodes.status.im'

REST API is avalable to inspect the node and use protocols:

nim_waku_rest_enabled: true
nim_waku_rest_addr: '127.0.0.1'
nim_waku_rest_port: 8645
nim_waku_rest_apis_enabled: ['admin']

For full docs see API docs page.

There's also a container monitor service.

nim_waku_monitor_enabled: true

Usage

You can re-create containers on the host using:

cd /docker/nim-waku-node
docker-compose --compatibility up -d --force-recreate

Which will use the docker-compose.yml file in that directory.

Requirements

Due to being part of Status infra this role assumes availability of certain things:

• Docker for running containers
• Docker user namespace remapping with dockremap user
• Watchtower for updating Docker images
• The iptables-persistent module

This role also goes well together with infra-role-waku-peers.