From c7a457ee78619767494828885911081f4a8a41df Mon Sep 17 00:00:00 2001 From: Luis Novo Date: Wed, 18 Feb 2026 22:16:15 -0300 Subject: [PATCH] docs: add missing SURREAL_NAMESPACE and SURREAL_DATABASE env vars The inline docker-compose example in README and the environment variable reference tables in installation docs were missing these two required variables, causing connection failures for users who copy-pasted the examples instead of downloading the actual file. Closes #592 --- README.md | 2 ++ docs/1-INSTALLATION/docker-compose.md | 2 ++ docs/1-INSTALLATION/single-container.md | 2 ++ 3 files changed, 6 insertions(+) diff --git a/README.md b/README.md index a078dc2..f7089c9 100644 --- a/README.md +++ b/README.md @@ -132,6 +132,8 @@ services: - SURREAL_URL=ws://surrealdb:8000/rpc - SURREAL_USER=root - SURREAL_PASSWORD=root + - SURREAL_NAMESPACE=open_notebook + - SURREAL_DATABASE=open_notebook volumes: - ./notebook_data:/app/data depends_on: diff --git a/docs/1-INSTALLATION/docker-compose.md b/docs/1-INSTALLATION/docker-compose.md index 3c9215d..c438c72 100644 --- a/docs/1-INSTALLATION/docker-compose.md +++ b/docs/1-INSTALLATION/docker-compose.md @@ -194,6 +194,8 @@ Configure Ollama in the Settings UI: | `SURREAL_URL` | Database connection | `ws://surrealdb:8000/rpc` | | `SURREAL_USER` | Database user | `root` | | `SURREAL_PASSWORD` | Database password | `root` | +| `SURREAL_NAMESPACE` | Database namespace | `open_notebook` | +| `SURREAL_DATABASE` | Database name | `open_notebook` | | `API_URL` | API external URL | `http://localhost:5055` | See [Environment Reference](../5-CONFIGURATION/environment-reference.md) for complete list. diff --git a/docs/1-INSTALLATION/single-container.md b/docs/1-INSTALLATION/single-container.md index 0bc0db7..9a48458 100644 --- a/docs/1-INSTALLATION/single-container.md +++ b/docs/1-INSTALLATION/single-container.md @@ -107,6 +107,8 @@ heroku config:set OPEN_NOTEBOOK_ENCRYPTION_KEY=your-secret-key | `SURREAL_URL` | Database | `ws://localhost:8000/rpc` | | `SURREAL_USER` | DB user | `root` | | `SURREAL_PASSWORD` | DB password | `password` | +| `SURREAL_NAMESPACE` | DB namespace | `open_notebook` | +| `SURREAL_DATABASE` | DB name | `open_notebook` | | `API_URL` | External URL (for remote access) | `https://myapp.example.com` | AI provider API keys are configured via the **Settings → API Keys** UI after deployment.