AI-Codereview-Gitlab

环境要求

• Docker 与 docker-compose 环境（方案一）
• Python 3.10+（方案二本地部署，建议使用 venv 虚拟环境）
• 已获取大模型 API Key（如 DeepSeek、ZhipuAI、OpenAI、Anthropic、通义千问或 Ollama）
• GitLab 的 Access Token（GITLAB_ACCESS_TOKEN）
• GitLab 服务器能网络访问到本系统，内网受限时建议部署在外网服务器

安装与启动步骤

1. 1克隆项目仓库

   从 GitHub 拉取源码并进入项目目录，后续所有配置与启动命令都在该目录下执行。

   git clone https://github.com/sunmh207/AI-Codereview-Gitlab.git
   cd AI-Codereview-Gitlab

   复制

2. 2创建配置文件

   复制仓库自带的配置模板 conf/.env.dist 为 conf/.env，后续所有参数都改在这个文件里。

   cp conf/.env.dist conf/.env

   复制

3. 3填写 .env 参数

   编辑 conf/.env，至少填好大模型供应商与 API Key、GitLab Access Token，并按需设置支持审查的文件类型。

4. 4启动 Docker 服务

   在项目根目录执行 docker-compose，后台启动主服务（5001）与 Dashboard（5002）。

   docker-compose up -d

   复制

5. 5验证服务状态

   浏览器访问 5001 端口看主服务提示，再访问 5002 端口确认 Dashboard 已正常展示审查日志页面。

6. 6配置 GitLab Webhook

   进入 GitLab 项目设置的 Webhook，URL 填 http://{your-server-ip}:5001/review/webhook，只勾选 Push Events 和 Merge Request Events。

7. 7开启消息推送

   在钉钉群添加自定义机器人拿到 Webhook URL，把 .env 中 DINGTALK_ENABLED 改为 1 并填入 URL。

关键配置

如何确认成功

访问 http://your-server-ip:5001 显示 "The code review server is running." 即主服务正常；访问 http://your-server-ip:5002 能看到审查日志页面即 Da

常见问题

注意事项

• Webhook 的 Trigger Events 只能勾选 Push Events 和 Merge Request Events，不要勾选其它 Event。
• 内网环境受限时，建议把本系统部署在外网服务器上，确保 GitLab 能访问到它。
• 改 .env 后需要重启服务才会生效；Docker 方案可再次执行 docker-compose up -d。
• 不使用 Docker 时可在 Python 3.10+ 环境下执行 pip install -r requirements.txt，再运行 python api.py 与 streamlit run ui.py --server.port=5002 --server.address=0.0.0.0。