Skip to content

Commit

Permalink
Add book link
Browse files Browse the repository at this point in the history
  • Loading branch information
alrevuelta authored Jun 12, 2024
1 parent e08c84e commit f39ac25
Showing 1 changed file with 2 additions and 19 deletions.
21 changes: 2 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# waku-simulator

## Requires
* docker
* docker-compose
Check 📖 [The Waku Simulator Book](https://waku-org.github.io/waku-simulator/)📖

## How to run
## Quickstart

```
git clone https://github.com/waku-org/waku-simulator.git
Expand All @@ -26,21 +24,6 @@ export RLN_RELAY_MSG_LIMIT=2
docker-compose --compatibility up -d
```


This will:
* create a private blockchain and attach a block explorer.
* deploy RLN contract to it.
* spin up a bootstrap nwaku node.
* spin up a given amount of nwaku nodes with specific versions.
* register an RLN membership for each nwaku node.
* spin up a `rest-traffic` instance that will inject traffic into the network via the REST API.
* see block-explorer `http://localhost:3000`.
* see grafana with node metrics `http://localhost:3001`.

## notes

The default login/password for grafana is `admin`/`admin`.

## warning

in case arp tables are overflowing:
Expand Down

0 comments on commit f39ac25

Please sign in to comment.