Merge pull request #132 from dockersamples/add-local-mode-configurator

Add "local mode" to support locally defined content in a Labspace

Author: mikesir87

components/configurator/setup.sh

@@ -6,15 +6,27 @@ setup_project_directory() {
   echo "📁 Setting up project directory"
 
   clear_project_directory
-  rm -rf /staging
-  mkdir /staging
+  clear_staging_directory
   cd /staging
 
   # Setup project directory
   if [ "$DEV_MODE" = "true" ]; then
     echo "📁 Skipping clone because DEV_MODE is activated (project source will be directly mounted)"
     run_setup_script
     return
+  elif [ "$LOCAL_MODE" = "true" ]; then
+    echo "📁 Local mode enabled."
+    if [ -z "$LOCAL_CONTENT_PATH" ]; then
+      echo "Error: LOCAL_CONTENT_PATH environment variable is not set."
+      exit 1
+    fi
+
+    echo "📁 Using content in ${LOCAL_CONTENT_PATH} as source material"
+    shopt -s dotglob
+    cp -r "${LOCAL_CONTENT_PATH}/"* /staging
+    shopt -u dotglob
+
+    run_setup_script
   else
     if [ -z "$PROJECT_CLONE_URL" ]; then
       echo "Error: PROJECT_CLONE_URL environment variable is not set."
@@ -60,6 +72,13 @@ run_setup_script() {
   fi
 }
 
+clear_staging_directory() {
+  if [ "$DEV_MODE" != "true" ]; then
+    rm -rf /staging
+    mkdir /staging
+  fi
+}
+
 clear_project_directory() {
   cd /project
 

docs/configuration.md

@@ -182,4 +182,29 @@ configs:
       echo ""
       echo "All checks passed! Environment is ready."
       exit 0
-```
+```
+
+
+### Using locally defined Labspace content
+
+When a Labspace starts, it will, by default, clone the content from the content repo. However, there may be situations in which you want to skip this and use locally cloned content, such as running demos.
+
+To do so, you need to:
+
+1. Set the `LOCAL_MODE` environment variable for the `configurator` service to `true`
+2. Mount your content into the `configurator` service
+3. Specify the content location with the `LOCAL_CONTENT_PATH` environment variable in the `configurator` service
+
+When the configurator runs, it will copy all files located at `LOCAL_CONTENT_PATH` into the volume used by the Labspace. Any defined setup scripts will still execute as configured. Since the content is copied, changes to files in the Labspace will change the copied files, making it easy to restart the Labspace from a known and valid state.
+
+The following `compose.override.yaml` will mount the parent directory (since this is in the `.labspace` directory) into the configurator.
+
+```yaml
+services:
+  configurator:
+    volumes:
+      - ../:/custom-content
+    environment:
+      LOCAL_MODE: "true"
+      LOCAL_CONTENT_PATH: /custom-content
+```