DevDocs

环境要求

• 已安装 Docker 与 Docker Compose（Windows 用户需安装 Docker Desktop）
• Windows 用户需先安装并运行 WSL 2（官方说明 Windows 支持为实验性、尚未测试）
• logs、storage、crawl_results 目录需具备读写权限（脚本会自动创建并授权，Windows 可能需管理员权限）
• 能访问 GitHub 拉取仓库代码

安装与启动步骤

1. 1准备运行环境

   先安装 Docker；Windows 用户需按官方指引装好 WSL 2 和 Docker Desktop（内置 Compose），注意 Windows 目前仅实验性支持。

2. 2拉取项目代码

   克隆 DevDocs 仓库到本地，脚本 docker-start.sh / docker-start.bat 位于仓库根目录。

   git clone https://github.com/cyberagiinc/DevDocs.git

   复制

3. 3进入项目目录

   切换到克隆下来的 DevDocs 目录，后续启动脚本都在此目录执行。

   cd DevDocs

   复制

4. 4Mac/Linux 一键启动

   执行官方启动脚本，它会自动创建目录、设置权限、构建并启动所有 Docker 容器并监控服务。

   ./docker-start.sh

   复制

5. 5Windows 启动（实验性）

   Windows 下运行 bat 脚本，它会自动修正 docker-compose.yml 的格式与编码问题，建议以管理员身份运行。

   docker-start.bat

   复制

6. 6手动修复目录权限

   Windows 若遇权限问题，可在管理员命令提示符下为三个数据目录授予 Everyone 完全控制权限。

   icacls logs /grant Everyone:F /T
   icacls storage /grant Everyone:F /T
   icacls crawl_results /grant Everyone:F /T

   复制

关键配置

如何确认成功

启动脚本会自动监控服务，终端无报错且容器持续运行即表示启动成功；也可用 docker ps 查看容器状态。

常见问题

注意事项

• 项目状态为“Not publicly maintained”，使用前请留意官方后续发布说明。
• README 未给出前端访问端口与地址，启动后请以脚本输出或 docker ps 的结果为准。
• Windows 支持为实验性且未经测试，生产环境建议使用 Mac/Linux。
• CRAWL4AI_API_TOKEN 用于保护 API 端点，对外暴露服务时建议配置。