Skip to content

docs: enhance .env.example with API links and configuration guidance #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
penguin-sy wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −4
Open

docs: enhance .env.example with API links and configuration guidance #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,15 @@ OPENCLAW_GATEWAY_BIND=lan
OPENCLAW_CONFIG_DIR=./config
OPENCLAW_WORKSPACE_DIR=./workspace

# Optional: import missing keys from your login shell profile.
# 可选：从登录 shell 配置导入缺失的环境变量
# OPENCLAW_LOAD_SHELL_ENV=1
# OPENCLAW_SHELL_ENV_TIMEOUT_MS=15000

# -----------------------------------------------------------------------------
# Multi-Expert Routing Matrix API Keys (MATRIX)
# 为什么需要多个密钥？防止单一密钥的并发限制（429）影响所有功能。
# 获取密钥：SiliconFlow (https://cloud.siliconflow.cn/account/ak)
# DeepSeek官方 (https://platform.deepseek.com/api_keys)
# -----------------------------------------------------------------------------
# 上游兼容 OpenAI 规范的接口地址 (如 SiliconFlow, DeepSeek官方, 或本地 Ollama)
OPENAI_COMPATIBLE_HOST=api.siliconflow.cn
Expand All @@ -46,18 +49,25 @@ MATRIX_CODE_API_KEY=sk-... # 代码专家 (如 Qwen3-Coder)
MATRIX_EMBED_API_KEY=sk-... # 记忆向量化模型

# 可选：如果其他厂商的模型名称与默认不同，请在此覆盖
# MATRIX_TEXT_MODEL=deepseek-chat
# MATRIX_REASONING_MODEL=deepseek-reasoner
# 模型名称示例：SiliconFlow 格式 "Pro/deepseek-ai/DeepSeek-V3.2"
# 或 "Qwen/Qwen3-VL-32B-Instruct"
# MATRIX_TEXT_MODEL=Pro/deepseek-ai/DeepSeek-V3.2
# MATRIX_REASONING_MODEL=Pro/deepseek-ai/DeepSeek-R1

# -----------------------------------------------------------------------------
# v2.0 Dual-Engine Web Fetcher (web_fetch.cjs)
# -----------------------------------------------------------------------------
# Engine 1: Jina AI (用于轻量极速的 search 和 read)
JINA_API_KEY=jina_...

# 获取地址：https://jina.ai (免费额度：2000次/月)
# 注意：jina_ 前缀是 Jina AI 的标准格式

# Engine 2: Firecrawl (用于重型的复杂 JS 渲染和深度 scrape)
FIRECRAWL_API_KEY=fc-...

# 获取地址：https://firecrawl.dev (免费额度：100页/月)

# -----------------------------------------------------------------------------
# Network Proxy (网络代理配置)
# -----------------------------------------------------------------------------
Expand Down Expand Up @@ -92,7 +102,14 @@ FIRECRAWL_API_KEY=fc-...
# -----------------------------------------------------------------------------
# External Tools + voice/media (optional)
# -----------------------------------------------------------------------------
# Brave Search API (搜索)
# BRAVE_API_KEY=...

# Perplexity API (联网搜索)
# PERPLEXITY_API_KEY=pplx-...

# ElevenLabs (语音合成)
# ELEVENLABS_API_KEY=...
# DEEPGRAM_API_KEY=...

# Deepgram (语音识别)
# DEEPGRAM_API_KEY=...