mirror of
https://github.com/lfnovo/open-notebook.git
synced 2026-08-21 06:54:04 +00:00
1884205346
Parameterize SurrealDB credentials in docker-compose.yml via ${SURREAL_USER:-root} / ${SURREAL_PASSWORD:-root} (applied to both the database server command and the app env), defaulting to root:root so the zero-config quick start is unchanged. Documented in .env.example and inline comments.
Fixes #946
62 lines
2.1 KiB
Text
62 lines
2.1 KiB
Text
# Open Notebook Configuration
|
|
# Copy this file to .env and customize as needed
|
|
|
|
# =============================================================================
|
|
# REQUIRED
|
|
# =============================================================================
|
|
|
|
# Encryption key for storing API credentials securely in the database
|
|
# Change this to any secret string (minimum 16 characters recommended)
|
|
OPEN_NOTEBOOK_ENCRYPTION_KEY=change-me-to-a-secret-string
|
|
|
|
# =============================================================================
|
|
# DATABASE (Default values work with docker-compose.yml)
|
|
# =============================================================================
|
|
|
|
SURREAL_URL=ws://surrealdb:8000/rpc
|
|
# root:root is fine for local use. Change these before exposing the instance to a
|
|
# network — docker-compose.yml reads them for both the SurrealDB server and the
|
|
# app, so the two stay in sync.
|
|
SURREAL_USER=root
|
|
SURREAL_PASSWORD=root
|
|
SURREAL_NAMESPACE=open_notebook
|
|
SURREAL_DATABASE=open_notebook
|
|
|
|
# =============================================================================
|
|
# OPTIONAL: AI Provider API Keys
|
|
# =============================================================================
|
|
# You can configure these via the UI (Settings → API Keys) or set them here
|
|
# UI configuration is recommended for better security and flexibility
|
|
|
|
# OpenAI
|
|
# OPENAI_API_KEY=sk-...
|
|
|
|
# Anthropic
|
|
# ANTHROPIC_API_KEY=sk-ant-...
|
|
|
|
# Google AI
|
|
# GOOGLE_API_KEY=...
|
|
|
|
# Groq
|
|
# GROQ_API_KEY=gsk_...
|
|
|
|
# =============================================================================
|
|
# OPTIONAL: Advanced Configuration
|
|
# =============================================================================
|
|
|
|
# External API URL (for webhooks, callbacks, etc.)
|
|
# API_URL=http://localhost:5055
|
|
|
|
# Ollama endpoint (if running locally)
|
|
# OLLAMA_BASE_URL=http://ollama:11434
|
|
|
|
# Content processing
|
|
# CHUNK_SIZE=1500
|
|
# CHUNK_OVERLAP=150
|
|
|
|
# Security
|
|
# BASIC_AUTH_USERNAME=admin
|
|
# BASIC_AUTH_PASSWORD=secret
|
|
|
|
# For more configuration options, see:
|
|
# https://github.com/lfnovo/open-notebook/blob/main/docs/5-CONFIGURATION/environment-reference.md
|