From 1a180da3a32a50217069f2c72b92a2ee8668c6ea Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Wed, 13 Dec 2023 12:13:57 +1100 Subject: [PATCH] doc: document .env file and docker-compose behaviour --- .gitignore | 3 ++- README.md | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 87d7420..c29c039 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ **/.DS_Store +.env keystore postgresql -rln_tree \ No newline at end of file +rln_tree diff --git a/README.md b/README.md index 7bd6ce9..c5d9b8e 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ export ETH_TESTNET_KEY=REPLACE_BY_YOUR_KEY export KEYSTORE_PASSWORD=PICK_A_PASSWORD ``` +`docker-compose` [will read the `./.env` file](https://docs.docker.com/compose/environment-variables/set-environment-variables/#additional-information-3) from the filesystem, so feel free to save these value in a `.env` file. + **🔑 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).