Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Problem: No docs about how config setting env var name determined

Browse Source 
Solution: Explain and show the relationship between the config-file name and the environment variable name of config settings
This commit is contained in:
Troy McConaghy 2018-08-14 16:32:52 +02:00
parent ceed40e4d8
commit 0f8166ac3b
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/server/source/server-reference/configuration.md
View File

@ -1,6 +1,14 @@
# Configuration Settings # 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 * 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 * Otherwise, if it's set in a local config file, then use that value