6.6 KiB
6.6 KiB
部署文档索引
📋 快速导航
🚀 快速开始
- DEPLOYMENT_README.md - 部署指南总览
- QUICK_REFERENCE.md - 快速参考卡片
🔧 详细指南
- HTTPS_DEPLOYMENT_GUIDE.md - HTTPS 配置详细指南
- SOLUTION_SUMMARY.md - 完整解决方案说明
- TROUBLESHOOTING.md - 故障排查指南
📁 配置文件
- nginx-production.conf - Nginx 生产环境配置
- setup-https.sh - 自动化 HTTPS 配置脚本
- diagnose.js - 浏览器诊断脚本
📖 文档说明
DEPLOYMENT_README.md
用途: 部署指南总览 内容:
- 快速开始步骤
- 部署流程
- 常见问题
- 性能优化
- 监控和维护
何时阅读: 第一次部署时
QUICK_REFERENCE.md
用途: 快速参考卡片 内容:
- 常用命令
- 文件位置
- 常见问题速查
- 配置检查清单
- 故障排查流程
何时阅读: 需要快速查找命令或信息时
HTTPS_DEPLOYMENT_GUIDE.md
用途: HTTPS 配置详细指南 内容:
- 问题说明
- Let's Encrypt 配置步骤
- 证书管理
- 常见问题
- 安全建议
何时阅读: 需要配置 HTTPS 时
SOLUTION_SUMMARY.md
用途: 完整解决方案说明 内容:
- 问题分析
- 实施的解决方案
- 部署步骤
- 验证方法
- 性能指标
何时阅读: 需要了解完整解决方案时
TROUBLESHOOTING.md
用途: 故障排查指南 内容:
- 常见问题和解决方案
- 调试技巧
- 错误代码说明
- 获取帮助方法
何时阅读: 遇到问题时
🛠️ 配置文件说明
nginx-production.conf
用途: Nginx 生产环境配置 包含:
- HTTPS 配置
- SSL 证书设置
- 安全头部
- 静态文件缓存
- API 代理
- 日志配置
使用方法:
sudo cp nginx-production.conf /etc/nginx/sites-available/admin
sudo nano /etc/nginx/sites-available/admin # 修改路径和端口
sudo ln -s /etc/nginx/sites-available/admin /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl restart nginx
setup-https.sh
用途: 自动化 HTTPS 配置脚本 功能:
- 检查域名解析
- 安装 Certbot
- 获取 SSL 证书
- 配置 Nginx
- 设置自动续期
使用方法:
sudo bash setup-https.sh
diagnose.js
用途: 浏览器诊断脚本 检查项:
- 协议检查
- 浏览器兼容性
- WebRTC 支持
- 设备权限
- 网络连接
- TUIKit 状态
- 存储可用性
- API 连接
- 性能指标
- 内存使用
使用方法:
- 打开浏览器开发者工具 (F12)
- 切换到 Console 标签页
- 复制并粘贴 diagnose.js 中的代码
- 按 Enter 运行
📊 部署流程图
开始
↓
1. 打包应用 (npm run build)
↓
2. 配置 HTTPS
├─ 自动: sudo bash setup-https.sh
└─ 手动: 参考 HTTPS_DEPLOYMENT_GUIDE.md
↓
3. 配置 Nginx
├─ 复制 nginx-production.conf
├─ 修改路径和端口
└─ 测试配置 (sudo nginx -t)
↓
4. 重启 Nginx
└─ sudo systemctl restart nginx
↓
5. 验证部署
├─ 检查 HTTPS 连接
├─ 检查证书
├─ 在浏览器中访问
└─ 运行诊断脚本
↓
6. 监控和维护
├─ 查看日志
├─ 监控性能
└─ 定期更新
↓
完成
✅ 部署检查清单
部署前
- 代码已提交
- 依赖已安装
- 环境变量已配置
- 打包测试通过
部署中
- 应用已打包
- HTTPS 已配置
- Nginx 已配置
- 配置测试通过
- 服务已重启
部署后
- HTTPS 访问正常
- 页面加载正常
- 控制台无错误
- API 连接正常
- WebRTC 功能正常
- 证书自动续期已配置
- 日志监控已启用
🔍 常见问题速查
| 问题 | 文档 | 命令 |
|---|---|---|
| 页面打不开 | TROUBLESHOOTING.md | sudo nginx -t |
| TUIKit 错误 | SOLUTION_SUMMARY.md | 运行 diagnose.js |
| 证书过期 | HTTPS_DEPLOYMENT_GUIDE.md | sudo certbot renew |
| 性能问题 | DEPLOYMENT_README.md | top, free -h |
| 网络连接 | TROUBLESHOOTING.md | curl -I https://... |
📞 获取帮助
第一步：自助诊断
- 查看 QUICK_REFERENCE.md 快速查找
- 运行 diagnose.js 诊断脚本
- 查看 TROUBLESHOOTING.md 故障排查
第二步：查看详细文档
- 根据问题类型选择相应文档
- 按照步骤操作
- 查看常见问题部分
第三步：检查日志
# Nginx 错误日志
sudo tail -f /var/log/nginx/admin_https_error.log
# 应用日志
tail -f /path/to/your/app.log
# 浏览器控制台
F12 → Console
第四步：联系支持
- 提供完整的错误信息
- 提供诊断脚本输出
- 提供系统和浏览器信息
- 提供日志文件
📚 相关文档
应用功能文档
- README.md - 项目说明
- README_VIDEO_CALL.md - 视频通话功能
- GROUP_VIDEO_CALL.md - 群组通话
功能实现文档
- APPOINTMENT_SYSTEM.md - 预约系统
- ORDER_SYSTEM_GUIDE.md - 订单系统
- PAYMENT_GATEWAY_INTEGRATION.md - 支付集成
升级和迁移
- UPGRADE_STEPS.md - 升级步骤
- PAYMENT_MIGRATION.md - 支付迁移
- WEB_UIKIT_UPGRADE_GUIDE.md - UIKit 升级
🎯 按场景选择文档
场景 1: 第一次部署
- 阅读 DEPLOYMENT_README.md
- 运行 setup-https.sh
- 访问应用验证
场景 2: 遇到问题
- 运行 diagnose.js
- 查看 TROUBLESHOOTING.md
- 检查相应日志
场景 3: 需要快速查找
- 使用 QUICK_REFERENCE.md
- 查找相应命令或信息
场景 4: 需要详细了解
- 阅读 SOLUTION_SUMMARY.md
- 查看 HTTPS_DEPLOYMENT_GUIDE.md
- 参考 DEPLOYMENT_README.md
场景 5: 性能优化
- 查看 DEPLOYMENT_README.md 性能优化部分
- 运行 diagnose.js 检查性能指标
- 实施优化措施
📝 文档维护
最后更新
- 日期: 2024-03-12
- 版本: 1.0.0
- 状态: ✓ 生产就绪
更新日志
- v1.0.0: 初始版本，包含完整的部署指南和故障排查文档
反馈和改进
- 如有问题或建议，请提交 Issue
- 如有改进建议，请提交 Pull Request
开始部署: DEPLOYMENT_README.md
快速查找: QUICK_REFERENCE.md
遇到问题: TROUBLESHOOTING.md