OpenOBA 开源原型部署指南

环境要求

组件	最低版本	推荐版本
操作系统	Linux / macOS / Windows	Ubuntu 22.04+
Docker	20.10+	24.0+
Docker Compose	2.0+	2.20+
Node.js	18 LTS+
数据库	关系型数据库
内存	4 GB	8 GB+
磁盘	20 GB	50 GB SSD

方式一：Docker Compose（推荐）

1. 克隆仓库

git clone https://github.com/miaojing/erp.git
cd erp

2. 配置环境变量

cp .env.example .env
# 编辑 .env 文件，配置数据库密码、LLM API Key 等

3. 启动服务

docker-compose up -d

首次启动会自动完成数据库初始化、表结构迁移和种子数据导入。启动完成后：

• 管理后台：http://localhost:3000
• API 文档（Swagger）：http://localhost:3000/api-docs

4. 验证部署

curl http://localhost:3000/api/health
# 返回 {"status":"ok"} 表示部署成功

方式二：手动部署

1. 安装依赖

# 后端
cd backend
npm install

# 前端
cd ../frontend
npm install

2. 创建数据库

mysql -u root -p
CREATE DATABASE openoba_erp CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

3. 运行数据库迁移

cd backend
npm run migration:run

4. 导入种子数据

npm run seed

5. 启动服务

# 后端（端口 3000）
npm run start:dev

# 前端（端口 5173）
cd ../frontend
npm run dev

配置 LLM 模型

OpenOBA 支持多种 LLM 后端。在 .env 中配置：

# 高性能 LLM（推荐默认配置）
LLM_PROVIDER=your_provider
LLM_API_KEY=***
LLM_MODEL=your_model

# 或使用 OpenAI 兼容接口
LLM_PROVIDER=openai
LLM_BASE_URL=https://api.openai.com/v1
LLM_API_KEY=sk-your-key-here
LLM_MODEL=gpt-4o

更新与升级

git pull origin main
docker-compose down
docker-compose build
docker-compose up -d

常见问题

端口被占用怎么办？

修改 docker-compose.yml 中的端口映射，或将 .env 中的 PORT 改为其他端口。

数据库连接失败？

检查数据库是否已启动。确保 .env 中的数据库连接信息正确。

内存不足？

建议至少 4 GB 可用内存。如果使用 2 GB 内存的云服务器，可考虑关闭不必要的 Docker 容器或在 .env 中降低 Node.js 内存限制。