docs/DEPLOYMENT_GUIDE_zh.md
本指南将帮助您按照正确的顺序启动 astronAgent 项目的所有组件，包括身份认证、知识库和核心服务。
astronAgent 项目包含以下三个主要组件：
Agent系统配置要求
RAGFlow配置要求
Casdoor 是一个开源的身份和访问管理平台，提供OAuth 2.0、OIDC、SAML等多种认证协议支持。
启动 Casdoor 服务请运行我们的 docker-compose-with-auth.yaml 文件。在运行安装命令之前，请确保您的机器上安装了 Docker 和 Docker Compose。
# 进入 astronAgent 目录
cd docker/astronAgent
# 启动 Casdoor 服务
docker compose -f docker-compose-auth.yml up -d
服务信息：
RagFlow 是一个开源的RAG（检索增强生成）引擎，使用深度文档理解技术提供准确的问答服务。
启动 RagFlow 服务请运行我们的 docker-compose.yml 文件或 docker-compose-macos.yml 。在运行安装命令之前，请确保您的机器上安装了 Docker 和 Docker Compose。
# 进入 RagFlow 目录
cd docker/ragflow
# 给所有 sh 文件添加可执行权限
chmod +x *.sh
# 启动 RagFlow 服务（包含所有依赖）
docker compose up -d
访问地址：
模型配置步骤：
重要配置说明：
docker-compose-gpu.yml 启动在启动 astronAgent 服务之前，配置相关的连接信息以集成 Casdoor 和 RagFlow。
# 进入 astronAgent 目录
cd docker/astronAgent
# 复制环境变量配置
cp .env.example .env
编辑 docker/astronAgent/.env 文件，配置 RagFlow 连接信息：
# 进入 astronAgent 目录
cd docker/astronAgent
# 编辑环境变量配置
vim .env
关键配置项：
# RAGFlow配置
RAGFLOW_BASE_URL=http://localhost:18080
RAGFLOW_API_TOKEN=ragflow-your-api-token-here
RAGFLOW_TIMEOUT=60
RAGFLOW_DEFAULT_GROUP=星辰知识库
获取 RagFlow API Token：
编辑 docker/astronAgent/.env 文件，配置 Casdoor 连接信息：
关键配置项：
# Casdoor配置
CONSOLE_CASDOOR_URL=http://your-casdoor-server:8000
CONSOLE_CASDOOR_ID=your-casdoor-client-id
CONSOLE_CASDOOR_APP=your-casdoor-app-name
CONSOLE_CASDOOR_ORG=your-casdoor-org-name
获取 Casdoor 配置信息：
访问 Casdoor 管理控制台： http://localhost:8000
使用默认管理员账号登录：admin / 123
创建组织 进入 http://localhost:8000/organizations 页面，点击"添加"，填写组织名称后保存并退出。
创建应用并绑定组织 进入 http://localhost:8000/applications 页面，点击"添加"。
创建应用时填写以下信息：
agent80，使用 http://your-local-ip/callback；如果是其他端口（例如 888），使用 http://your-local-ip:888/callback保存应用后，记录以下信息并与项目配置项一一对应：
| Casdoor 信息项 | 示例值 | .env 中对应配置项 |
|---|---|---|
| Casdoor 服务地址（URL） | http://localhost:8000 | CONSOLE_CASDOOR_URL=http://localhost:8000 |
| 客户端 ID（Client ID） | your-casdoor-client-id | CONSOLE_CASDOOR_ID=your-casdoor-client-id |
| 应用名称（Name） | your-casdoor-app-name | CONSOLE_CASDOOR_APP=your-casdoor-app-name |
| 组织名称（Organization） | your-casdoor-org-name | CONSOLE_CASDOOR_ORG=your-casdoor-org-name |
# 进入 astronAgent 目录
cd docker/astronAgent
# 编辑环境变量配置
vim .env
获取文档详见：https://www.xfyun.cn/doc/platform/quickguide.html
创建应用完成后可能需要购买或领取相应能力的API授权服务量
编辑 docker/astronAgent/.env 文件，更新相关环境变量：
PLATFORM_APP_ID=your-app-id
PLATFORM_API_KEY=your-api-key
PLATFORM_API_SECRET=your-api-secret
SPARK_API_PASSWORD=your-api-password
SPARK_RTASR_API_KEY=your-rtasr-api-key
SPARK_VIRTUAL_MAN_APP_ID=your-virtual-man-app-id
SPARK_VIRTUAL_MAN_API_KEY=your-virtual-man-api-key
SPARK_VIRTUAL_MAN_API_SECRET=your-virtual-man-api-secret
# 用于配置平台 AI 生成相关能力(兼容openai协议), 如提示词优化、一句话创建智能体等。
AI_ABILITY_CHAT_BASE_URL=your-model-url
AI_ABILITY_CHAT_MODEL=your-model-id
AI_ABILITY_CHAT_API_KEY=your-api-key
星火RAG云服务提供两种使用方式：
如果您更喜欢使用命令行工具，可以通过以下 cURL 命令创建数据集：
# 创建星火RAG数据集
curl -X PUT 'https://chatdoc.xfyun.cn/openapi/v1/dataset/create' \
-H "Accept: application/json" \
-H "appId: your_app_id" \
-H "timestamp: $(date +%s)" \
-H "signature: $(echo -n "$(echo -n "your_app_id$(date +%s)" | md5sum | awk '{print $1}')" | openssl dgst -sha1 -hmac 'your_api_secret' -binary | base64)" \
-F "name=我的数据集"
注意事项：
your_app_id 替换为您的实际 APP IDyour_api_secret 替换为您的实际 API Secret获取到数据集ID后，请将数据集ID更新到 docker/astronAgent/.env 文件中：
XINGHUO_DATASET_ID=
启动之前请配置一些必须的环境变量，并确保nginx和minio的端口开放
# 进入 astronAgent 目录
cd docker/astronAgent
# 根据需要修改配置
vim .env
HOST_BASE_ADDRESS=http://localhost (astronAgent服务主机地址)
启动 astronAgent 服务请运行我们的 docker-compose.yaml 文件。在运行安装命令之前，请确保您的机器上安装了 Docker 和 Docker Compose。
# 进入 astronAgent 目录
cd docker/astronAgent
# 启动所有服务
docker compose up -d
启动完成后，您可以通过以下地址访问各项服务：
如遇到问题，请：
注意：首次部署建议在测试环境中验证所有功能后再部署到生产环境。