docs.waku.org/docs/guides/nwaku/run-docker.md
2023-06-15 21:42:35 +01:00

2.3 KiB

title
Run Nwaku in Docker Container

This guide provides detailed steps to build and run a nwaku node in a Docker container. If you prefer a pre-configured setup that includes a monitoring dashboard, see the Run Nwaku with Docker Compose guide.

Prerequisites

Ensure Docker is installed on your system using the appropriate instructions provided in the Docker documentation. For example, you can use Docker's convenience script for installation:

curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

Get Docker Image

The Nwaku Docker images are available on the Docker Hub public registry under the statusteam/nim-waku repository. Please visit statusteam/nim-waku/tags for images of specific releases.

Pull the latest docker image:

docker pull statusteam/nim-waku

You can also build the Docker image locally:

# Clone the repository
git clone --recurse-submodules https://github.com/waku-org/nwaku
cd nwaku

# Build image using docker build
docker build -t statusteam/nim-waku:latest .

# Build image using make
make docker-image

Run Docker Container

Run nwaku in a new Docker container:

docker run [OPTIONS] [IMAGE] [ARG...]

Run nwaku using the most typical configuration:

docker run -i -t -p 60000:60000 -p 9000:9000/udp statusteam/nim-waku \
  --dns-discovery:true \
  --dns-discovery-url:enrtree://AOGECG2SPND25EEFMAJ5WF3KSGJNSGV356DSTL2YVLLZWIV6SAYBM@prod.waku.nodes.status.im \
  --discv5-discovery \
  --nat:extip:[YOUR PUBLIC IP] # or, if you are behind a nat: --nat=any

:::tip To find your public IP, use:

dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}'

We recommend using explicit port mappings (-p) when exposing ports accessible from outside the host (libp2p listening ports, discovery, HTTP server). :::