tools

Other helpful tools for interfacing with Neurobagel

Steps to deploy

1. Create a file containing a private key for the Neurobagel Bot app
2. Create a .env file with the following variables:
   • NB_BOT_ID: the app ID of the Neurobagel Bot app, which you can find on the settings page for the app
   • HOST_NB_BOT_KEY_PATH: the path to the private key file on your machine (if not provided, will default to ./private_key.pem)
   • (OPTIONAL) NB_UPLOADER_API_ROOT_PATH: if using a proxy server that serves this app from a path/subdirectory, the path prefix declared for this app (that will be stripped by the proxy), e.g., /upload.
     ⚠️ Should not include a trailing slash!
3. Navigate to the root of the repository and run:

   docker compose up -d

Setting up a development environment

If running the OpenNeuro Uploader API as a Python app, ensure that the following environment variables are set:

• NB_BOT_ID: the app ID of the Neurobagel Bot app (found on the settings page for the app)
• NB_BOT_KEY_PATH: path to a file containing a private key for the Neurobagel Bot app