RAG Web UI 项目使用教程

RAG Web UI 项目使用教程

rag-web-ui RAG Web UI is an intelligent dialogue system based on RAG (Retrieval-Augmented Generation) technology. 项目地址: https://gitcode.com/gh_mirrors/ra/rag-web-ui

1. 项目目录结构及介绍

RAG Web UI 是一个基于 RAG（Retrieval-Augmented Generation）技术的智能对话系统。项目的目录结构如下：

rag-web-ui/
├── .github/              # GitHub 工作流和配置文件
├── backend/              # 后端代码目录
├── docs/                 # 文档目录
├── frontend/             # 前端代码目录
├── .env.example          # 环境变量示例文件
├── .gitattributes         # Git 属性文件
├── .gitignore            # Git 忽略文件
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── README.zh-CN.md        # 项目说明文件（中文）
├── docker-compose.dev.yml # Docker 开发环境配置文件
├── docker-compose.yml     # Docker 生产环境配置文件
├── nginx.conf            # Nginx 配置文件
├── nginx.dev.conf        # Nginx 开发环境配置文件

• backend/：包含后端代码，使用 Python FastAPI 框架。
• frontend/：包含前端代码，使用 Next.js 框架。
• .env.example：提供了环境变量的配置示例。
• docker-compose.*.yml：用于配置 Docker 容器服务。
• nginx.*.conf：Nginx 的配置文件，用于反向代理等。

2. 项目的启动文件介绍

项目的启动主要涉及 Docker 容器的启动。以下是启动开发环境的基本步骤：

1. 克隆项目仓库到本地：

   git clone https://github.com/rag-web-ui/rag-web-ui.git
   cd rag-web-ui
   

2. 配置环境变量：

   复制 .env.example 文件为 .env 并根据实际情况编辑环境变量。

   cp .env.example .env
   

3. 启动 Docker 服务：

   docker compose up -d --build
   

启动后，可以通过以下 URL 访问服务：

• 前端 UI：http://127.0.0.1.nip.io
• API 文档：http://127.0.0.1.nip.io/redoc
• MinIO 控制台：http://127.0.0.1.nip.io:9001

3. 项目的配置文件介绍

项目的配置文件主要包括 .env 文件和一些 Docker 配置文件。

• .env：该文件包含项目的环境变量，如数据库配置、JWT 密钥、LLM（大型语言模型）提供者配置等。以下是部分配置项：

  MYSQL_SERVER=localhost
  MYSQL_USER=postgres
  MYSQL_PASSWORD=postgres
  MYSQL_DATABASE=ragwebui
  SECRET_KEY=your_secret_key
  ACCESS_TOKEN_EXPIRE_MINUTES=30
  

• docker-compose.*.yml：这些文件用于定义 Docker 容器的服务，包括数据库、前端、后端等服务的配置。例如，docker-compose.dev.yml 包含开发环境的配置。

以上是 RAG Web UI 项目的目录结构、启动文件和配置文件的简要介绍。按照以上步骤，你可以轻松地搭建和运行这个项目。

rag-web-ui RAG Web UI is an intelligent dialogue system based on RAG (Retrieval-Augmented Generation) technology. 项目地址: https://gitcode.com/gh_mirrors/ra/rag-web-ui