TiDB AI 安装与使用指南

目录结构及介绍

在克隆或下载了 tidb.ai 开源项目后，你会发现以下主要目录：

• .github: 包含 GitHub 的工作流和持续集成相关配置。
• backend: 存储着 TiDB AI 后端服务的所有代码和资源，包括但不限于 API 接口和服务逻辑实现。
• frontend: 负责前端界面的设计和交互逻辑，使用户能够直观地操作 TiDB AI 功能。
• .dockerignore: Docker 构建时忽略的文件列表，以保证 Docker 镜像的体积尽可能小。
• env.example: 系统环境变量示例模板，用于指导正确配置系统环境变量。
• gitignore: 指定了 Git 忽略的文件规则，确保特定类型的文件不被纳入版本控制。
• LICENSE.txt: 明确该项目的许可协议类型，即 Apache License 2.0。
• README.md: 提供了项目的主要功能、安装流程和使用方法等基本信息。
• docker-compose.yml: Docker Compose 文件，定义了多容器应用的服务及其依赖关系。

项目的启动文件介绍

• 在 backend 目录下，通常会找到一个名为 main.go 或 app.js 的主入口文件（具体取决于项目使用的编程语言），它是后端服务的起点，负责初始化 TiDB 连接、加载中间件以及设置 HTTP 服务器监听。

• 前端部分可能有一个 index.html 和相关的 index.js 文件，它们是前端页面和交互的核心所在。

为了启动整个项目，首先需确保已安装所有必需的依赖项。这通常通过运行 npm install （如果是 JavaScript）或 go mod tidy（如果是 Go）完成。之后，在终端中导航至项目根目录并执行下面的命令来启动 Docker Compose 配置的环境:

docker-compose up -d

此命令将自动创建所需的 Docker 网络、容器和服务，从而让你可以访问 TiDB AI 应用程序。

项目的配置文件介绍

env.example 是项目的环境变量配置模板，其中列出了所有必需的变量及其默认值或注释说明。在实际部署前，你需要创建一个 .env 文件并将示例中的变量替换为你自己系统的配置信息，例如数据库连接字符串、API 密钥和其他敏感数据。.env 文件应添加到 .gitignore 中，防止它泄露给公共仓库。

以下是几个关键配置参数的例子：

• TIUP_MIRROR：TiDB 镜像地址，用来加速 TiDB 组件的下载。
• VECTOR_STORAGE_URL：向量存储服务的 URL，对于 TiDB AI 来说，这是 TiDB Serverless Vector Storage 的位置。
• LLAMA_INDEX_API_KEY：LlamaIndex 的 API 密钥，用于处理知识图谱查询。

正确的配置不仅能确保应用程序平稳运行，还保障了数据安全性和隐私性。务必遵循最佳实践，切勿将任何机密信息硬编码在你的源代码中。