1022
This commit is contained in:
136
fastgpt/README.md
Normal file
136
fastgpt/README.md
Normal file
@@ -0,0 +1,136 @@
|
||||
# FastGPT Docker 部署指南
|
||||
|
||||
FastGPT 是一个基于大语言模型的知识库问答系统,提供开箱即用的数据处理、模型调用等能力。
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 1. 创建目录并进入
|
||||
```bash
|
||||
mkdir fastgpt && cd fastgpt
|
||||
```
|
||||
|
||||
### 2. 下载配置文件
|
||||
```bash
|
||||
# 复制 docker-compose.yml 文件
|
||||
cp /mnt/e/020-awei-cloud-9900k-code/common-server-public/fastgpt/docker-compose.yml .
|
||||
|
||||
# 复制环境变量文件
|
||||
cp /mnt/e/020-awei-cloud-9900k-code/common-server-public/fastgpt/.env.example .env
|
||||
```
|
||||
|
||||
### 3. 配置环境变量
|
||||
编辑 `.env` 文件,设置必要的配置:
|
||||
|
||||
```bash
|
||||
# 必需配置
|
||||
POSTGRES_PASSWORD=your_secure_postgres_password
|
||||
MONGO_PASSWORD=your_secure_mongo_password
|
||||
OPENAI_API_KEY=your_openai_api_key_here
|
||||
JWT_SECRET=your_very_long_jwt_secret_key_here
|
||||
APIKEY=your_api_key_here
|
||||
FILE_TOKEN_KEY=your_file_token_key_here
|
||||
|
||||
# 默认管理员密码
|
||||
DEFAULT_ROOT_PSW=your_admin_password
|
||||
```
|
||||
|
||||
### 4. 启动服务
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### 5. 访问 FastGPT
|
||||
- FastGPT 主应用:http://localhost:3000
|
||||
|
||||
默认管理员账号:
|
||||
- 用户名:root
|
||||
- 密码:您在 `.env` 中设置的 `DEFAULT_ROOT_PSW`
|
||||
|
||||
## 服务说明
|
||||
|
||||
### 核心服务
|
||||
- **FastGPT**: 主应用服务(端口 3000)
|
||||
- **PostgreSQL**: 数据库服务,支持 pgvector 向量搜索
|
||||
- **MongoDB**: 文档数据库
|
||||
- **Redis**: 缓存服务
|
||||
|
||||
### 数据持久化
|
||||
- PostgreSQL 数据:`postgres_data`
|
||||
- MongoDB 数据:`mongo_data`
|
||||
- Redis 数据:`redis_data`
|
||||
|
||||
## 配置说明
|
||||
|
||||
### 必需环境变量
|
||||
- `OPENAI_API_KEY`: OpenAI API 密钥
|
||||
- `POSTGRES_PASSWORD`: PostgreSQL 数据库密码
|
||||
- `MONGO_PASSWORD`: MongoDB 数据库密码
|
||||
- `JWT_SECRET`: JWT 密钥,用于用户认证
|
||||
- `APIKEY`: FastGPT API 密钥
|
||||
- `FILE_TOKEN_KEY`: 文件上传令牌密钥
|
||||
|
||||
### 可选配置
|
||||
- `CLAUDE_API_KEY`: Claude API 密钥(可选)
|
||||
- `VECTOR_MAX_PROCESS`: 向量处理最大进程数(默认 10)
|
||||
- `QA_MAX_PROCESS`: 问答处理最大进程数(默认 10)
|
||||
|
||||
## 常用命令
|
||||
|
||||
```bash
|
||||
# 启动服务
|
||||
docker-compose up -d
|
||||
|
||||
# 停止服务
|
||||
docker-compose down
|
||||
|
||||
# 查看日志
|
||||
docker-compose logs -f
|
||||
|
||||
# 重启服务
|
||||
docker-compose restart
|
||||
|
||||
# 更新镜像
|
||||
docker-compose pull
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
## 功能特性
|
||||
|
||||
- 📚 知识库管理
|
||||
- 🔍 智能问答
|
||||
- 📄 文档处理
|
||||
- 🎯 向量搜索
|
||||
- 🔗 多模型支持(OpenAI、Claude 等)
|
||||
- 📊 可视化工作流
|
||||
- 👥 多用户管理
|
||||
- 🔐 API 管理
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **安全性**: 生产环境请使用强密码和密钥
|
||||
2. **端口冲突**: 确保端口 3000、5432、27017、6379 未被占用
|
||||
3. **资源要求**: 建议至少 4GB 内存,8GB 以上更佳
|
||||
4. **备份**: 定期备份数据库数据
|
||||
|
||||
## 故障排查
|
||||
|
||||
### 服务无法启动
|
||||
```bash
|
||||
# 检查容器状态
|
||||
docker-compose ps
|
||||
|
||||
# 查看具体服务日志
|
||||
docker-compose logs [service-name]
|
||||
```
|
||||
|
||||
### 数据库连接失败
|
||||
确保 PostgreSQL 和 MongoDB 服务正常启动,检查环境变量配置是否正确。
|
||||
|
||||
### API 调用失败
|
||||
检查 `OPENAI_API_KEY` 是否有效,以及 API 配额是否充足。
|
||||
|
||||
## 更多帮助
|
||||
|
||||
- FastGPT 官方文档:https://doc.fastgpt.in/
|
||||
- GitHub 仓库:https://github.com/labring/FastGPT
|
||||
- 社区支持:https://github.com/labring/FastGPT/issues
|
||||
Reference in New Issue
Block a user