OpenKB/.env.example at main · qdivan/OpenKB · 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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
DATABASE_URL="postgresql://openkb:openkb@localhost:5432/openkb?schema=public"
REDIS_URL="redis://localhost:6379"
APP_BASE_URL="http://localhost:3000"
WEB_BASE_URL="http://localhost:3000"
NEXT_PUBLIC_API_BASE_URL="http://localhost:4000"
NEXT_PUBLIC_OPENKB_CSRF_COOKIE_NAME="openkb_csrf"
OPENKB_NODE_IMAGE="node:20-bookworm-slim"
CORS_ORIGINS="http://localhost:3100,http://127.0.0.1:3100,http://localhost:3000,http://127.0.0.1:3000,http://localhost:3001,http://127.0.0.1:3001"
OPENKB_ALLOW_LOCAL_CORS="true"
AUTH_COOKIE_NAME="openkb_session"
OPENKB_CSRF_COOKIE_NAME="openkb_csrf"
AUTH_COOKIE_SECURE="auto"
SESSION_TTL_DAYS="30"
SHARE_ACCESS_TTL_HOURS="24"
EMAIL_VERIFICATION_TTL_HOURS="24"
PASSWORD_RESET_TTL_HOURS="2"
UPLOAD_MAX_BYTES="26214400"
TRUST_PROXY_HEADERS="false"
API_RATE_LIMIT_MAX="600"
API_RATE_LIMIT_WINDOW_SECONDS="60"
AUTH_RATE_LIMIT_MAX="20"
AUTH_RATE_LIMIT_WINDOW_SECONDS="300"

# Docker Compose host ports. The production compose file also uses service-internal
# URLs such as postgres:5432, redis:6379, minio-assets:9000 and milvus-standalone:19530.
WEB_PORT="3000"
API_PORT="4000"
MCP_PORT="4100"
DIFY_ADAPTER_PORT="4200"
POSTGRES_PORT="5432"
POSTGRES_DB="openkb"
POSTGRES_PASSWORD="openkb"
OPENKB_TEST_POSTGRES_PORT="55432"
REDIS_PORT="6379"
MINIO_PORT="9000"
MINIO_CONSOLE_PORT="9001"
MILVUS_PORT="19530"
MILVUS_HEALTH_PORT="9091"

# Required by pnpm db:seed:first-admin.
ADMIN_EMAIL="admin@openkb.local"
ADMIN_PASSWORD="OpenKB-dev-123456"
ADMIN_DISPLAY_NAME="OpenKB Admin"

DEFAULT_TENANT_NAME="Default Tenant"
DEFAULT_TENANT_SLUG="default"

# S3-compatible object storage. Production compose routes containers to
# http://minio-assets:9000 internally and exposes MinIO on localhost:9000.
S3_ENDPOINT="http://localhost:9000"
S3_REGION="us-east-1"
S3_BUCKET="openkb-assets"
S3_ACCESS_KEY_ID="openkb"
S3_SECRET_ACCESS_KEY="openkb-secret"
S3_FORCE_PATH_STYLE="true"
S3_PRESIGN_TTL_SECONDS="900"

# Milvus deployment defaults. Local compose exposes Milvus on localhost:19530.
# Defaults are CPU-only BM25/text search. Dense/hybrid/rerank are enabled by
# the OPENKB_* model endpoints below, then require an index rebuild.
MILVUS_URI="localhost:19530"
MILVUS_TOKEN=""
MILVUS_DATABASE=""
MILVUS_ACTIVE_ALIAS="openkb_chunks_active"
MILVUS_COLLECTION_PREFIX="openkb_chunks"
MILVUS_ENABLE_BM25="true"
MILVUS_ENABLE_TEXT_EMBEDDING="false"
MILVUS_ENABLE_RERANK="false"
MILVUS_VECTOR_DIM="2048"
MILVUS_TIMEOUT_MS="30000"
MILVUS_MINIO_ACCESS_KEY_ID="openkb"
MILVUS_MINIO_SECRET_ACCESS_KEY="openkb-secret"

# Retrieval mode. Without an embedding endpoint, OpenKB automatically falls back to bm25.
OPENKB_RETRIEVAL_DEFAULT_MODE="hybrid"

