Updating readme

This commit is contained in:
Gabriel Mermelstein 2023-10-31 12:30:15 +02:00
parent 73aa44d4b5
commit 8479f117e7
No known key found for this signature in database
GPG Key ID: 306734DDCE542DCD

View File

@ -14,11 +14,11 @@ cd waku-simulator
Configure the simulation parameters. You can place the env variable in an `.env` file.
```
export GOWAKU_IMAGE=statusteam/go-waku:latest
export NWAKU_IMAGE=statusteam/nim-waku:v0.18.0-rc.0
export GOWAKU_IMAGE=wakuorg/go-waku:latest
export NWAKU_IMAGE=wakuorg/nwaku:v0.21.2-rc.0
export NUM_NWAKU_NODES=5
export NUM_GOWAKU_NODES=5
export MSG_PER_SECOND=10
export TRAFFIC_DELAY_SECONDS=15
export MSG_SIZE_KBYTES=10
docker-compose up -d
```
@ -28,7 +28,7 @@ This will:
* spin up grafana/prometheus for monitoring, see `http://localhost:3000`.
* spin up a bootstrap nwaku node.
* spin up a given amount of nwaku/gowaku nodes with specific versions.
* spin up a `waku-publisher` instance that will inject traffic into the network (see flags for rate and msg size)
* spin up a `rest-traffic` instance that will inject traffic into the network (see flags for rate and msg size)
## notes
@ -42,6 +42,12 @@ in case arp tables are overflowing:
sysctl net.ipv4.neigh.default.gc_thresh3=32000
```
Compose V2 users should spin up the containers with the following command:
```
docker-compose --compatibility up -d
```
# Infrastructure
An instance of this service is deployed at https://simulator.waku.org/.