fix: point nwaku to proper docker repo and image version (#217)

* fix: point nwaku to proper docker repo and image version

* chore: add help command in docker

---------

Co-authored-by: fryorcraken <110212804+fryorcraken@users.noreply.github.com>
This commit is contained in:
Prem Chaitanya Prathi 2025-05-20 11:01:12 +05:30 committed by GitHub
parent bc618877de
commit 27ebcd762c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 17 additions and 7 deletions

View File

@ -40,7 +40,7 @@
"autoplay",
"classwide",
"devel",
"statusteam",
"wakuorg",
"myaddr",
"extip",
"staticnode",

View File

@ -25,7 +25,7 @@ Node configuration is primarily done using command line options, which override
When running your node with Docker, provide the command line options after the image name in this format:
```shell
docker run statusteam/nim-waku --tcp-port=65000
docker run wakuorg/nwaku --tcp-port=65000
```
## Environment variables
@ -41,7 +41,7 @@ WAKUNODE2_TCP_PORT=65000 ./build/wakunode2
When running your node with Docker, start the node using the `-e` command option:
```shell
docker run -e "WAKUNODE2_TCP_PORT=65000" statusteam/nim-waku
docker run -e "WAKUNODE2_TCP_PORT=65000" wakuorg/nwaku
```
:::info
@ -72,7 +72,7 @@ You can also specify the configuration file via environment variables:
WAKUNODE2_CONFIG_FILE=[TOML CONFIGURATION FILE] ./build/wakunode2
# Using environment variables with Docker
docker run -e "WAKUNODE2_CONFIG_FILE=[TOML CONFIGURATION FILE]" statusteam/nim-waku
docker run -e "WAKUNODE2_CONFIG_FILE=[TOML CONFIGURATION FILE]" wakuorg/nwaku
```
:::info

View File

@ -15,7 +15,7 @@ We recommend running a `nwaku` node with at least 2GB of RAM, especially if `WSS
## Get Docker image
The Nwaku Docker images are available on the Docker Hub public registry under the [statusteam/nim-waku](https://hub.docker.com/r/statusteam/nim-waku) repository. Please visit [statusteam/nim-waku/tags](https://hub.docker.com/r/statusteam/nim-waku/tags) for images of specific releases.
The Nwaku Docker images are available on the Docker Hub public registry under the [wakuorg/nwaku](https://hub.docker.com/r/wakuorg/nwaku) repository. Please visit [wakuorg/nwaku/tags](https://hub.docker.com/r/wakuorg/nwaku/tags) for images of specific releases.
## Build Docker image
@ -45,7 +45,7 @@ docker run [OPTIONS] [IMAGE] [ARG...]
Run `nwaku` using the most typical configuration:
```shell
docker run -i -t -p 60000:60000 -p 9000:9000/udp statusteam/nim-waku:v0.20.0 \
docker run -i -t -p 60000:60000 -p 9000:9000/udp wakuorg/nwaku:v0.32.0 \
--dns-discovery=true \
--dns-discovery-url=enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im \
--discv5-discovery=true \
@ -58,6 +58,16 @@ To find your public IP, use:
dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}'
```
For more detailed information about all possible configurations, please run
```shell
docker run -t wakuorg/nwaku:v0.32.0 --help
```
:::info
Note that running a node in The Waku Network (--cluster-id=1) requires a special set of configurations and therefore, it is recommended to run in this case with docker compose
:::
:::info
We recommend using explicit port mappings (`-p`) when exposing ports accessible from outside the host (listening and discovery ports, API servers).
:::

View File

@ -78,7 +78,7 @@ In this case, we are comparing *Store* performance by means of Rest service.
- node_c: one _nwaku_ node with *REST* enabled and acting as a *Store client* for node_a.
- node_d: one _nwaku_ node with *REST* enabled and acting as a *Store client* for node_b.
- With _jmeter_, 10 users make *REST* *Store* requests concurrently to each of the “rest” nodes (node_c and node_d.)
- All _nwaku_ nodes running statusteam/nim-waku:v0.19.0
- All _nwaku_ nodes running wakuorg/nwaku:v0.32.0
[This](https://github.com/waku-org/test-waku-query/blob/master/docker/jmeter/http_store_requests.jmx) is the _jmeter_ project used.