Renamed NB_QUERY_URL_PATH env var to NB_QUERY_APP_BASE_PATH (#77)

neurobagel · Aug 9, 2024 · 9559390 · 9559390
1 parent 4923feb
commit 9559390
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,7 +23,7 @@ First release of the Neurobagel deployment recipe. This release introduces diffe
 #### 🚀 Enhancements
 
 - [CI] Make first release [#76](https://github.com/neurobagel/recipes/pull/76) ([@alyssadai](https://github.com/alyssadai))
-- [ENH] Added `NB_QUERY_URL_PATH` [#69](https://github.com/neurobagel/recipes/pull/69) ([@alyssadai](https://github.com/alyssadai) [@rmanaem](https://github.com/rmanaem))
+- [ENH] Added `NB_QUERY_APP_BASE_PATH` [#69](https://github.com/neurobagel/recipes/pull/69) ([@alyssadai](https://github.com/alyssadai) [@rmanaem](https://github.com/rmanaem))
 - [ENH] add auth vars to n-API & local query tool and disable by default [#67](https://github.com/neurobagel/recipes/pull/67) ([@alyssadai](https://github.com/alyssadai))
 - [ENH] Update environment variables and remove deprecated `version` tag [#65](https://github.com/neurobagel/recipes/pull/65) ([@alyssadai](https://github.com/alyssadai))
 - [ENH] Added `NB_FEDERATE_REMOTE_PUBLIC_NODES` env var [#61](https://github.com/neurobagel/recipes/pull/61) ([@rmanaem](https://github.com/rmanaem))

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -73,7 +73,7 @@ services:
       - "${NB_QUERY_PORT_HOST:-3000}:5173"
     environment:
       NB_API_QUERY_URL: ${NB_API_QUERY_URL}
-      NB_QUERY_URL_PATH: ${NB_QUERY_URL_PATH:-/}
+      NB_QUERY_APP_BASE_PATH: ${NB_QUERY_APP_BASE_PATH:-/}
       NB_ENABLE_AUTH: ${NB_ENABLE_AUTH:-false}
       NB_QUERY_CLIENT_ID: ${NB_QUERY_CLIENT_ID}
 

diff --git a/docs/neurobagel_environment_variables.tsv b/docs/neurobagel_environment_variables.tsv
@@ -20,6 +20,6 @@ Environment variable	Set manually in .env?	Description	Default value if not set
 `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
 `NB_FEDERATE_REMOTE_PUBLIC_NODES`	Yes 	If "True", include public nodes in federation. If "False", only locally specified nodes in `local_nb_nodes.json` are queried.	`true`	Docker, Python
-`NB_QUERY_URL_PATH`	No	The URL path for the query tool, determines the specific URL at which the app should be rendered for users to access it	`/`	Docker
+`NB_QUERY_APP_BASE_PATH`	No	The URL path for the query tool, determines the specific URL at which the app should be rendered for users to access it	`/`	Docker
 `NB_ENABLE_AUTH`	Yes	**(Experimental, for dev deployments only)** Whether to enable authentication for cohort queries. One of [true, false]	`false`	Docker, Python
 `NB_QUERY_CLIENT_ID`	Yes	**(Experimental, for dev deployments only)** OAuth client ID for the query tool. Required if NB_ENABLE_AUTH is set to true.	-	Docker, Python
diff --git a/template.env b/template.env
@@ -71,9 +71,9 @@ NB_RETURN_AGG=true
 NB_API_QUERY_URL=http://XX.XX.XX.XX
 
 # Additional configurable parameters - uncomment to change the defaults
-# Change NB_QUERY_URL_PATH if you're using a proxy server (NGINX, Caddy, etc.) and have configured it so that the query tool is accessible at a path other than the root (`/`). 
-# e.g., if your proxy server is set up so that mynode.org/querytool points to the query tool, you would set NB_QUERY_URL_PATH=/querytool
-# NB_QUERY_URL_PATH=/
+# Change NB_QUERY_APP_BASE_PATH if you're using a proxy server (NGINX, Caddy, etc.) and have configured it so that the query tool is accessible at a path other than the root (`/`). 
+# e.g., if your proxy server is set up so that mynode.org/querytool points to the query tool, you would set NB_QUERY_APP_BASE_PATH=/querytool
+# NB_QUERY_APP_BASE_PATH=/
 # Change NB_QUERY_PORT_HOST if port 3000 is already in use on the machine
 # NB_QUERY_PORT_HOST=3000
 # NB_QUERY_TAG=latest