[DOC] Generalized environment variables' table (#198)

* Generalized env var table * Updated docs/api_environment_variables.tsv --------- Co-authored-by: Alyssa Dai <[email protected]>
neurobagel · Oct 10, 2023 · d63d262 · d63d262
1 parent d6eba9f
commit d63d262
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/docs/api_environment_variables.tsv b/docs/api_environment_variables.tsv
@@ -1,6 +1,6 @@
 Environment variable	Required in .env?	Description	Default value if not set	Relevant installation mode(s)
-`NB_GRAPH_USERNAME`	Yes	Username to access Stardog graph database that API will communicate with	-	Docker, Python
-`NB_GRAPH_PASSWORD`	Yes	Password to access Stardog graph database that API will communicate with	-	Docker, Python
+`NB_GRAPH_USERNAME`	Yes	Username to access graph database that API will communicate with	-	Docker, Python
+`NB_GRAPH_PASSWORD`	Yes	Password to access graph database that API will communicate with	-	Docker, Python
 `NB_GRAPH_ADDRESS`	No	IP address for the graph database (or container name, if graph is hosted locally)	`206.12.99.17 (graph)` **	Docker, Python
 `NB_GRAPH_DB`	No	Name of graph database endpoint to query (e.g., for a Stardog database, this will take the format of `{database_name}/query`)	`test_data/query`	Docker, Python
 `NB_RETURN_AGG`	No	Whether to return only dataset-level query results (including data locations) and exclude subject-level attributes. One of [true, false]	`true`	Docker, Python
@@ -9,7 +9,7 @@ Environment variable	Required in .env?	Description	Default value if not set	Rele
 `NB_API_PORT`	No	Port number on which to run the API	`8000`	Docker, Python
 `NB_API_ALLOWED_ORIGINS`	Yes, if using a frontend query tool ‡	Origins allowed to make cross-origin resource sharing requests. Multiple origins must be separated with spaces in a single string enclosed in quotes. See ‡ for more info	"`""""`"	Docker, Python
 `NB_GRAPH_IMG`	No	Graph server Docker image	`stardog/stardog:8.2.2-java11-preview`	Docker
-`NB_GRAPH_ROOT_HOST`	No	Path to directory containing a Stardog license file on the _host machine_	`~/stardog-home`	Docker
+`NB_GRAPH_ROOT_HOST`	No	Path to directory on the _host machine_ to store graph database files and data. For a Stardog backend, this directory must contain a Stardog license file.	`~/stardog-home`	Docker
 `NB_GRAPH_ROOT_CONT`	No	Path to directory for graph databases in the _graph server container_	`/var/opt/stardog` *	Docker
 `NB_GRAPH_PORT_HOST`	No	Port number on the _host machine_ to map the graph server container port to	`5820`	Docker, Python
 `NB_GRAPH_PORT`	No	Port number used by the _graph server container_	`5820` *	Docker