Update documentation and configuration for Realtime Agent Studio
- Revised mkdocs.yml to reflect the new site name and description, enhancing clarity for users. - Added a changelog.md to document important changes and updates for the project. - Introduced a roadmap.md to outline development plans and progress for future releases. - Expanded index.md with a comprehensive overview of the platform, including core features and installation instructions. - Enhanced concepts documentation with detailed explanations of assistants, engines, and their configurations. - Updated configuration documentation to provide clear guidance on environment setup and service configurations. - Added extra JavaScript for improved user experience in the documentation site.
This commit is contained in:
Xin Wang
@@ -1,65 +1,158 @@
|
||||
# 环境要求
|
||||
|
||||
本页面列出运行 Realtime Agent Studio 所需的软件和硬件要求。
|
||||
|
||||
---
|
||||
|
||||
## 软件依赖
|
||||
|
||||
### 必需软件
|
||||
|
||||
| 软件 | 版本要求 | 说明 |
|
||||
| 软件 | 版本要求 | 说明 | 安装命令 |
|
||||
|------|---------|------|---------|
|
||||
| **Node.js** | 18.0+ | 前端构建运行 | `nvm install 18` |
|
||||
| **Python** | 3.10+ | 后端服务 | `pyenv install 3.10` |
|
||||
| **Docker** | 20.10+ | 容器化部署（可选） | [安装指南](https://docs.docker.com/get-docker/) |
|
||||
|
||||
### 可选软件
|
||||
|
||||
| 软件 | 版本要求 | 用途 |
|
||||
|------|---------|------|
|
||||
| Node.js | 18.0 或更高 | JavaScript 运行时 |
|
||||
| npm/yarn/pnpm | 最新版本 | 包管理器 |
|
||||
| Python | 3.10+ | 后端服务运行环境 |
|
||||
| **Docker Compose** | 2.0+ | 多服务编排 |
|
||||
| **PostgreSQL** | 14+ | 生产数据库 |
|
||||
| **Redis** | 6.0+ | 缓存与会话 |
|
||||
| **Nginx** | 1.20+ | 反向代理 |
|
||||
|
||||
### 推荐浏览器
|
||||
---
|
||||
|
||||
| 浏览器 | 版本要求 |
|
||||
|--------|---------|
|
||||
| Chrome | 90+ |
|
||||
| Firefox | 90+ |
|
||||
| Edge | 90+ |
|
||||
| Safari | 14+ |
|
||||
## 版本检查
|
||||
|
||||
## 检查环境
|
||||
运行以下命令验证环境：
|
||||
|
||||
运行以下命令检查已安装的软件版本：
|
||||
=== "Node.js"
|
||||
|
||||
```bash
|
||||
# 检查 Node.js 版本
|
||||
node --version
|
||||
```bash
|
||||
node --version
|
||||
# v18.0.0 或更高
|
||||
|
||||
npm --version
|
||||
# 8.0.0 或更高
|
||||
```
|
||||
|
||||
# 检查 npm 版本
|
||||
npm --version
|
||||
=== "Python"
|
||||
|
||||
# 检查 Python 版本
|
||||
python --version
|
||||
```
|
||||
```bash
|
||||
python --version
|
||||
# Python 3.10.0 或更高
|
||||
|
||||
pip --version
|
||||
# pip 22.0 或更高
|
||||
```
|
||||
|
||||
## 硬件建议
|
||||
=== "Docker"
|
||||
|
||||
```bash
|
||||
docker --version
|
||||
# Docker version 20.10.0 或更高
|
||||
|
||||
docker compose version
|
||||
# Docker Compose version v2.0.0 或更高
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 浏览器支持
|
||||
|
||||
控制台需要现代浏览器支持 WebSocket 和 Web Audio API：
|
||||
|
||||
| 浏览器 | 最低版本 | 推荐版本 |
|
||||
|--------|---------|---------|
|
||||
| Chrome | 90+ | 最新版 |
|
||||
| Firefox | 90+ | 最新版 |
|
||||
| Edge | 90+ | 最新版 |
|
||||
| Safari | 14+ | 最新版 |
|
||||
|
||||
!!! warning "IE 不支持"
|
||||
Internet Explorer 不受支持，请使用现代浏览器。
|
||||
|
||||
---
|
||||
|
||||
## 硬件要求
|
||||
|
||||
### 开发环境
|
||||
|
||||
| 资源 | 建议配置 |
|
||||
|------|---------|
|
||||
| CPU | 4 核心以上 |
|
||||
| 内存 | 8GB 以上 |
|
||||
| 磁盘 | 20GB 可用空间 |
|
||||
| 资源 | 最低配置 | 推荐配置 |
|
||||
|------|---------|---------|
|
||||
| **CPU** | 2 核心 | 4 核心+ |
|
||||
| **内存** | 4GB | 8GB+ |
|
||||
| **磁盘** | 10GB | 20GB+ SSD |
|
||||
| **网络** | 10Mbps | 100Mbps |
|
||||
|
||||
### 生产环境
|
||||
|
||||
| 资源 | 建议配置 |
|
||||
|------|---------|
|
||||
| CPU | 8 核心以上 |
|
||||
| 内存 | 16GB 以上 |
|
||||
| 磁盘 | 100GB SSD |
|
||||
| 网络 | 100Mbps 以上 |
|
||||
| 资源 | 小规模 (< 100 并发) | 中规模 (< 1000 并发) | 大规模 (> 1000 并发) |
|
||||
|------|---------------------|---------------------|---------------------|
|
||||
| **CPU** | 4 核心 | 8 核心 | 16 核心+ |
|
||||
| **内存** | 8GB | 16GB | 32GB+ |
|
||||
| **磁盘** | 50GB SSD | 200GB SSD | 500GB+ SSD |
|
||||
| **网络** | 100Mbps | 1Gbps | 10Gbps |
|
||||
|
||||
---
|
||||
|
||||
## 网络要求
|
||||
|
||||
以下域名需要可访问（用于 API 调用）：
|
||||
### 出站访问
|
||||
|
||||
| 服务 | 域名 |
|
||||
|------|------|
|
||||
| OpenAI | api.openai.com |
|
||||
| DeepSeek | api.deepseek.com |
|
||||
| 阿里云 TTS | nls-gateway.cn-shanghai.aliyuncs.com |
|
||||
| 火山引擎 | openspeech.bytedance.com |
|
||||
以下外部服务需要网络可达（根据使用的模型供应商）：
|
||||
|
||||
| 服务 | 域名 | 端口 | 用途 |
|
||||
|------|------|------|------|
|
||||
| **OpenAI** | api.openai.com | 443 | LLM / TTS |
|
||||
| **Azure OpenAI** | *.openai.azure.com | 443 | LLM / ASR / TTS |
|
||||
| **阿里云** | *.aliyuncs.com | 443 | DashScope TTS |
|
||||
| **SiliconFlow** | api.siliconflow.cn | 443 | ASR / TTS |
|
||||
| **DeepSeek** | api.deepseek.com | 443 | LLM |
|
||||
|
||||
### 端口规划
|
||||
|
||||
| 服务 | 默认端口 | 可配置 |
|
||||
|------|---------|--------|
|
||||
| Web 前端 | 3000 | ✅ |
|
||||
| API 服务 | 8080 | ✅ |
|
||||
| Engine 服务 | 8000 | ✅ |
|
||||
| PostgreSQL | 5432 | ✅ |
|
||||
| Redis | 6379 | ✅ |
|
||||
|
||||
---
|
||||
|
||||
## 操作系统
|
||||
|
||||
### 支持的系统
|
||||
|
||||
| 操作系统 | 版本 | 支持状态 |
|
||||
|---------|------|---------|
|
||||
| **Ubuntu** | 20.04 LTS, 22.04 LTS | ✅ 完全支持 |
|
||||
| **Debian** | 11, 12 | ✅ 完全支持 |
|
||||
| **CentOS** | 8+ | ✅ 完全支持 |
|
||||
| **macOS** | 12+ (Monterey) | ✅ 开发支持 |
|
||||
| **Windows** | 10/11 + WSL2 | ✅ 开发支持 |
|
||||
|
||||
### Windows 注意事项
|
||||
|
||||
推荐使用 WSL2 进行开发：
|
||||
|
||||
```powershell
|
||||
# 安装 WSL2
|
||||
wsl --install
|
||||
|
||||
# 安装 Ubuntu
|
||||
wsl --install -d Ubuntu
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 下一步
|
||||
|
||||
- [配置说明](configuration.md) - 环境变量配置
|
||||
- [安装部署](index.md) - 开始安装
|
||||
- [Docker 部署](../deployment/docker.md) - 容器化部署
|
||||
|
||||
Reference in New Issue
Block a user