From 7b54f92d28c5e7ab24142a8ae765412a6db71e60 Mon Sep 17 00:00:00 2001 From: LordGhostX Date: Thu, 15 Jun 2023 04:33:19 +0100 Subject: [PATCH] add tip on cloud service providers --- .cspell.json | 3 ++- docs/guides/nwaku/build-from-source.md | 1 - docs/guides/nwaku/run-docker.md | 30 +++++++++++++++++--------- docs/guides/run-nwaku-node.md | 4 ++-- 4 files changed, 24 insertions(+), 14 deletions(-) diff --git a/.cspell.json b/.cspell.json index ab767a7..7bbc2ab 100644 --- a/.cspell.json +++ b/.cspell.json @@ -44,7 +44,8 @@ "classwide", "devel", "statusteam", - "myaddr" + "myaddr", + "extip" ], "flagWords": [], "ignorePaths": [ diff --git a/docs/guides/nwaku/build-from-source.md b/docs/guides/nwaku/build-from-source.md index e385ca7..6c52f65 100644 --- a/docs/guides/nwaku/build-from-source.md +++ b/docs/guides/nwaku/build-from-source.md @@ -100,7 +100,6 @@ To learn more about running nwaku, please refer to: - [Run a Nwaku Node](/guides/run-nwaku-node#run-the-node) - [Run Nwaku in Docker Container](/guides/nwaku/run-docker) - [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) -- [Run Nwaku on DigitalOcean Droplet](https://github.com/waku-org/nwaku/blob/master/docs/operators/droplet-quickstart.md) ## Run Test Suite diff --git a/docs/guides/nwaku/run-docker.md b/docs/guides/nwaku/run-docker.md index e9f10dc..9b74b04 100644 --- a/docs/guides/nwaku/run-docker.md +++ b/docs/guides/nwaku/run-docker.md @@ -30,11 +30,11 @@ You can also build the Docker image locally using: git clone --recurse-submodules https://github.com/waku-org/nwaku cd nwaku -# Build image using make -make docker-image - # Build image using docker build docker build -t statusteam/nim-waku:latest . + +# Build image using make +make docker-image ``` ## Run Docker Container @@ -49,12 +49,22 @@ docker run [OPTIONS] [IMAGE] [ARG...] - `IMAGE` is the image and tag you pulled from the registry or built locally - `ARG...` is the list of `nwaku` arguments for your [chosen nwaku configuration](https://github.com/waku-org/nwaku/blob/master/docs/operators/how-to/configure.md) -:::tip -We recommend using explicit port mappings (`-p`) when exposing ports accessible from outside the host (libp2p listening ports, discovery, HTTP server). -::: - -To run `nwaku` in a Docker container using the [default configuration](/guides/run-nwaku-node#run-the-node), use: +To run `nwaku` in a Docker container using the most typical configuration, use: ```bash -docker run -i -t -p 60000:60000 -p 8545:8545 statusteam/nim-waku -``` \ No newline at end of file +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: + +```bash +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). +::: \ No newline at end of file diff --git a/docs/guides/run-nwaku-node.md b/docs/guides/run-nwaku-node.md index bf64fdf..74f6062 100644 --- a/docs/guides/run-nwaku-node.md +++ b/docs/guides/run-nwaku-node.md @@ -20,10 +20,10 @@ Before running a `nwaku` node, it is necessary to build it. Nwaku provides multi | Build Source | Build a `nwaku` node directly from the source code | [Build Nwaku from Source](/guides/nwaku/build-from-source) | | Docker Container | Build and run a `nwaku` node in a Docker Container | [Run Nwaku in Docker Container](/guides/nwaku/run-docker) | | Docker Compose | Build and run a `nwaku` node with Docker Compose | [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) | -| DigitalOcean Droplet | Build and run a `nwaku` node on a DigitalOcean Droplet | [Run Nwaku on DigitalOcean Droplet](https://github.com/waku-org/nwaku/blob/master/docs/operators/droplet-quickstart.md) | :::tip -If you want to try the latest `nwaku` updates without compiling the binaries, [download the nightly release](https://github.com/waku-org/nwaku/releases/tag/nightly). +- If you want to try the latest `nwaku` updates without compiling the binaries, [download the nightly release](https://github.com/waku-org/nwaku/releases/tag/nightly). +- You can run `nwaku` binaries and Docker images on cloud service providers like [Google Cloud](https://cloud.google.com/), [Microsoft Azure](https://azure.microsoft.com/), [Amazon Web Services](https://aws.amazon.com/), and [DigitalOcean](https://www.digitalocean.com/). ::: ## Run the Node