Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REF] Rename API_QUERY_URL to NB_API_QUERY_URL #26

Merged
merged 1 commit into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/neurobagel_environment_variables.tsv
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Environment variable Required in .env? Description Default value if not set Rele
`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
`NB_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
2 changes: 1 addition & 1 deletion local_federation/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ services:
ports:
- "${NB_QUERY_PORT_HOST:-3000}:3000"
environment:
- API_QUERY_URL=${API_QUERY_URL:-http://localhost:8000/}
- NB_API_QUERY_URL=${NB_API_QUERY_URL:-http://localhost:8000/}
2 changes: 1 addition & 1 deletion local_federation/template.env
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ NB_API_TAG=latest

# ---- CONFIGURATION FOR QUERY TOOL ----
# URL of the f-API as it will appear to a user
API_QUERY_URL=http://localhost:8080
NB_API_QUERY_URL=http://localhost:8080
# Docker image tag of the query tool (default latest)
NB_QUERY_TAG=latest
# Port that the query tool will be exposed on the host and likely the network (default 3000)
Expand Down
2 changes: 1 addition & 1 deletion local_node/template.env
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ NB_GRAPH_IMG=ontotext/graphdb:10.3.1
# NB_GRAPH_PORT=7200
# NB_QUERY_TAG=latest
# NB_QUERY_PORT_HOST=3000
# API_QUERY_URL=http://localhost:8000/
# NB_API_QUERY_URL=http://localhost:8000/
2 changes: 1 addition & 1 deletion local_node_with_query_tool/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ services:
ports:
- "${NB_QUERY_PORT_HOST:-3000}:3000"
environment:
API_QUERY_URL: "${API_QUERY_URL:-http://localhost:8000/}"
NB_API_QUERY_URL: "${NB_API_QUERY_URL:-http://localhost:8000/}"
2 changes: 1 addition & 1 deletion local_node_with_query_tool/template.env
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ NB_RETURN_AGG=true
NB_API_TAG=latest
NB_API_ALLOWED_ORIGINS="https://localhost:3000 http://localhost:3000" # e.g., allow multiple origins from a query tool deployed locally with default port settings; edit as needed for your setup
NB_GRAPH_IMG=ontotext/graphdb:10.3.1
API_QUERY_URL=http://localhost:8000/
NB_API_QUERY_URL=http://localhost:8000/

## ADDITIONAL CONFIGURABLE PARAMETERS: Uncomment and modify values of the below variables as needed to use non-default values.
# NB_API_PORT_HOST=8000
Expand Down