From 009a7cd71e764cc6c336fa16568a110989f8d774 Mon Sep 17 00:00:00 2001
From: LUIS NOVO <lfnovo@gmail.com>
Date: Mon, 20 Oct 2025 17:26:16 -0300
Subject: [PATCH] docs: increase database info exposure

---
 README.md                              | 16 ++++++++++++++++
 docs/getting-started/5-minute-setup.md | 12 ++++++++++++
 docs/getting-started/quick-start.md    |  4 ++--
 3 files changed, 30 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b7850bc..ae67dac 100644
--- a/README.md
+++ b/README.md
@@ -129,6 +129,11 @@ docker run -d \
   -v ./notebook_data:/app/data \
   -v ./surreal_data:/mydata \
   -e OPENAI_API_KEY=your_key_here \
+  -e SURREAL_URL="ws://localhost:8000/rpc" \
+  -e SURREAL_USER="root" \
+  -e SURREAL_PASSWORD="root" \
+  -e SURREAL_NAMESPACE="open_notebook" \
+  -e SURREAL_DATABASE="production" \
   lfnovo/open_notebook:v1-latest-single
 ```
 
@@ -150,6 +155,11 @@ docker run -d \
   -v ./surreal_data:/mydata \
   -e OPENAI_API_KEY=your_key_here \
   -e API_URL=http://YOUR_SERVER_IP:5055 \
+  -e SURREAL_URL="ws://localhost:8000/rpc" \
+  -e SURREAL_USER="root" \
+  -e SURREAL_PASSWORD="root" \
+  -e SURREAL_NAMESPACE="open_notebook" \
+  -e SURREAL_DATABASE="production" \
   lfnovo/open_notebook:v1-latest-single
 ```
 
@@ -188,6 +198,12 @@ services:
       - OPENAI_API_KEY=your_key_here
       # For remote access, uncomment and set your server IP/domain:
       # - API_URL=http://192.168.1.100:5055
+      # Database connection (required for single-container)
+      - SURREAL_URL=ws://localhost:8000/rpc
+      - SURREAL_USER=root
+      - SURREAL_PASSWORD=root
+      - SURREAL_NAMESPACE=open_notebook
+      - SURREAL_DATABASE=production
     volumes:
       - ./notebook_data:/app/data
       - ./surreal_data:/mydata
diff --git a/docs/getting-started/5-minute-setup.md b/docs/getting-started/5-minute-setup.md
index 93d1b4e..22a9ac7 100644
--- a/docs/getting-started/5-minute-setup.md
+++ b/docs/getting-started/5-minute-setup.md
@@ -41,6 +41,12 @@ services:
       - "5055:5055"  # API
     environment:
       - OPENAI_API_KEY=REPLACE_WITH_YOUR_KEY
+      # Database connection (required)
+      - SURREAL_URL=ws://localhost:8000/rpc
+      - SURREAL_USER=root
+      - SURREAL_PASSWORD=root
+      - SURREAL_NAMESPACE=open_notebook
+      - SURREAL_DATABASE=production
     volumes:
       - ./notebook_data:/app/data
       - ./surreal_data:/mydata
@@ -70,6 +76,12 @@ services:
     environment:
       - OPENAI_API_KEY=REPLACE_WITH_YOUR_KEY
       - API_URL=http://REPLACE_WITH_SERVER_IP:5055
+      # Database connection (required)
+      - SURREAL_URL=ws://localhost:8000/rpc
+      - SURREAL_USER=root
+      - SURREAL_PASSWORD=root
+      - SURREAL_NAMESPACE=open_notebook
+      - SURREAL_DATABASE=production
     volumes:
       - ./notebook_data:/app/data
       - ./surreal_data:/mydata
diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md
index f0cfbce..5331c6d 100644
--- a/docs/getting-started/quick-start.md
+++ b/docs/getting-started/quick-start.md
@@ -51,7 +51,7 @@ services:
 # Replace YOUR_OPENAI_API_KEY_HERE with your actual API key
 OPENAI_API_KEY=YOUR_OPENAI_API_KEY_HERE
 
-# Database settings (don't change these)
+# Database connection (required for single-container)
 SURREAL_URL="ws://localhost:8000/rpc"
 SURREAL_USER="root"
 SURREAL_PASSWORD="root"
@@ -87,7 +87,7 @@ OPENAI_API_KEY=YOUR_OPENAI_API_KEY_HERE
 # Example: API_URL=http://192.168.1.100:5055
 API_URL=http://YOUR_SERVER_IP:5055
 
-# Database settings (don't change these)
+# Database connection (required for single-container)
 SURREAL_URL="ws://localhost:8000/rpc"
 SURREAL_USER="root"
 SURREAL_PASSWORD="root"