ChatTutor

环境要求

• 本机已安装 Docker 与 Docker Compose（Docker 方式）
• 本机已安装 Node.js 与 pnpm（Node & Bun 方式）
• 一个可用的 PostgreSQL 数据库连接串（DATABASE_URL）
• AI 服务的 API Key（MODEL_API_KEY）

安装与启动步骤

1. 1克隆项目仓库

   把 ChatTutor 源码拉到本地，命令执行完后会生成 ChatTutor 目录。

   git clone https://github.com/HugeCatLab/ChatTutor.git
   cd ChatTutor

   复制

2. 2生成环境变量文件

   从仓库自带的 .env.example 复制出 .env，后续所有配置都写在 .env 中。

   cp .env.example .env

   复制

3. 3填写数据库与模型配置

   至少填好 DATABASE_URL、MODEL_API_KEY、AGENT_MODEL、AGENT_MODEL_PROVIDER，否则服务无法对话。

4. 4可选填写 OSS 配置

   需要图片上传才填 OSS_* 五项；不填则图片上传功能不可用，其余功能不受影响。

5. 5用 Docker 启动服务

   进入 docker 目录后以后台方式拉起容器，首次会拉取镜像，耗时较长。

   cd docker
   docker compose up -d

   复制

6. 6（可选）Node & Bun 方式装依赖

   不走 Docker 时，回到项目根目录执行依赖安装；README 未给出后续启动命令，需自行查阅仓库文档。

   cd ChatTutor
   pnpm i

   复制

关键配置

如何确认成功

执行 docker compose ps 确认容器处于运行状态，并用 docker compose logs 检查启动日志无报错；也可先访问官网验证功能效果。

常见问题

注意事项

• README 未提供默认访问端口和访问地址，启动后请以容器日志或仓库文档为准。
• Node & Bun 方式的启动命令在 README 中缺失，只能确认到 pnpm i 这一步，请勿臆测启动参数。
• 官网可直接体验，建议先在官网配置好自己的 API Key 和模型，再决定是否本地部署。