Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d26dfa9
fix: point nwaku to proper docker repo and image version
chaitanyaprem Sep 16, 2024
b47ce57
chore: add help command in docker
chaitanyaprem Sep 17, 2024
5026e1c
Merge branch 'develop' into fix/nwaku-ref
chaitanyaprem Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"autoplay",
"classwide",
"devel",
"statusteam",
"wakuorg",
"myaddr",
"extip",
"staticnode",
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/nwaku/config-methods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
14 changes: 12 additions & 2 deletions docs/guides/nwaku/run-docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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 \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, here we would need a generic tag on docker hub also (as we had it before on harbor), like latest-release or so.

--dns-discovery=true \
--dns-discovery-url=enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im \
--discv5-discovery=true \
Expand All @@ -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).
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/research/benchmarks/postgres-adoption.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading