From 0f8166ac3ba790658539abcb8e25d35f7f38dbb4 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Tue, 14 Aug 2018 16:32:52 +0200 Subject: [PATCH] Problem: No docs about how config setting env var name determined Solution: Explain and show the relationship between the config-file name and the environment variable name of config settings --- docs/server/source/server-reference/configuration.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/server/source/server-reference/configuration.md b/docs/server/source/server-reference/configuration.md index c7bf3d80..a8a17092 100644 --- a/docs/server/source/server-reference/configuration.md +++ b/docs/server/source/server-reference/configuration.md @@ -1,6 +1,14 @@ # Configuration Settings -The value of each BigchainDB Server configuration setting is determined according to the following rules: +Every BigchainDB Server configuration setting has two names: a config-file name and an environment variable name. For example, one of the settings has the config-file name `database.host` and the environment variable name `BIGCHAINDB_DATABASE_HOST`. Here are some more examples: + +`database.port` ↔ `BIGCHAINDB_DATABASE_PORT` + +`database.keyfile_passphrase` ↔ `BIGCHAINDB_DATABASE_KEYFILE_PASSPHRASE` + +`server.bind` ↔ `BIGCHAINDB_SERVER_BIND` + +The value of each setting is determined according to the following rules: * If it's set by an environment variable, then use that value * Otherwise, if it's set in a local config file, then use that value