sciphiai/r2r-dashboard

R2R AI检索系统仪表板 Docker镜像文档

1. 镜像概述和主要用途

本Docker镜像包含基于React和Next.js构建的前端仪表板，专为R2R（最先进的AI检索系统）设计。该仪表板提供直观的用户界面，支持与R2R AI检索系统的交互，包括数据管理、检索查询执行、结果可视化及系统监控等核心功能，帮助用户高效使用和管理AI检索服务。

2. 核心功能和特性

• 技术栈：基于React（UI库）和Next.js（服务端渲染框架）构建，确保高性能和现代前端体验
• 用户界面：直观的操作界面，包含导航菜单、数据概览面板、查询编辑器及结果展示区
• 数据可视化：支持检索结果统计图表、数据分布分析等可视化展示
• 检索管理：提供检索任务创建、编辑、删除功能，支持查询历史记录查看
• 系统集成：无缝对接R2R后端API，实现数据实时同步与交互
• 响应式设计：适配桌面、平板等多终端设备，确保跨设备使用体验

3. 使用场景和适用范围

适用用户

• R2R AI检索系统的开发人员
• 数据科学家和AI研究人员
• 负责AI检索系统运维的管理员
• 需要使用R2R进行检索任务的终端用户

典型使用场景

• AI检索系统的日常操作与管理
• 检索查询的创建、执行与结果分析
• 系统数据（如索引、文档）的导入与维护
• 检索性能指标监控与优化
• 团队协作中的检索任务共享与权限管理

4. 使用方法和配置说明

4.1 基本使用（Docker Run）

通过以下命令启动容器，默认暴露3000端口：

bash
docker run -d -p 3000:3000 --name r2r-dashboard [镜像名称]:[标签]

启动后，访问 http://localhost:3000 即可打开仪表板界面。

4.2 Docker Compose 配置示例

创建 docker-compose.yml 文件，配置如下：

yaml
version: '3'
services:
  r2r-dashboard:
    image: [镜像名称]:[标签]
    container_name: r2r-dashboard
    ports:
      - "3000:3000"
    environment:
      - API_URL=http://r2r-backend:8080  # R2R后端API地址
      - NODE_ENV=production  # 环境类型（production/development）
    restart: unless-stopped

执行 docker-compose up -d 启动服务。

4.3 环境变量配置

4.4 访问与初始化

1. 容器启动后，通过 http://[主机IP]:3000 访问仪表板
2. 首次登录需使用默认账号（具体凭据请参考R2R系统文档）
3. 在设置页面配置后端API地址（若未通过环境变量指定）
4. 完成初始化后即可开始使用检索查询、数据管理等功能

5. 注意事项

• 确保R2R后端服务已正常运行且与仪表板网络连通
• 生产环境中建议配置HTTPS（可通过反向代理如Nginx实现）
• 定期更新镜像以获取最新功能和安全补丁
• 敏感配置（如认证密钥）建议通过Docker Secrets或环境变量注入，避免硬编码