From 746218248caea63afc9a17d3b67d7adb8d636ac2 Mon Sep 17 00:00:00 2001
From: Luis Novo <lfnovo@gmail.com>
Date: Mon, 6 Apr 2026 08:15:33 -0300
Subject: [PATCH] docs: add surrealdb service notes to docker-compose snippets

The v1-latest image requires a separate surrealdb service unlike the
deprecated single-container image. Add comments pointing to the full
base docker-compose.yml in all partial code examples.
---
 docs/5-CONFIGURATION/ollama.md            | 7 +++++--
 docs/5-CONFIGURATION/openai-compatible.md | 2 ++
 docs/5-CONFIGURATION/reverse-proxy.md     | 7 ++++++-
 docs/5-CONFIGURATION/security.md          | 3 ++-
 4 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/docs/5-CONFIGURATION/ollama.md b/docs/5-CONFIGURATION/ollama.md
index 58e9fa9..853fc31 100644
--- a/docs/5-CONFIGURATION/ollama.md
+++ b/docs/5-CONFIGURATION/ollama.md
@@ -85,6 +85,7 @@ ollama serve
 On Linux, `host.docker.internal` doesn't resolve automatically like it does on macOS/Windows. You must add `extra_hosts` to your docker-compose.yml:
 
 ```yaml
+# Add to your docker-compose.yml (requires surrealdb service, see installation guide)
 services:
   open_notebook:
     image: lfnovo/open_notebook:v1-latest
@@ -117,7 +118,8 @@ When both Open Notebook and Ollama run in the same Docker Compose stack:
 **Docker Compose Example:**
 
 ```yaml
-version: '3.8'
+# Requires surrealdb service — see full base setup:
+# https://github.com/lfnovo/open-notebook/blob/main/docker-compose.yml
 services:
   open-notebook:
     image: lfnovo/open_notebook:v1-latest
@@ -129,7 +131,6 @@ services:
       - OPEN_NOTEBOOK_ENCRYPTION_KEY=change-me-to-a-secret-string
     volumes:
       - ./notebook_data:/app/data
-      - ./surreal_data:/mydata
     depends_on:
       - ollama
 
@@ -425,6 +426,7 @@ ollama run gemma3:12b "Hello, world"
 If you see `Name or service not known` errors on Linux, add `extra_hosts` to your docker-compose.yml:
 
 ```yaml
+# Add to your docker-compose.yml (requires surrealdb service, see installation guide)
 services:
   open_notebook:
     image: lfnovo/open_notebook:v1-latest
@@ -568,6 +570,7 @@ export ESPERANTO_SSL_VERIFY=false
 
 **Docker Compose example with SSL configuration:**
 ```yaml
+# Add to your docker-compose.yml (requires surrealdb service, see installation guide)
 services:
   open-notebook:
     image: lfnovo/open_notebook:v1-latest
diff --git a/docs/5-CONFIGURATION/openai-compatible.md b/docs/5-CONFIGURATION/openai-compatible.md
index 508ecbc..0e2fd4c 100644
--- a/docs/5-CONFIGURATION/openai-compatible.md
+++ b/docs/5-CONFIGURATION/openai-compatible.md
@@ -158,6 +158,7 @@ In **Settings → API Keys**, add an **OpenAI-Compatible** credential with base
 ### Docker Compose Example
 
 ```yaml
+# Add to your docker-compose.yml (requires surrealdb service, see installation guide)
 services:
   text-gen:
     image: atinoda/text-generation-webui:default
@@ -196,6 +197,7 @@ In **Settings → API Keys**, add an **OpenAI-Compatible** credential with base
 ### Docker Compose with GPU
 
 ```yaml
+# Add to your docker-compose.yml (requires surrealdb service, see installation guide)
 services:
   vllm:
     image: vllm/vllm-openai:latest
diff --git a/docs/5-CONFIGURATION/reverse-proxy.md b/docs/5-CONFIGURATION/reverse-proxy.md
index dcc3f80..3bc9ac9 100644
--- a/docs/5-CONFIGURATION/reverse-proxy.md
+++ b/docs/5-CONFIGURATION/reverse-proxy.md
@@ -75,6 +75,8 @@ Caddy handles HTTPS automatically. The timeout settings ensure long-running oper
 ### Traefik
 
 ```yaml
+# Add this to your docker-compose.yml alongside the surrealdb service
+# See full base setup: https://github.com/lfnovo/open-notebook/blob/main/docker-compose.yml
 services:
   open-notebook:
     image: lfnovo/open_notebook:v1-latest
@@ -159,6 +161,8 @@ When `API_URL` is not set, the Next.js frontend:
 
 ## Complete Docker Compose Example
 
+> **Note:** This example only shows the open-notebook and nginx services. You also need a `surrealdb` service. See the [full base docker-compose.yml](https://github.com/lfnovo/open-notebook/blob/main/docker-compose.yml) for the complete setup.
+
 ```yaml
 services:
   open-notebook:
@@ -171,7 +175,6 @@ services:
       - OPEN_NOTEBOOK_PASSWORD=${OPEN_NOTEBOOK_PASSWORD}
     volumes:
       - ./notebook_data:/app/data
-      - ./surreal_data:/mydata
     # Only expose to localhost (nginx handles public access)
     ports:
       - "127.0.0.1:8502:8502"
@@ -304,6 +307,7 @@ API_URL=http://192.168.1.100:5055
 
 **Step 3: Expose ports**
 ```yaml
+# Add to your docker-compose.yml (requires surrealdb service, see installation guide)
 services:
   open-notebook:
     image: lfnovo/open_notebook:v1-latest
@@ -334,6 +338,7 @@ Host the API and frontend on different subdomains:
 
 **docker-compose.yml:**
 ```yaml
+# Add to your docker-compose.yml (requires surrealdb service, see installation guide)
 services:
   open-notebook:
     image: lfnovo/open_notebook:v1-latest
diff --git a/docs/5-CONFIGURATION/security.md b/docs/5-CONFIGURATION/security.md
index d374fce..283a6cb 100644
--- a/docs/5-CONFIGURATION/security.md
+++ b/docs/5-CONFIGURATION/security.md
@@ -82,7 +82,7 @@ environment:
 ### Docker Deployment
 
 ```yaml
-# docker-compose.yml
+# Add to your docker-compose.yml (requires surrealdb service, see installation guide)
 services:
   open_notebook:
     image: lfnovo/open_notebook:v1-latest
@@ -245,6 +245,7 @@ async function getNotebooks() {
 ### Docker Security
 
 ```yaml
+# Add to your docker-compose.yml (requires surrealdb service, see installation guide)
 services:
   open_notebook:
     image: lfnovo/open_notebook:v1-latest