30分钟上线！DocsGPT云端部署全攻略：Docker Compose与Kubernetes实战指南
项目地址: https://gitcode.com/GitHub_Trending/do/DocsGPT 你是否还在为文档查询效率低而烦恼？DocsGPT作为开源文档助手，能利用GPT模型帮助开发者在项目文档中快速找到所需信息。本文将详细介绍如何通过Docker Compose和Kubernetes两种方式实现DocsGPT的云端部署，让你轻松拥有高效的文档查询工具。读完本文，你将掌握两种主流部署方式的具体步骤、配置要点以及常见问题解决方法，快速将DocsGPT部署到云端环境。
部署方案对比与选择
在开始部署之前，先了解一下两种部署方案的特点，以便根据实际需求选择合适的方式。
Docker Compose适合小规模部署和快速启动，配置简单，易于维护，适合开发环境和中小型应用场景。Kubernetes则适用于大规模、高可用的生产环境，具有强大的扩展性和自愈能力，但配置相对复杂。
官方文档中对两种部署方式都有详细介绍，你可以参考Docker部署文档和Kubernetes部署文档获取更多信息。
Docker Compose部署步骤
环境准备
首先，确保你的系统中已经安装了Docker和Docker Compose。如果没有安装，可以按照以下步骤进行安装：
对于Ubuntu系统：
sudo apt update
sudo apt install docker.io
sudo apt install docker-compose
克隆项目代码
使用以下命令克隆DocsGPT项目代码：
git clone https://gitcode.com/GitHub_Trending/do/DocsGPT
cd DocsGPT
配置环境变量
在项目根目录下创建.env文件，并添加以下内容：
LLM_PROVIDER=docsgpt
VITE_API_STREAMING=true
这个配置文件指定了使用DocsGPT的公共API，你可以根据需要修改其他环境变量，具体可参考.env示例文件。
启动服务
使用Docker Compose启动服务：
docker compose -f deployment/docker-compose.yaml up -d
这个命令会根据docker-compose.yaml文件中的配置启动所有服务组件，包括前端、后端、Redis、MongoDB等。服务启动后，你可以通过访问http://localhost:5173来使用DocsGPT。
本地模型部署（可选）
如果你希望在本地运行模型，可以使用Ollama。首先，修改.env文件，添加以下配置：
LLM_PROVIDER=ollama
LLM_NAME=llama3.2:1b
然后，使用以下命令启动包含Ollama的服务：
docker compose --env-file .env -f deployment/docker-compose.yaml -f deployment/optional/docker-compose.optional.ollama-cpu.yaml up -d
启动后，需要拉取模型：
docker compose -f deployment/docker-compose.yaml -f deployment/optional/docker-compose.optional.ollama-cpu.yaml exec -it ollama ollama pull llama3.2:1b
服务管理
你可以使用以下命令停止服务：
docker compose -f deployment/docker-compose.yaml down
如果需要重启服务，可以先停止再启动，或者使用以下命令：
docker compose -f deployment/docker-compose.yaml restart
Kubernetes部署步骤
环境准备
确保你的系统中已经安装了kubectl，并能够访问Kubernetes集群。如果没有Kubernetes集群，可以使用Minikube或Kind创建本地集群。
克隆项目代码
同样，先克隆项目代码：
git clone https://gitcode.com/GitHub_Trending/do/DocsGPT
cd DocsGPT/deployment/k8s
配置密钥（可选）
如果需要配置密钥，可以编辑docsgpt-secrets.yaml文件，添加你的密钥信息，然后应用：
kubectl apply -f docsgpt-secrets.yaml
部署服务组件
使用以下命令部署所有服务组件：
kubectl apply -f deployments/
kubectl apply -f services/
这里的部署文件包括docsgpt-deploy.yaml、mongo-deploy.yaml等，服务配置文件包括docsgpt-service.yaml等。
配置API地址
部署完成后，需要获取API服务的外部IP，并更新前端配置：
API_IP=$(kubectl get services/docsgpt-api-service -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
sed -i "s|<your-api-endpoint>|$API_IP|g" deployments/docsgpt-deploy.yaml
kubectl apply -f deployments/
访问服务
使用以下命令获取前端服务的外部IP：
kubectl get services/docsgpt-frontend-service | awk 'NR>1 {print "http://" $4}'
然后，通过浏览器访问这个地址即可使用DocsGPT。
服务监控与扩展
你可以使用以下命令查看Pod状态：
kubectl get pods
如果需要扩展服务，可以修改部署文件中的replicas字段，或者使用以下命令：
kubectl scale deployment docsgpt-api --replicas=3
部署架构说明
DocsGPT的部署架构包括多个组件，它们之间的关系如下：
- 前端：提供Web界面，通过API与后端交互。
- 后端：处理API请求，与数据库、缓存、模型等交互。
- Worker：处理异步任务，如文档解析、模型推理等。
- Redis：用于缓存和Celery消息队列。
- MongoDB：存储用户数据、对话历史等。
- 向量存储：如Qdrant，用于存储文档向量，支持高效检索。
你可以参考项目中的架构文档了解更多细节。
常见问题解决
服务启动失败
如果服务启动失败，可以使用以下命令查看日志：
docker compose -f deployment/docker-compose.yaml logs -f
对于Kubernetes部署，可以使用：
kubectl logs <pod-name>
访问速度慢
如果访问速度慢，可能是因为使用了公共API。你可以尝试部署本地模型，或者检查网络连接。
数据持久化
Docker Compose部署中，MongoDB的数据存储在mongodb_data_container卷中，你可以通过修改docker-compose.yaml文件来配置数据存储路径。
在Kubernetes部署中，你可以使用PersistentVolume和PersistentVolumeClaim来实现数据持久化，具体配置可参考Kubernetes存储文档。
总结
本文介绍了使用Docker Compose和Kubernetes两种方式部署DocsGPT的详细步骤。Docker Compose适合快速启动和小规模部署，而Kubernetes适合大规模、高可用的生产环境。你可以根据自己的需求选择合适的部署方式。
如果你在部署过程中遇到问题，可以参考项目的部署文档或在社区寻求帮助。希望本文能够帮助你顺利部署DocsGPT，提高文档查询效率！
此外，除了Docker Compose和Kubernetes，你还可以尝试在Railway等平台部署DocsGPT，具体可参考Railway部署文档。
通过本文的指南，你已经掌握了DocsGPT的云端部署方法。现在，开始使用DocsGPT来提升你的文档查询体验吧！如果你有任何建议或问题，欢迎在项目的GitHub仓库中提出Issue或Pull Request。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
