R2R offers an open-source React+Next.js dashboard designed to give developers an administrative portal for their R2R deployment, and users an application to communicate with out of the box.

Setup

Install PNPM

PNPM is a fast, disk space-efficient package manager. To install PNPM, visit the official PNPM installation page or follow these instructions:

Installing and Running the R2R Dashboard

If you’re running R2R with the Docker, you already have the R2R dashboard running! Just navigate to http://localhost:3000.

If you’re running R2R outside of Docker, run the following commands to install the R2R Dashboard.

  1. Clone the project repository and navigate to the project directory:
git clone [email protected]:SciPhi-AI/R2R-Dashboard.git
cd R2R-Dashboard
  1. Install the project dependencies:
pnpm install
  1. Build and start the application for production:
pnpm build
pnpm start

The dashboard will be available at http://localhost:3000.

Features

Login

To interact with R2R with the dashboard, you must first login. If it’s your first time logging in, log in with the default credentials shown.

By default, an R2R instance is hosted on port 8000. The login page will include this URL by default, but be sure to update the URL if your R2R instance is deployed elsewhere. For information about deploying a local R2R application server, see the quickstart.

R2R Dashboard Overview

Documents

The documents page provides an overview of uploaded documents and their metadata. You can upload new documents and update or delete existing ones.

Documents Page

Playground

The playground allows streaming RAG responses with different models and configurable settings.

Playground Interface

Logs

The Logs page enables tracking of user queries, search results, and LLM responses.

Logs Page

Settings

The settings page allows you to view the configuration of and edit the prompts associated with your R2R deployment.

Logs Page Logs Page

Development

To develop the R2R dashboard:

  1. Start the development server:
pnpm dev
  1. Run pre-commit checks (optional but recommended):
pnpm format
pnpm lint