Files
happy-life-star/packages/emotion-museum-1.0.0-20250713_111829/QUICK_START.md
T

211 lines
4.9 KiB
Markdown

# 情绪博物馆快速部署指南
## 📦 包内容说明
```
emotion-museum-1.0.0-YYYYMMDD_HHMMSS/
├── frontend/ # 前端构建产物
│ ├── dist/ # 静态文件
│ ├── Dockerfile # 前端容器配置
│ └── nginx.conf # Nginx配置
├── backend/ # 后端JAR文件
│ ├── emotion-gateway-*.jar # 网关服务
│ ├── emotion-ai-*.jar # AI服务
│ ├── emotion-user-*.jar # 用户服务
│ ├── config/ # 配置文件
│ └── *-Dockerfile # 各服务容器配置
├── database/ # 数据库脚本
│ └── mysql_emotion_museum_final.sql
├── deploy/ # 部署配置
│ ├── nginx/ # Nginx配置
│ ├── mysql/ # MySQL配置
│ └── redis/ # Redis配置
├── docker-compose.yml # 开发环境配置
├── docker-compose.prod.yml # 生产环境配置
├── deploy.sh # 部署脚本
├── quick-deploy.sh # 快速部署脚本
├── manage.sh # 管理脚本
├── .env # 环境变量模板
├── VERSION.txt # 版本信息
├── DEPLOY.md # 详细部署文档
└── QUICK_START.md # 本文件
```
## 🚀 快速部署步骤
### 1. 系统要求
- **操作系统**: Linux/macOS/Windows
- **Docker**: 20.10+
- **Docker Compose**: 1.29+
- **内存**: 最少4GB,推荐8GB+
- **磁盘**: 最少10GB可用空间
### 2. 部署步骤
#### 方式一:一键部署(推荐)
```bash
# 1. 解压部署包
tar -xzf emotion-museum-*.tar.gz
cd emotion-museum-*
# 2. 配置环境变量
cp .env .env.local
vim .env.local # 编辑配置,特别是COZE_API_TOKEN
# 3. 一键部署
chmod +x quick-deploy.sh
./quick-deploy.sh
```
#### 方式二:手动部署
```bash
# 1. 解压部署包
tar -xzf emotion-museum-*.tar.gz
cd emotion-museum-*
# 2. 配置环境变量
cp .env .env.local
vim .env.local
# 3. 手动部署
chmod +x deploy.sh
./deploy.sh
```
### 3. 验证部署
```bash
# 查看服务状态
./manage.sh status
# 健康检查
./manage.sh health
# 查看日志
./manage.sh logs
```
### 4. 访问应用
- **前端应用**: http://localhost
- **API网关**: http://localhost:9000
- **Nacos控制台**: http://localhost:8848/nacos (nacos/nacos)
## ⚙️ 配置说明
### 必须配置项
编辑 `.env` 文件中的以下配置:
```bash
# Coze API配置(必须)
COZE_API_TOKEN=your-actual-coze-api-token
# 数据库密码(建议修改)
MYSQL_ROOT_PASSWORD=your-secure-password
MYSQL_PASSWORD=your-secure-password
```
### 可选配置项
```bash
# 时区设置
TZ=Asia/Shanghai
# 域名配置(生产环境)
DOMAIN_NAME=your-domain.com
```
## 🛠️ 管理命令
```bash
# 服务管理
./manage.sh start # 启动服务
./manage.sh stop # 停止服务
./manage.sh restart # 重启服务
./manage.sh status # 查看状态
# 日志管理
./manage.sh logs # 查看所有日志
./manage.sh logs -f # 跟踪日志
./manage.sh logs -s ai # 查看AI服务日志
# 数据管理
./manage.sh backup # 备份数据
./manage.sh restore file # 恢复数据
# 监控
./manage.sh monitor # 监控面板
./manage.sh health # 健康检查
```
## 🔧 生产环境配置
### 1. 使用生产配置
```bash
# 使用生产环境配置
docker-compose -f docker-compose.prod.yml up -d
```
### 2. 配置HTTPS
```bash
# 1. 放置SSL证书
cp your-domain.crt deploy/nginx/ssl/emotion-museum.crt
cp your-domain.key deploy/nginx/ssl/emotion-museum.key
# 2. 修改Nginx配置
vim deploy/nginx/conf.d/emotion-museum.conf
# 取消HTTPS相关配置的注释
# 3. 重启Nginx
docker-compose restart nginx
```
### 3. 配置域名
```bash
# 修改Nginx配置中的域名
vim deploy/nginx/conf.d/emotion-museum.conf
# 将 localhost 替换为您的域名
```
## 🚨 故障排除
### 常见问题
1. **端口冲突**
```bash
# 检查端口占用
netstat -tlnp | grep :80
netstat -tlnp | grep :3306
```
2. **服务启动失败**
```bash
# 查看具体错误
./manage.sh logs -s service-name
```
3. **数据库连接失败**
```bash
# 检查数据库状态
docker-compose exec mysql mysqladmin ping -u root -p
```
4. **前端访问404**
```bash
# 检查Nginx配置
docker-compose exec nginx nginx -t
```
### 获取帮助
- 查看详细文档: `cat DEPLOY.md`
- 查看版本信息: `cat VERSION.txt`
- 查看管理命令: `./manage.sh --help`
## 📞 技术支持
如遇到问题,请:
1. 查看相关服务日志
2. 检查配置文件
3. 参考 DEPLOY.md 中的故障排除指南
4. 联系技术支持团队
---
**部署完成后,请及时修改默认密码和敏感配置!**