gmakstutis/openrag
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openrag/README.md
Mendon Kissling 1b45813dfd restating-headline
2025-10-08 12:03:56 -04:00

3.8 KiB
Raw Blame History

OpenRAG

Langflow    OpenSearch    Starlette    Next.js    Ask DeepWiki

OpenRAG is a comprehensive Retrieval-Augmented Generation platform that enables intelligent document search and AI-powered conversations. Users can upload, process, and query documents through a chat interface backed by large language models and semantic search capabilities. The system utilizes Langflow for document ingestion, retrieval workflows, and intelligent nudges, providing a seamless RAG experience. Built with Starlette, Next.js, OpenSearch, and Langflow integration.

Quickstart   |   TUI Interface   |   Docker Deployment   |   Development   |   Troubleshooting

Quickstart

Use the OpenRAG Terminal User Interface (TUI) to manage your OpenRAG installation without complex command-line operations.

To launch OpenRAG with the TUI, do the following:

  1. Clone the OpenRAG repository.
git clone https://github.com/langflow-ai/openrag.git
cd openrag
  1. To start the TUI, from the repository root, run:
# Install dependencies first
uv sync

# Launch the TUI
uv run openrag

The TUI opens and guides you through OpenRAG setup.

For the full TUI guide, see TUI.

Docker Deployment

If you prefer to use Docker to run OpenRAG, the repository includes two Docker Compose .yml files. They deploy the same applications and containers, but to different environments.

  • docker-compose.yml is an OpenRAG deployment for environments with GPU support. GPU support requires an NVIDIA GPU with CUDA support and compatible NVIDIA drivers installed on the OpenRAG host machine.

  • docker-compose-cpu.yml is a CPU-only version of OpenRAG for systems without GPU support. Use this Docker compose file for environments where GPU drivers aren't available.

  1. Clone the OpenRAG repository.
git clone https://github.com/langflow-ai/openrag.git
cd openrag

  1. Build and start all services.

    For the GPU-accelerated deployment, run:

    docker compose build
docker compose up -d

    For environments without GPU support, run:

    docker compose -f docker-compose-cpu.yml up -d

For more information, see Deploy with Docker.

Troubleshooting

For common issues and fixes, see Troubleshoot.

Development

For developers wanting to contribute to OpenRAG or set up a development environment, see CONTRIBUTING.md.