# OpenKB model calls. System admins may alternatively save instance-level encrypted
# model secrets in model_settings when OPENKB_CONFIG_ENCRYPTION_KEY is set.
# Knowledge-base-level model configuration is intentionally unsupported.
# Example values for a local/private model network:
# OPENKB_EMBEDDING_REQUEST_FORMAT="openai_compatible"
# OPENKB_EMBEDDING_ENDPOINT="http://192.168.6.220:18081/v1/embeddings"
# OPENKB_EMBEDDING_MODEL="qwen3-vl-embedding-2b"
# OPENKB_RERANK_REQUEST_FORMAT="openai_compatible"
# OPENKB_RERANK_ENDPOINT="http://192.168.6.220:18082/v1/rerank"
# OPENKB_RERANK_MODEL="qwen3-vl-reranker-2b"
# Example values for Alibaba Cloud DashScope native qwen3-vl models:
# OPENKB_EMBEDDING_REQUEST_FORMAT="dashscope"
# OPENKB_EMBEDDING_ENDPOINT="https://dashscope.aliyuncs.com/api/v1/services/embeddings/multimodal-embedding/multimodal-embedding"
# OPENKB_EMBEDDING_MODEL="qwen3-vl-embedding"
# OPENKB_EMBEDDING_DIM="768"
# OPENKB_RERANK_REQUEST_FORMAT="dashscope"
# OPENKB_RERANK_ENDPOINT="https://dashscope.aliyuncs.com/api/v1/services/rerank/text-rerank/text-rerank"
# OPENKB_RERANK_MODEL="qwen3-vl-rerank"
OPENKB_CONFIG_ENCRYPTION_KEY=""
OPENKB_EMBEDDING_REQUEST_FORMAT="openai_compatible"
OPENKB_EMBEDDING_ENDPOINT=""
OPENKB_EMBEDDING_MODEL=""
OPENKB_EMBEDDING_API_KEY=""
OPENKB_EMBEDDING_DIM="2048"
OPENKB_EMBEDDING_BATCH_SIZE="16"
OPENKB_EMBEDDING_TIMEOUT_MS="30000"
OPENKB_RERANK_REQUEST_FORMAT="openai_compatible"
OPENKB_RERANK_ENDPOINT=""
OPENKB_RERANK_MODEL=""
OPENKB_RERANK_API_KEY=""
OPENKB_RERANK_TIMEOUT_MS="15000"
OPENKB_IMAGE_VECTOR_MODE="auto"
OPENKB_IMAGE_EMBED_MAX_BYTES="10485760"
# OPENKB_LLM_REQUEST_FORMAT: openai_responses | openai_chat_completions | anthropic_messages
OPENKB_LLM_REQUEST_FORMAT="openai_responses"
OPENKB_LLM_ENDPOINT="https://api.openai.com/v1/responses"
OPENKB_LLM_MODEL=""
OPENKB_LLM_API_KEY=""
OPENKB_LLM_TIMEOUT_MS="30000"
OPENKB_LLM_MAX_OUTPUT_TOKENS="64"
OPENKB_LLM_TEMPERATURE="0"

# Complex import tools. These are instance-level only and may also be configured
# by system admins in the Import Tools control plane when OPENKB_CONFIG_ENCRYPTION_KEY is set.
OPENKB_MARKITDOWN_COMMAND="markitdown"
OPENKB_MINERU_ENDPOINT=""
OPENKB_MINERU_API_KEY=""
OPENKB_PANDOC_COMMAND="pandoc"
OPENKB_TESSERACT_COMMAND="tesseract"
OPENKB_IMPORT_TOOL_TIMEOUT_MS="120000"
OPENKB_IMPORT_MAX_FILE_MB="100"

# Production SMTP and operations. System admins may alternatively save instance-level
# encrypted SMTP credentials in smtp_settings when OPENKB_CONFIG_ENCRYPTION_KEY is set.
OPENKB_SMTP_HOST=""
OPENKB_SMTP_PORT="587"
OPENKB_SMTP_SECURE="false"
OPENKB_SMTP_USER=""
OPENKB_SMTP_PASSWORD=""
OPENKB_SMTP_FROM=""
OPENKB_SMTP_REPLY_TO=""
OPENKB_METRICS_ENABLED="true"
OPENKB_BACKUP_DIR="./backups"

# Worker polling. Current Phase 11 deployments include Redis as a baseline service,
# but import/index workers still poll PostgreSQL jobs; BullMQ wiring is future work.
IMPORT_WORKER_POLL_MS="2000"
INDEX_WORKER_POLL_MS="2000"
INDEX_WORKER_BATCH_SIZE="100"

# MCP Server. PATs are user-bound and can be created with pnpm mcp:pat:create.
MCP_SERVER_BASE_URL="http://localhost:4100"
MCP_OAUTH_ISSUER="http://localhost:4100"
MCP_OAUTH_ACCESS_TOKEN_TTL_SECONDS="900"
MCP_OAUTH_REFRESH_TOKEN_TTL_DAYS="30"
MCP_OAUTH_SIGNING_SECRET=""
MCP_PAT_PREFIX="kbpat_"
MCP_DEFAULT_SCOPES="kb:read,kb:search,doc:read"
MCP_MAX_TOP_K="20"
MCP_MAX_DOCUMENT_CHARS="60000"
MCP_PAT_USER_EMAIL="admin@openkb.local"
MCP_PAT_NAME="Local MCP PAT"
MCP_PAT_SCOPES="kb:read,kb:search,doc:read"
MCP_PAT_EXPIRES_DAYS="30"

# Dify External Knowledge Adapter. API keys are app-scoped and can be created
# with pnpm dify:key:create. They do not impersonate users.
DIFY_API_KEY_PREFIX="dify_"
DIFY_API_KEY_NAME="Local Dify Key"
DIFY_KEY_CREATED_BY_EMAIL="admin@openkb.local"
DIFY_KNOWLEDGE_ID="openkb-demo"
DIFY_KNOWLEDGE_BASE_ID=""
DIFY_TOP_K_LIMIT="10"
DIFY_KEY_EXPIRES_DAYS="30"
DIFY_MAX_TOP_K="20"
DIFY_REQUEST_MAX_BYTES="1048576"
DIFY_RESULT_BASE_URL="http://localhost:3000"