more startup.md fixes

Author: jmjava

embabel-hub/STARTUP.md

@@ -1,4 +1,77 @@
-Frontend: http://localhost:8042
-Neo4j Browser: http://localhost:27474
-(connect to bolt://localhost:27687, username: neo4j, password: embabel123)
-Guide API: http://localhost:1337l
+# Embabel Hub Startup Guide
+
+## Prerequisites
+
+- Docker installed and running
+- `OPENAI_API_KEY` environment variable set (see configuration below)
+
+## Configuration
+
+The `starthub.sh` script automatically sources environment variables from a `.env` file if present.
+
+### Option 1: Using a .env file (Recommended)
+
+Create a `.env` file in either:
+
+- `embabel-hub/.env` (preferred, most specific)
+- `embabel-learning/.env` (parent directory, fallback)
+
+Add your OpenAI API key:
+
+```bash
+OPENAI_API_KEY=your-api-key-here
+```
+
+The script will automatically load this file when run.
+
+### Option 2: Export environment variable
+
+```bash
+export OPENAI_API_KEY=your-api-key-here
+```
+
+### Option 3: Pass inline
+
+```bash
+OPENAI_API_KEY=your-api-key-here ./embabel-hub/starthub.sh
+```
+
+## Starting the Hub
+
+Simply run:
+
+```bash
+./embabel-hub/starthub.sh
+```
+
+The script will:
+
+1. Load environment variables from `.env` if present
+2. Stop and remove any existing container
+3. Start a new embabel-hub container
+4. Wait for the application to start (30-60 seconds)
+5. Verify the web server is responding
+
+## Services
+
+Once started, the following services are available:
+
+- **Guide API**: http://localhost:1337
+- **Neo4j Browser**: http://localhost:27474
+- **Neo4j Bolt**: bolt://localhost:27687
+  - Username: `neo4j`
+  - Password: See container documentation (default: `embabel123` for local dev)
+- **Frontend**: http://localhost:8042
+
+## Troubleshooting
+
+If the web server doesn't start, check the logs:
+
+```bash
+docker logs embabel-hub
+```
+
+Common issues:
+
+- **401 Unauthorized**: Invalid or expired `OPENAI_API_KEY`
+- **Application startup timeout**: Check logs for initialization errors

embabel-hub/starthub.sh

@@ -1,10 +1,32 @@
 #!/bin/bash
 # Start embabel-hub container
-# Requires: OPENAI_API_KEY environment variable
+# Requires: OPENAI_API_KEY environment variable (can be set in .env file or environment)
 
+# Get the directory where this script is located
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PARENT_DIR="$(dirname "$SCRIPT_DIR")"
+
+# Source .env file if it exists (prefer local .env, then parent directory .env)
+if [ -f "$SCRIPT_DIR/.env" ]; then
+    echo "Loading environment from $SCRIPT_DIR/.env"
+    set -a  # automatically export all variables
+    source "$SCRIPT_DIR/.env"
+    set +a  # disable automatic export
+elif [ -f "$PARENT_DIR/.env" ]; then
+    echo "Loading environment from $PARENT_DIR/.env"
+    set -a  # automatically export all variables
+    source "$PARENT_DIR/.env"
+    set +a  # disable automatic export
+fi
+
+# Check if OPENAI_API_KEY is set
 if [ -z "$OPENAI_API_KEY" ]; then
     echo "Error: OPENAI_API_KEY environment variable is not set"
-    echo "Usage: OPENAI_API_KEY=your-key-here ./starthub.sh"
+    echo ""
+    echo "You can set it in one of these ways:"
+    echo "  1. Create a .env file in embabel-hub/ or parent directory with: OPENAI_API_KEY=your-key-here"
+    echo "  2. Export it: export OPENAI_API_KEY=your-key-here"
+    echo "  3. Pass it inline: OPENAI_API_KEY=your-key-here ./starthub.sh"
     exit 1
 fi
 
@@ -17,6 +39,7 @@ if docker ps -a --format '{{.Names}}' | grep -q "^embabel-hub$"; then
 fi
 
 echo "Starting new embabel-hub container..."
+# pragma: allowlist secret
 docker run -d \
   --platform linux/amd64 \
   --name embabel-hub \
@@ -26,16 +49,50 @@ docker run -d \
   -p 8042:8042 \
   -v embabel-neo4j-data:/data \
   -v embabel-neo4j-logs:/logs \
-  -e OPENAI_API_KEY=$OPENAI_API_KEY \
+  -e "OPENAI_API_KEY=$OPENAI_API_KEY" \
   embabel/hub:latest
 
 if [ $? -eq 0 ]; then
     echo "✓ embabel-hub container started successfully"
     echo ""
-    echo "Hub: http://localhost:1337"
-    echo "Neo4j Browser: http://localhost:27474"
-    echo "Neo4j Bolt: bolt://localhost:27687"
-    echo "Additional service: http://localhost:8042"
+    echo "Waiting for application to start (this may take 30-60 seconds)..."
+
+    # Wait up to 60 seconds for the web server to respond
+    max_wait=60
+    elapsed=0
+    while [ $elapsed -lt $max_wait ]; do
+        if curl -s -f http://localhost:1337 > /dev/null 2>&1; then
+            echo "✓ Web server is responding!"
+            break
+        fi
+        sleep 2
+        elapsed=$((elapsed + 2))
+        echo "  Waiting... (${elapsed}s/${max_wait}s)"
+    done
+
+    # Check if server is responding
+    if curl -s -f http://localhost:1337 > /dev/null 2>&1; then
+        echo ""
+        echo "Hub: http://localhost:1337"
+        echo "Neo4j Browser: http://localhost:27474"
+        echo "Neo4j Bolt: bolt://localhost:27687"
+        echo "Additional service: http://localhost:8042"
+    else
+        echo ""
+        echo "⚠ Warning: Container started but web server is not responding"
+        echo ""
+        echo "Checking container logs for errors..."
+        echo "Recent errors:"
+        docker logs embabel-hub 2>&1 | grep -i "error\|exception\|401\|unauthorized" | tail -5 || echo "No obvious errors found"
+        echo ""
+        echo "To view full logs: docker logs embabel-hub"
+        echo "To check container status: docker ps -a | grep embabel-hub"
+        echo ""
+        echo "Common issues:"
+        echo "  - Invalid or expired OPENAI_API_KEY (check for 401 errors in logs)"
+        echo "  - Application startup timeout (check logs for startup errors)"
+        exit 1
+    fi
 else
     echo "✗ Failed to start embabel-hub container"
     exit 1