feat: 添加项目规则、环境配置示例及开发文档

2026-02-04 18:49:38 +08:00
commit df76882178
88 changed files with 13150 additions and 0 deletions
--- a/.env.example
+++ b/.env.example
@@ -0,0 +1,85 @@
+# MineNASAI 环境变量配置
+# 复制此文件为 .env 并填入实际值
+
+# ===== LLM API 配置 =====
+# 至少配置一个 API Key
+
+# Anthropic (Claude) - 境外，需代理
+MINENASAI_LLM__ANTHROPIC_API_KEY=sk-ant-xxxxx
+# MINENASAI_LLM__ANTHROPIC_BASE_URL=  # 可选，自定义 API 地址
+
+# OpenAI (GPT) - 境外，需代理
+MINENASAI_LLM__OPENAI_API_KEY=sk-xxxxx
+# MINENASAI_LLM__OPENAI_BASE_URL=  # 可选，支持兼容接口
+
+# DeepSeek - 国内，无需代理
+MINENASAI_LLM__DEEPSEEK_API_KEY=sk-xxxxx
+# MINENASAI_LLM__DEEPSEEK_BASE_URL=https://api.deepseek.com
+
+# 智谱 GLM - 国内，无需代理
+MINENASAI_LLM__ZHIPU_API_KEY=xxxxx.xxxxx
+# MINENASAI_LLM__ZHIPU_BASE_URL=https://open.bigmodel.cn/api/paas/v4
+
+# MiniMax - 国内，无需代理
+MINENASAI_LLM__MINIMAX_API_KEY=xxxxx
+MINENASAI_LLM__MINIMAX_GROUP_ID=xxxxx
+# MINENASAI_LLM__MINIMAX_BASE_URL=https://api.minimax.chat/v1
+
+# Moonshot (Kimi) - 国内，无需代理
+MINENASAI_LLM__MOONSHOT_API_KEY=sk-xxxxx
+# MINENASAI_LLM__MOONSHOT_BASE_URL=https://api.moonshot.cn/v1
+
+# Google Gemini - 境外，需代理
+MINENASAI_LLM__GEMINI_API_KEY=xxxxx
+# MINENASAI_LLM__GEMINI_BASE_URL=https://generativelanguage.googleapis.com/v1beta
+
+# 默认提供商和模型
+MINENASAI_LLM__DEFAULT_PROVIDER=anthropic
+MINENASAI_LLM__DEFAULT_MODEL=claude-sonnet-4-20250514
+
+# ===== 代理配置 =====
+# 境外 API (Anthropic/OpenAI/Gemini) 需要代理
+MINENASAI_PROXY__ENABLED=true
+MINENASAI_PROXY__HTTP=http://127.0.0.1:7890
+MINENASAI_PROXY__HTTPS=http://127.0.0.1:7890
+# MINENASAI_PROXY__AUTO_DETECT=true  # 自动检测代理
+
+# ===== 兼容旧配置 =====
+# ANTHROPIC_API_KEY=sk-ant-xxxxx
+# HTTP_PROXY=http://127.0.0.1:7890
+# HTTPS_PROXY=http://127.0.0.1:7890
+# NO_PROXY=localhost,127.0.0.1,.local
+
+# ===== 企业微信 =====
+WEWORK_CORP_ID=
+WEWORK_AGENT_ID=
+WEWORK_SECRET=
+WEWORK_TOKEN=
+WEWORK_ENCODING_AES_KEY=
+
+# ===== 飞书 =====
+FEISHU_APP_ID=
+FEISHU_APP_SECRET=
+FEISHU_VERIFICATION_TOKEN=
+FEISHU_ENCRYPT_KEY=
+
+# ===== Redis =====
+REDIS_URL=redis://localhost:6379/0
+
+# ===== 数据库 =====
+DATABASE_URL=sqlite+aiosqlite:///~/.config/minenasai/database.db
+
+# ===== 日志 =====
+LOG_LEVEL=INFO
+LOG_FORMAT=json
+
+# ===== Web TUI =====
+WEBTUI_HOST=0.0.0.0
+WEBTUI_PORT=8080
+WEBTUI_SECRET_KEY=change-this-to-a-random-string
+
+# ===== SSH (localhost) =====
+SSH_HOST=localhost
+SSH_PORT=22
+SSH_USERNAME=
+SSH_KEY_PATH=~/.ssh/id_rsa