open-notebook/.env.example at main · AugustoSandim/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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# 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_API_BASE=http://localhost:11434

# oMLX (Apple Silicon) — prefer Settings → API Keys; port 11435 avoids SurrealDB on 8000
# OMLX_API_BASE=http://localhost:11435/v1
# OMLX_API_KEY=  # optional; only if oMLX was started with --api-key

# Content processing
# CHUNK_SIZE=1500
# CHUNK_OVERLAP=150

# Max background tasks the worker runs concurrently (default 5). Set to 1 for
# sequential processing on single-GPU / local-LLM setups to avoid rate limits.
# NOTE: consumed at worker launch, not by the app — for `make`/dev-init export
# it in your shell; for Docker set it under `environment:` in docker-compose.yml.
# OPEN_NOTEBOOK_WORKER_MAX_TASKS=1

# Maximum upload/request body size in MB (default: 100). Raise this if you
# need to upload larger audio/video files. A fronting reverse proxy's own
# limit (e.g. nginx client_max_body_size) still applies and should be raised
# to match.
# OPEN_NOTEBOOK_MAX_UPLOAD_SIZE_MB=100

# Security
# Password to protect this Open Notebook instance. Supports Docker secrets
# via OPEN_NOTEBOOK_PASSWORD_FILE. Auth is fully disabled if unset.
# OPEN_NOTEBOOK_PASSWORD=secret

# Network / Proxy (corporate / firewalled environments)
# Route outbound HTTP(S) through a proxy. NO_PROXY MUST list the internal
# SurrealDB hosts (host.docker.internal, surrealdb) — otherwise the DB
# websocket gets tunnelled through the proxy and the worker/API fail to start
# with HTTP 403. The app also injects these hosts automatically as a safety
# net, but keep them here so your config is explicit.
# HTTP_PROXY=http://proxy.corp.com:8080
# HTTPS_PROXY=http://proxy.corp.com:8080
# NO_PROXY=localhost,127.0.0.1,host.docker.internal,surrealdb,.local

# For more configuration options, see:
# https://github.com/lfnovo/open-notebook/blob/main/docs/5-CONFIGURATION/environment-reference.md