open-notebook/.env.example at main · lfnovo/open-notebook · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# 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
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