mirror of
https://github.com/waku-org/go-waku-compose.git
synced 2025-02-22 08:58:06 +00:00
nwaku-compose
Ready to use docker-compose to run your own nwaku full node. Features:
- nwaku node running relay and store protocols with RLN enabled.
- simple frontend to interact with your node and the network, to publish and receive messages.
- grafana dashboard for advances users or node operators.
You need docker-compose
and git
.
Get the code:
git clone git@github.com:waku-org/nwaku-compose.git
cd nwaku-compose
Waku needs an Ethereum Sepolia node, either yours or from a third party. Provide a websockets endpoint. You can get one for free from Infura.
export ETH_CLIENT_ADDRESS=wss://sepolia.infura.io/ws/v3/USE_YOUR_INFURA_KEY_HERE
Start everything.
docker-compose up -d
Your node is now connected to the network:
- See localhost:4000 to interact with your node
- See localhost:3000 for advanced metrics.
If you just want to relay traffic in the network, you are all set. If you want to publish messages, you would need an RLN membership. For that you need:
- A wallet with some Sepolia Eth, <0.1 Eth.
- Go to localhost:4000 and
Register Credentials
. Set apassword`` and
Exportit as
keystore.json` - In your nwaku node, set:
rln-relay-cred-password
to thepassword
you chose.rln-relay-cred-path
tokeystore.json
Note: TODO: This last step of setting the keystore.json is quite manual. To be improved.
For advanced documentation, refer to ADVANCED.md.
Description
Languages
Shell
100%