Revamp documentation structure in mkdocs.yml by reorganizing navigation for improved accessibility. Remove outdated content from previous sections and introduce new topics including detailed guides on assistant management, configuration options, and tool integrations. Enhance API reference documentation with comprehensive error codes and WebSocket protocol details. Add new sections for automated testing, data analysis, and knowledge base management, ensuring a cohesive and user-friendly documentation experience.
This commit is contained in:
42
docs/content/deployment/index.md
Normal file
42
docs/content/deployment/index.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# 部署指南
|
||||
|
||||
本章节介绍如何将 AI Video Assistant 部署到生产环境。
|
||||
|
||||
## 部署方式
|
||||
|
||||
| 方式 | 适用场景 | 复杂度 |
|
||||
|------|---------|--------|
|
||||
| [Docker 部署](docker.md) | 快速部署、容器化环境 | 简单 |
|
||||
| [生产环境](production.md) | Nginx 反向代理、高可用 | 中等 |
|
||||
|
||||
## 快速开始
|
||||
|
||||
### Docker 一键部署
|
||||
|
||||
```bash
|
||||
docker build -t ai-video-assistant-web ./web
|
||||
docker run -d -p 3000:80 --name ai-assistant-web ai-video-assistant-web
|
||||
```
|
||||
|
||||
### 验证部署
|
||||
|
||||
1. 访问 http://your-domain.com
|
||||
2. 检查页面是否正常加载
|
||||
3. 验证各功能模块是否可用
|
||||
|
||||
## 环境变量配置
|
||||
|
||||
| 变量 | 说明 | 默认值 |
|
||||
|------|------|--------|
|
||||
| VITE_API_URL | 后端 API 地址 | http://localhost:8080 |
|
||||
| VITE_GEMINI_API_KEY | Gemini API Key | - |
|
||||
|
||||
## 故障排查
|
||||
|
||||
| 问题 | 解决方案 |
|
||||
|------|---------|
|
||||
| 页面空白 | 检查浏览器控制台错误 |
|
||||
| API 请求失败 | 确认 VITE_API_URL 配置正确 |
|
||||
| 静态资源 404 | 检查 nginx try_files 配置 |
|
||||
|
||||
更多问题请参考 [故障排查](../resources/troubleshooting.md)。
|
||||
Reference in New Issue
Block a user