baodan/DEPLOY_README.md

171 lines
3.7 KiB
Markdown
Raw Normal View History

# 保险智能客服系统 — 部署指南
## 🚀 快速部署
### Windows 用户
```cmd
deploy.bat
```
### Linux/Mac 用户
```bash
chmod +x deploy.sh
./deploy.sh
```
## 📋 手动部署步骤
### 1. 环境配置
```bash
# 复制环境变量模板
cp .env.example .env
# 编辑 .env 文件,填入实际配置
# 至少需要配置:
# - JWT_SECRET已自动生成
# - 企微配置(如果需要企微功能)
```
### 2. 构建镜像
```bash
# 构建 API 镜像(包含 insurance 模块)
docker build -t baodanagent-dify-api:latest -f Dockerfile.dify-custom .
# 构建 Web 镜像(自定义品牌)
docker build -t baodanagent-dify-web:latest -f Dockerfile.web-custom .
```
### 3. 启动服务
```bash
# 启动所有服务
docker compose -f docker-compose.dify.yml up -d
# 查看日志
docker compose -f docker-compose.dify.yml logs -f
# 等待初始化完成(约 1-2 分钟)
```
### 4. 访问系统
| 服务 | 地址 | 说明 |
|------|------|------|
| 前端应用 | http://localhost:8080 | Vue 3 前端 |
| 管理后台 | http://localhost:3000 | BaoDan 后台 |
| API 服务 | http://localhost:5001 | 后端 API |
### 5. 默认管理员账号
- **邮箱**: taiyi@baodan.com
- **密码**: taiyi1224
## 🔧 配置说明
### 必填配置
| 配置项 | 说明 | 默认值 |
|--------|------|--------|
| `JWT_SECRET` | JWT 认证密钥 | 已自动生成 |
| `ADMIN_PASSWORD` | 管理员密码 | taiyi1224 |
| `DB_PASSWORD` | 数据库密码 | taiyi1224 |
### 企微配置(可选)
如果需要对接企业微信,需要配置以下项:
| 配置项 | 说明 |
|--------|------|
| `WECOM_CORP_ID` | 企业 ID |
| `WECOM_SECRET` | 应用密钥 |
| `WECOM_TOKEN` | 回调 Token |
| `WECOM_AES_KEY` | 加密 Key |
## 📦 服务组件
| 服务 | 端口 | 说明 |
|------|------|------|
| baodan-api | 5001 | API 服务 + Insurance 模块 |
| baodan-web | 3000 | Web 管理后台 |
| baodan-worker | - | Celery 异步任务 |
| db | 5433 | PostgreSQL 数据库 |
| redis | 6380 | Redis 缓存 |
| plugin_daemon | 5002 | 插件守护进程 |
| sandbox | 8194 | 代码执行沙箱 |
## 🛠️ 常用命令
```bash
# 查看所有服务状态
docker compose -f docker-compose.dify.yml ps
# 查看特定服务日志
docker compose -f docker-compose.dify.yml logs -f baodan-api
# 重启服务
docker compose -f docker-compose.dify.yml restart
# 停止所有服务
docker compose -f docker-compose.dify.yml down
# 停止并删除数据卷
docker compose -f docker-compose.dify.yml down -v
```
## 🔍 故障排查
### 1. 服务启动失败
```bash
# 查看详细日志
docker compose -f docker-compose.dify.yml logs baodan-api
# 检查容器状态
docker compose -f docker-compose.dify.yml ps
```
### 2. 数据库连接失败
```bash
# 检查 PostgreSQL 是否就绪
docker compose -f docker-compose.dify.yml exec db pg_isready -U postgres
# 查看数据库日志
docker compose -f docker-compose.dify.yml logs db
```
### 3. 端口冲突
如果端口被占用,可以修改 `docker-compose.dify.yml` 中的端口映射:
```yaml
ports:
- "5002:5001" # 将 5001 改为 5002
```
## 📝 注意事项
1. **首次启动**:数据库迁移和初始化需要 1-2 分钟
2. **数据持久化**:数据存储在 Docker Volume 中,重启不会丢失
3. **生产环境**:请修改默认密码和密钥
4. **备份**:定期备份 PostgreSQL 数据和 Docker Volume
## 🔐 安全建议
1. 修改默认管理员密码
2. 使用强密码作为 JWT_SECRET
3. 配置 HTTPS生产环境
4. 限制数据库和 Redis 的访问权限
5. 定期更新 Docker 镜像
## 📚 更多文档
- [项目文档](docs/README.md)
- [API 接口文档](docs/保险智能客服系统_API接口文档.md)
- [开发计划](docs/开发计划.md)
- [部署指南](docs/部署指南.md)