From 4ddfef6204065cba8f84fc481bd982d2a026f6d9 Mon Sep 17 00:00:00 2001 From: Matthew Slipper Date: Tue, 28 Aug 2018 01:28:27 -0700 Subject: [PATCH] Add documentation regarding environment variables Closes #1973. --- docs/validators/security.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/validators/security.md b/docs/validators/security.md index d3e3d6988d..5ccf988148 100644 --- a/docs/validators/security.md +++ b/docs/validators/security.md @@ -39,3 +39,14 @@ Sentry Nodes should edit their config.toml: # Comma separated list of peer IDs to keep private (will not be gossiped to other peers) private_peer_ids = "ipaddress of validator nodes" ``` + +## Environment Variables + +By default, uppercase environment variables with the following prefixes will replace lowercase command-line flags: + +- `GA` (for Gaia flags) +- `TM` (for Tendermint flags) +- `BC` (for democli or basecli flags) + +For example, the environment variable `GA_CHAIN_ID` will map to the command line flag `--chain-id`. Note that while explicit command-line flags will take precedence over environment variables, environment variables will take precedence over any of your configuration files. For this reason, it's imperative that you lock down your environment such that any critical parameters are defined as flags on the CLI or prevent modification of any environment variables. + \ No newline at end of file