
R2R 官方管理门户实战指南Dashboard 的安装部署、功能模块与二次开发【免费下载链接】R2RSoTA production-ready AI retrieval system. Agentic Retrieval-Augmented Generation (RAG) with a RESTful API.项目地址: https://gitcode.com/GitHub_Trending/r2/R2RR2R 官方开源了一个基于 React Next.js 构建的 Dashboard 应用R2R-Application它为开发者提供了 R2R 部署的后台管理门户也为终端用户提供了一个开箱即用的交互界面。本指南以该 Dashboard 为核心完整讲解 PNPM 环境准备、Docker 与源码两种安装运行方式、登录与后端连接配置、六大功能模块登录、文档、集合、聊天、用户、设置的使用方式并结合本仓库中的 Compose 编排、认证提供器与 v3 API 路由源码帮助读者快速搭建并深度定制自己的 R2R 管理门户。R2R Dashboard 与后端服务的关系R2R 是一个面向生产的 AI 检索系统Agentic RAG其核心后端以 FastAPI 构建默认监听0.0.0.0:7272端口见 app.py 中R2RApp.serve的 uvicorn 配置端口可通过环境变量R2R_PORT覆盖默认值为7272见 app_entry.py。后端在/v3前缀下挂载了 chunks、collections、conversations、documents、graph、indices、prompts、retrieval、system、users 共 10 个路由模块见 app.py。Dashboard 正是这些 RESTful API 的可视化前端它通过NEXT_PUBLIC_R2R_DEPLOYMENT_URL环境变量定位后端地址并使用 JWT / API Key 完成认证。后端在 app.py 中显式将http://localhost:3000Dashboard 开发端口与http://localhost:7272后端自身端口加入 CORS 白名单允许跨域访问这正是 Dashboard 与后端协同工作的基础。环境准备安装 PNPMR2R Dashboard 使用PNPM作为包管理器。PNPM 以安装速度快、磁盘空间占用低著称。在 Unix 系Linux、macOS系统上执行curl -fsSL https://get.pnpm.io/install.sh | sh -在 Windows 上执行iwr https://get.pnpm.io/install.ps1 -useb | iex安装完成后可能需要将 PNPM 加入系统 PATH 才能直接使用pnpm命令。安装与运行 R2R Dashboard方式一通过 Docker 一键获得推荐如果你使用 Docker 运行 R2R那么 Dashboard 已经随编排文件一并启动无需任何额外安装直接访问 http://localhost:7273 即可。在本仓库的 docker/compose.yaml 中可以看到对应服务定义r2r-dashboard服务使用镜像sciphiai/r2r-dashboard:1.0.3读取 docker/env/r2r-dashboard.env 中的环境变量并将容器内部端口3000映射到宿主机7273配置为7273:3000。其环境变量文件内容为NEXT_PUBLIC_R2R_DEPLOYMENT_URLhttp://localhost:7272即容器内前端默认连接宿主机7272端口的 R2R 后端。若使用完整版编排 docker/compose.full.yaml还会一并启动 Hatchet 工作流引擎、Hatchet Dashboard端口7274、Unstructured 解析服务7275与图聚类服务7276此时r2r-dashboard服务同样映射7273:3000。在 Swarm 模式下docker/compose.full.swarm.yaml 额外支持通过${R2R_DASHBOARD_PORT:-7273}自定义 Dashboard 对外端口。方式二源码方式运行脱离 Docker 环境当 R2R 运行在 Docker 之外时可拉取 Dashboard 源码自行构建运行克隆项目仓库并进入项目目录git clone https://github.com/SciPhi-AI/R2R.git cd R2R-Application安装项目依赖pnpm install构建并启动生产版本pnpm build pnpm start此时 Dashboard 将运行在 http://localhost:3000。注意源码方式运行时需确保NEXT_PUBLIC_R2R_DEPLOYMENT_URL指向可达的 R2R 后端地址默认http://localhost:7272否则登录与数据请求将失败。关于本地部署 R2R 后端服务的完整步骤可参考本地部署指南。登录与后端连接配置打开 Dashboard 后首先需要登录。首次登录时使用界面中展示的默认凭据即可。默认情况下R2R 实例运行在7272端口。登录页会默认预填该 URL如果 R2R 实例部署在其他位置务必更新登录页中的后端地址。仓库中的认证示例配置 r2r_with_auth.toml 定义了默认管理员账号adminexample.com、密码change_me_immediately并设置了access_token_lifetime_in_minutes 60、refresh_token_lifetime_in_days 7、require_authentication true。实际 Docker 镜像中的默认凭据以部署时使用的配置文件为准。登录背后的认证逻辑由 r2r_auth.py 中的R2RAuthProvider实现首次初始化时它会自动注册默认超级管理员initialize方法登录成功后签发 access token 与 refresh token生命周期默认分别为 3600 分钟与 7 天见 r2r_auth.py并支持 API Key 形式的二次认证回退。每次注册新用户时系统还会自动为用户创建默认集合、对应的知识图谱并将用户加入该集合见 r2r_auth.py因此登录后即可直接使用文档与聊天功能。功能模块详解Documents文档管理文档页提供已上传文档及其元数据的总览。你可以在此上传新文档更新、下载或删除已有文档查看每份文档的详细信息包括文档的chunks分块与PDF 预览。文档页背后对应后端 documents_router.py 中的一组 RESTful 端点包括POST /v3/documents上传、GET /v3/documents分页列表、/v3/documents/export导出、/v3/documents/download_zip打包下载与/v3/documents/search文档级检索。分块信息则由 chunks_router.py 提供。更深入的文档模型与分块机制可参考文档管理指南。Collections集合管理集合Collections允许用户创建并共享文档集。集合页用于管理已有集合或创建新集合方便按主题或团队组织检索语料。后端对应 collections_router.py提供集合的增删改查、文档归属与集合导出如POST /v3/collections/export等端点。集合的完整概念与用法可参考集合指南。Chat流式 RAG 对话聊天页支持流式streamingRAG 响应可选择不同模型与可配置参数并与RAG Agent和RAG 两种端点交互。后端对应 retrieval_router.py 中_setup_routes注册的检索端点POST /v3/retrieval/search语义搜索、POST /v3/retrieval/rag标准 RAG 问答、POST /v3/retrieval/agentAgentic RAG、POST /v3/retrieval/completion补全与POST /v3/retrieval/embedding向量化。这些端点均支持流式输出聊天页通过 SSE 实时渲染生成内容。想了解不同模式差异可阅读 RAG 入门指南 与 Agentic RAG 文档。Users用户管理用户页用于管理用户并洞察其交互行为包括账号状态、权限与使用情况。后端对应 users_router.py提供用户信息管理、导出POST /v3/users/export等端点认证与权限模型由 r2r_auth.py 支撑。详见用户指南。Settings配置与提示词管理设置页允许查看 R2R 部署的配置并编辑与部署关联的 prompts提示词。这些提示词定义于 py/core/providers/database/prompts/ 目录下的 YAML 文件中包括rag.yaml、rag_fusion.yaml、hyde.yaml、graph_extraction.yaml、dynamic_rag_agent.yaml等——它们分别对应混合搜索增强、HyDE、图谱抽取、动态 RAG Agent 等不同场景的提示词模板。后端通过 prompts_router.py 暴露提示词的查询与更新端点。提示词的完整语法与自定义方法可参考提示词指南。开发模式与代码规范如果需要在本仓库之外对 Dashboard 进行二次开发可按以下流程启动开发服务器启动开发服务器pnpm dev运行提交前检查可选但推荐pnpm format pnpm lint开发模式下 Next.js 会提供热更新前端运行于3000端口修改NEXT_PUBLIC_R2R_DEPLOYMENT_URL可切换目标后端。在 Kubernetes 中部署 Dashboard对于 K8s 环境本仓库提供了现成的清单 r2r-dashboard-indep.yaml 定义了r2r-dashboard的 Deployment 与 Service镜像emrgntcmplxty/r2r-dashboard:1.0.1容器端口3000对应 Compose 中${R2R_DASHBOARD_PORT:-7273}的外部端口语义并通过 cm-r2r.yaml 中的 ConfigMap 注入NEXT_PUBLIC_R2R_DEPLOYMENT_URLhttp://r2r:7272等环境变量。若需对外暴露 Dashboard可参考 ingress-r2r.yaml 示例将r2r-dashboard服务挂到 Ingress 上。小结从本指南可以看出R2R Dashboard 是一个与后端 v3 API 深度耦合、开箱即用的管理门户Docker 部署零配置直接访问7273端口即可使用源码部署只需 PNPM 三步install / build / start六大功能模块分别对应后端文档、集合、检索、用户、提示词等 RESTful 路由任何通过 API 能完成的操作都能在界面上可视化完成开发者可基于pnpm dev快速迭代并利用设置页在线调整提示词而无需重启服务。无论是快速体验 R2R 的 Agentic RAG 能力还是构建面向团队的知识库管理后台这份 Dashboard 都是最直接的入口。【免费下载链接】R2RSoTA production-ready AI retrieval system. Agentic Retrieval-Augmented Generation (RAG) with a RESTful API.项目地址: https://gitcode.com/GitHub_Trending/r2/R2R创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考