Skip to content

Commit 14bf247

Browse files
committed
docs(readme+docs): 全面重构文档以系统性对齐功能实现
为确保新用户能顺利安装、配置及集成,系统性重构了 主项目文档(README.md)、.env.example 及 docs/ 子文档。 - 快速开始与安装流程系统化,补全各平台差异与依赖说明 - 配置说明与环境变量文档全量覆盖、示例补齐 - 路由与 OpenAI 兼容性总结、协议差异、常见限制全面标注 - 增补流式代理、浏览器自动化等运行时关键组件角色说明 - 新增客户端(cURL/Python/JS)集成示例、接口测试方法 - 强化排障、日志机制及常见故障处理建议 - 完善 Docker 与 systemd/pm2 脚本、API 密钥存储等安全部署建议 - 更新/完善 .env.example 并与文档完全一致 变更将大幅提升文档一致性和可操作性,使新环境可一站式装配调通。 BREAKING CHANGE: 部分文档路径及推荐操作略有调整,需以新版文档为准。
1 parent ec9a4f4 commit 14bf247

7 files changed

Lines changed: 3231 additions & 84 deletions

.env.example

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ PORT=2048
1212
DEFAULT_FASTAPI_PORT=2048
1313
DEFAULT_CAMOUFOX_PORT=9222
1414

15+
# Camoufox WebSocket 端点捕获超时(秒)
16+
ENDPOINT_CAPTURE_TIMEOUT=45
17+
1518
# 流式代理服务配置
1619
STREAM_PORT=3120
1720
# 设置为 0 禁用流式代理服务
@@ -59,6 +62,9 @@ AUTH_SAVE_TIMEOUT=30
5962
# 自动确认登录
6063
AUTO_CONFIRM_LOGIN=true
6164

65+
# 仅收集当前用户消息中的附件(true/false)
66+
ONLY_COLLECT_CURRENT_USER_ATTACHMENTS=false
67+
6268
# =============================================================================
6369
# 浏览器配置
6470
# =============================================================================

0 commit comments

Comments
 (0)