From c75e9d20a7079f0b294eaabc249fc97fb2287e94 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=A1clav=20Pavl=C3=ADn?= Date: Mon, 13 Nov 2023 16:06:39 +0100 Subject: [PATCH] only mention .env in readme --- .env.example | 6 ++++++ README.md | 13 ++++--------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/.env.example b/.env.example index 71e228a..858646b 100644 --- a/.env.example +++ b/.env.example @@ -1,4 +1,10 @@ ETH_CLIENT_ADDRESS=wss://sepolia.infura.io/ws/v3/ ETH_TESTNET_KEY=012345privatekey RLN_RELAY_CRED_PASSWORD="my_secure_keystore_password" + +# Advanced +NWAKU_IMAGE= NODEKEY= +DOMAIN= +EXTRA_ARGS= +RLN_RELAY_CONTRACT_ADDRESS= \ No newline at end of file diff --git a/README.md b/README.md index 145e465..627ef9d 100644 --- a/README.md +++ b/README.md @@ -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).