doc: Docs on editing runtime config for services, structure tool env …

…comments (#417) * Docs on editing runtime config for services, structure tool env comments * Reverted code comment * Update CONTRIBUTE.md Co-authored-by: Hari John Kuriakose <[email protected]> Signed-off-by: Chandrasekharan M <[email protected]> * Updated doc on structure tool env --------- Signed-off-by: Chandrasekharan M <[email protected]> Co-authored-by: Hari John Kuriakose <[email protected]>
Zipstack · Jul 11, 2024 · 4cf7770 · 4cf7770
1 parent f66c8ff
commit 4cf7770
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
@@ -15,7 +15,7 @@ Use LLMs to eliminate manual processes involving unstructured data.
 
 Just run the `run-platform.sh` launch script to get started in few minutes.
 
-The launch script does env setup with default values, pulls public docker images or builds them locally and finally runs them in containers.
+The launch script configures the env with sane defaults, pulls public docker images or builds them locally and finally runs them in containers.
 
 ```bash
 # Pull and run entire Unstract platform with default env config.
@@ -45,6 +45,7 @@ The launch script does env setup with default values, pulls public docker images
 
 Now visit [http://frontend.unstract.localhost](http://frontend.unstract.localhost) in your browser.
 
+NOTE: Modify the `.env` files present in each service folder to update its runtime behaviour. Run docker compose up again for the changes to take effect.```
 That's all. Enjoy!
 
 ## Authentication

diff --git a/backend/sample.env b/backend/sample.env
@@ -88,7 +88,8 @@ PROMPT_PORT=3003
 #Prompt Studio
 PROMPT_STUDIO_FILE_PATH=/app/prompt-studio-data
 
-# Structure Tool
+# Structure Tool Image (Runs prompt studio exported tools)
+# https://hub.docker.com/r/unstract/tool-structure
 STRUCTURE_TOOL_IMAGE_URL="docker:unstract/tool-structure:0.0.30"
 STRUCTURE_TOOL_IMAGE_NAME="unstract/tool-structure"
 STRUCTURE_TOOL_IMAGE_TAG="0.0.30"

diff --git a/run-platform.sh b/run-platform.sh
@@ -8,6 +8,7 @@ blue_text='\033[94m'
 green_text='\033[32m'
 red_text='\033[31m'
 default_text='\033[39m'
+yellow_text='\033[33m'
 
 # set -x/xtrace uses PS4 for more info
 PS4="$blue_text""${0}:${LINENO}: ""$default_text"
@@ -252,6 +253,9 @@ run_services() {
   echo -e "\nOnce the services are up, visit ""$blue_text""http://frontend.unstract.localhost""$default_text"" in your browser."
   echo "See logs with:"
   echo -e "    ""$blue_text""$docker_compose_cmd -f docker/docker-compose.yaml logs -f""$default_text"
+  echo -e "Configure services by updating their ""$yellow_text"".env""$default_text"" files."
+  echo "Make sure to restart the services with:"
+  echo -e "    ""$blue_text""$docker_compose_cmd -f docker/docker-compose.yaml up -d""$default_text"
 
   popd 1>/dev/null
 }