waku-org/nwaku-compose
1
0
Fork 0
mirror of https://github.com/waku-org/nwaku-compose.git synced 2025-02-10 14:26:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

only mention .env in readme

Browse Source
This commit is contained in:
Václav Pavlín 2023-11-13 16:06:39 +01:00
parent 7b8cebc0ce
commit c75e9d20a7
No known key found for this signature in database
GPG Key ID: B378FB31BB6D89A5
2 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.env.example
View File

@ -1,4 +1,10 @@
ETH_CLIENT_ADDRESS=wss://sepolia.infura.io/ws/v3/<key>
ETH_TESTNET_KEY=012345privatekey
RLN_RELAY_CRED_PASSWORD="my_secure_keystore_password"
# Advanced
NWAKU_IMAGE=
NODEKEY=
DOMAIN=
EXTRA_ARGS=
RLN_RELAY_CONTRACT_ADDRESS=

13
README.md
View File

@ -14,20 +14,15 @@ You need:
* Ethereum Sepolia account with some balance <0.01 Eth. Get some [here](https://www.infura.io/faucet/sepolia).
* A password to protect your rln membership.
You can either export the environment variable (keep in mind that this will expose your secrets in your shell history)
```
export ETH_CLIENT_ADDRESS=wss://sepolia.infura.io/ws/v3/YOUR_INFURA_KEY
export ETH_TESTNET_KEY=REPLACE_BY_YOUR_KEY
export RLN_RELAY_CRED_PASSWORD=PICK_A_PASSWORD
```
Or you can use `.env` file - copy the example and edit the variables inside
There is `.env.example` available for you as a template to use for providing the above values. The process when working with `.env` files is to copy the `.env.example`, store it as `.env` and edit the values there.
```
cp .env.example .env
${EDITOR} .env
```
Make sure to **NOT** place any secrets into `.env.example`, as they might be unintentionally published in the Git repository.
**🔑 1. Register RLN membership**
The RLN membership is your access key to The Waku Network. Its registration is done onchain, and allows your nwaku node to publish messages in a decentralized and private way, respecting some [rate limits](https://rfc.vac.dev/spec/64/#rate-limit-exceeded).