Skip to content

Commit

Permalink
rename expected env file
Browse files Browse the repository at this point in the history
  • Loading branch information
alyssadai committed Nov 17, 2023
1 parent 0b5277c commit 40627d6
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ web_modules/
.env.test.local
.env.production.local
.env.local
fed.env

# parcel-bundler cache (https://parceljs.org/)
.cache
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Please refer to our [**official documentation**](https://neurobagel.org/overview

## Launching the API
### 1. Set the Neurobagel nodes to federate over
Create an `.env` file with the variable `NB_NODES` set to the URLs of the nodes to be federated over.
Create a `fed.env` file with the variable `NB_NODES` set to the URLs of the nodes to be federated over.
The URLs should be stored as a **space-separated, unquoted** string.

e.g.,
Expand All @@ -23,6 +23,6 @@ NB_NODES=https://myfirstnode.org/ https://mysecondnode.org/
docker pull neurobagel/federation_api

# Make sure to run the next command in the same directory where your .env file is
docker run -d --name=federation -p 8080:8000 --env-file=.env neurobagel/federation_api
docker run -d --name=federation -p 8080:8000 --env-file=fed.env neurobagel/federation_api
```
NOTE: You can replace the port number `8080` for the `-p` flag with any port on the host you wish to use for the API.

0 comments on commit 40627d6

Please sign in to comment.