From 4f81fcef1d31cf532c0582e8927f436b43569c33 Mon Sep 17 00:00:00 2001 From: troymc Date: Fri, 24 Jun 2016 11:10:19 +0200 Subject: [PATCH] Docs: added list of env vars near top of configuration.md --- docs/source/nodes/configuration.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/source/nodes/configuration.md b/docs/source/nodes/configuration.md index b15a9d63..a011b89c 100644 --- a/docs/source/nodes/configuration.md +++ b/docs/source/nodes/configuration.md @@ -6,11 +6,28 @@ The value of each configuration setting is determined according to the following * Otherwise, if it's set in a local config file, then use that value * Otherwise, use the default value +For convenience, here's a list of all the relevant environment variables (documented below): + +`BIGCHAINDB_KEYPAIR_PUBLIC`
+`BIGCHAINDB_KEYPAIR_PRIVATE`
+`BIGCHAINDB_KEYRING`
+`BIGCHAINDB_DATABASE_HOST`
+`BIGCHAINDB_DATABASE_PORT`
+`BIGCHAINDB_DATABASE_NAME`
+`BIGCHAINDB_SERVER_BIND`
+`BIGCHAINDB_SERVER_WORKERS`
+`BIGCHAINDB_SERVER_THREADS`
+`BIGCHAINDB_API_ENDPOINT`
+`BIGCHAINDB_CONSENSUS_PLUGIN`
+`BIGCHAINDB_STATSD_HOST`
+`BIGCHAINDB_STATSD_PORT`
+`BIGCHAINDB_STATSD_RATE`
+ The local config file is `$HOME/.bigchaindb` by default (a file which might not even exist), but you can tell BigchainDB to use a different file by using the `-c` command-line option, e.g. `bigchaindb -c path/to/config_file.json start`. You can read the current default values in the file [bigchaindb/\_\_init\_\_.py](https://github.com/bigchaindb/bigchaindb/blob/master/bigchaindb/__init__.py). (The link is to the latest version.) -Running `bigchaindb -y configure` will generate a local config file in `$HOME/.bigchaindb` with all the default values, with two exceptions. It will generate a valid private/public keypair, rather than using the default keypair (`None` and `None`). +Running `bigchaindb -y configure` will generate a local config file in `$HOME/.bigchaindb` with all the default values, with two exceptions: It will generate a valid private/public keypair, rather than using the default keypair (`None` and `None`). ## keypair.public & keypair.private