4.2 KiB
4.2 KiB
快速开始指南
Yuxi-Know（语析）是一个基于知识图谱和向量数据库的智能知识库系统。通过本文档，你可以在几分钟内完成环境搭建并开始使用。
::: tip 提示 除了此文档网站外，你还可以访问 Zread 或 DeepWiki 查看自动生成的详细项目文档。 :::
环境要求
项目采用微服务架构设计，默认服务无需 GPU 支持。如果需要使用 OCR 功能，可以通过环境变量配置外部服务。
快速安装
步骤一：获取项目代码
# 克隆稳定版本（推荐新用户使用 v0.5.1）
git clone --branch v0.5.1 --depth 1 https://github.com/xerrors/Yuxi-Know.git
cd Yuxi-Know
版本选择建议：
| 版本 | 适用场景 |
|---|---|
| v0.5.x | 稳定版本，适合生产环境使用 |
| main | 开发版本，包含最新特性（可能不稳定） |
步骤二：配置环境变量
方式一：使用初始化脚本（推荐）
我们提供了自动化脚本，帮你完成环境配置和 Docker 镜像拉取：
# Linux/macOS
./scripts/init.sh
# Windows PowerShell
.\scripts\init.ps1
脚本会引导你完成以下配置：
- 创建
.env配置文件 - 设置
SILICONFLOW_API_KEY（必需，用于调用大模型） - 设置
TAVILY_API_KEY（可选，用于搜索服务） - 自动拉取必需的 Docker 镜像
::: tip API Key 获取
- 硅基流动：访问 cloud.siliconflow.cn，注册即送 14 元额度
- Tavily：访问 app.tavily.com 获取搜索 API Key（可选） :::
方式二：手动配置
如果偏好手动配置：
# 复制环境变量模板
cp .env.template .env
# 编辑 .env 文件，填入你的 API Key
步骤三：启动服务
# 构建并启动所有服务
docker compose up --build -d
服务首次启动需要等待镜像拉取和编译，请耐心等待 2-3 分钟。
步骤四：访问系统
服务启动后，访问以下地址：
| 服务 | 地址 |
|---|---|
| Web 界面 | http://localhost:5173 |
| API 文档 | http://localhost:5050/docs |
首次访问时，系统会要求你设置超级管理员账号和密码，请妥善保存。
开始使用
完成上述配置后，你就可以开始使用了：
- 登录系统（使用刚才设置的超级管理员账号）
- 进入「智能体」页面
- 选择或创建一个智能体
- 在右侧面板配置提示词、选择模型和工具
- 开始对话
故障排除
查看服务状态
# 查看所有容器状态
docker ps
# 实时查看后端日志
docker logs api-dev -f
# 实时查看前端日志
docker logs web-dev -f
常见问题
Docker 镜像拉取失败
如果网络原因导致镜像拉取失败，可以尝试：
# 手动拉取基础镜像
bash docker/pull_image.sh python:3.12-slim
离线环境部署方案：
# 在有网络的环境导出镜像
bash docker/save_docker_images.sh
# 传输到目标机器
scp docker_images_xxx.tar user@host:/path/
# 导入镜像
docker load -i docker_images_xxx.tar
构建失败
多数构建失败是由于网络问题。尝试配置代理：
# Linux/macOS
export HTTP_PROXY=http://IP:PORT
export HTTPS_PROXY=http://IP:PORT
# Windows PowerShell
$env:HTTP_PROXY="http://IP:PORT"
$env:HTTPS_PROXY="http://IP:PORT"
如果配置代理后反而失败，尝试移除代理后重试。
Milvus 服务启动失败
# 重启 Milvus 服务
docker compose up milvus -d
docker restart api-dev
::: tip 调试面板 前端提供了调试面板（在头像菜单中可找到），可以查看详细的请求和响应信息。生产环境建议关闭此特性。 :::