From 29dcca7570980f71643e9edc080a00312a312434 Mon Sep 17 00:00:00 2001 From: Alyssa Dai Date: Tue, 23 Apr 2024 17:12:51 -0400 Subject: [PATCH] [ENH] Add `COMPOSE_PROJECT_NAME` to template.env (#48) * Add COMPOSE_PROJECT_NAME to template.env Co-authored-by: Sebastian Urchs --------- Co-authored-by: Sebastian Urchs --- template.env | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/template.env b/template.env index 4e121a6..6e819c6 100644 --- a/template.env +++ b/template.env @@ -4,6 +4,19 @@ # Tip: To verify your changes to the .env have taken effect, run the command: docker compose config # For more information on each environment variable, see the Neurobagel documentation. +# ---- PROJECT NAME ---- +# Controls the base name of the docker compose services when launched. +# Replace neurobagel_node with an informative name based on your data and/or deployment profile +# This is optional but will be used to group together your Neurobagel Docker containers in the list of running containers (i.e., `docker ps`), +# making them easier to identify if you need to run multiple Neurobagel service stacks on different ports. +# +# e.g., If you wish to deploy the local_node profile to set up a local Neurobagel node for the ABIDE database, +# and the local_federation profile to also set up local federation, +# you could set COMPOSE_PROJECT_NAME=abide and COMPOSE_PROJECT_NAME=federation, respectively, in the .env file for each recipe. +# +# Note: Must not include any spaces or uppercase letters. +COMPOSE_PROJECT_NAME=neurobagel_node + # ---- CONFIGURATION FOR graph ---- # Replace ADMINPASSWORD with the secure password you want to set for the admin user NB_GRAPH_ADMIN_PASSWORD=ADMINPASSWORD