diff --git a/docs/neurobagel_environment_variables.tsv b/docs/neurobagel_environment_variables.tsv index 3ce1ef8..b73567a 100644 --- a/docs/neurobagel_environment_variables.tsv +++ b/docs/neurobagel_environment_variables.tsv @@ -2,17 +2,17 @@ Environment variable Required in .env? Description Default value if not set Rele `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_GRAPH_DB` No Name of graph database endpoint to query (e.g., for a GraphDB database, this will take the format of `repositories/{database_name}`) `repositories/my_db` 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 `NB_API_TAG` No Docker image tag for the API `latest` Docker `NB_API_PORT_HOST` No Port number on the _host machine_ to map the API container port to `8000` Docker `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 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 +`NB_GRAPH_IMG` No Graph server Docker image `ontotext/graphdb:10.3.1` Docker +`NB_GRAPH_ROOT_HOST` No Path to directory on the _host machine_ to store graph database files and data (the directory does not have to exist beforehand). `~/graphdb-home` Docker +`NB_GRAPH_ROOT_CONT` No Path to directory for graph databases in the _graph server container_ `/opt/graphdb/home` * Docker +`NB_GRAPH_PORT_HOST` No Port number on the _host machine_ to map the graph server container port to `7200` Docker, Python +`NB_GRAPH_PORT` No Port number used by the _graph server container_ `7200` * Docker `NB_QUERY_TAG` No Docker image tag for the query tool `latest` Docker `NB_QUERY_PORT_HOST` No Port number used by the `query_tool` on the host machine `3000` Docker `API_QUERY_URL` Yes, unless default is correct URL of the API that the query tool will send its requests to. The port number in the URL **must** correspond to `NB_API_PORT_HOST`. See also the [query tool README](https://github.com/neurobagel/query-tool?tab=readme-ov-file#set-the-environment-variables). **Must** end in a forward slash `/`! `http://localhost:8000/` Docker \ No newline at end of file diff --git a/local_node/template.env b/local_node/template.env index 0238f0d..eb5afce 100644 --- a/local_node/template.env +++ b/local_node/template.env @@ -9,7 +9,7 @@ NB_API_TAG=latest NB_GRAPH_IMG=ontotext/graphdb:10.3.1 ## ADDITIONAL CONFIGURABLE PARAMETERS: Uncomment and modify values of the below variables as needed to use non-default values. -# NB_API_ALLOWED_ORIGINS="" # Allow multiple origins of requests. e.g. For a query tool deployed locally using default ports, use: NB_API_ALLOWED_ORIGINS="https://localhost:3000 http://localhost:3000" +# NB_API_ALLOWED_ORIGINS="" # Allow multiple origins of requests. e.g. For a query tool deployed locally using default ports, use: NB_API_ALLOWED_ORIGINS="http://localhost:3000 http://127.0.0.1:3000" # NB_API_PORT_HOST=8000 # NB_API_PORT=8000 # NB_GRAPH_ROOT_HOST=~/graphdb-home