From fed37ecfcbfb5b13f1b8428d275819b2a4fd3c9e Mon Sep 17 00:00:00 2001
From: Edouard Hur <3418467+hekmon@users.noreply.github.com>
Date: Wed, 26 Feb 2020 12:23:06 +0100
Subject: [PATCH] add envvars details (#337)

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index c07eb4010..a151bc252 100644
--- a/README.md
+++ b/README.md
@@ -115,6 +115,13 @@ Ports may be altered by setting `-httpListenAddr` on the corresponding nodes.
 
 It is recommended setting up [monitoring](#monitoring) for the cluster.
 
+#### Environment variables
+
+Each flag values can be set thru environment variables by following these rules:
+
+- The `-envflag.enable` flag must be set
+- Each `.` in flag names must be substituted by `_` (for example `-insert.maxQueueDuration <duration>` will translate to `insert_maxQueueDuration=<duration>`)
+- For repeating flags, an alternative syntax can be used by joining the different values into one using `,` as separator (for example `-storageNode <nodeA> -storageNode <nodeB>` will translate to `storageNode=<nodeA>,<nodeB>`)
 
 ### Monitoring