Skip to main content

Select an installation method

The OpenRAG architecture is lightweight and container-based with a central OpenRAG backend that orchestrates the various services and external connectors. Depending on your use case, OpenRAG can assist with service management, or you can manage the services yourself.

Select the installation method that best fits your needs:

  • Use the Terminal User Interface (TUI) to manage services: For guided configuration and simplified service management, install OpenRAG with TUI-managed services. Use one of the following options:

    • Automatic installer script: Run one script to install the required dependencies and OpenRAG.
    • uv: Install OpenRAG as a dependency of a new or existing Python project.
    • uvx: Install OpenRAG without creating a project or modifying your project's dependencies.

  • Install OpenRAG on Microsoft Windows: On Windows machines, you must install OpenRAG within the Windows Subsystem for Linux (WSL).

    warning

    OpenRAG doesn't support nested virtualization; don't run OpenRAG on a WSL distribution that is inside a Windows VM.

  • Manage your own services: You can use Docker or Podman to deploy self-managed OpenRAG services.

The first time you start OpenRAG, you must complete the application onboarding process. This is required for all installation methods because it prepares the minimum required configuration for OpenRAG to run. For TUI-managed services, you must also complete initial setup before you start the OpenRAG services. For more information, see the instructions for your preferred installation method.

Your OpenRAG configuration is stored in a .env file. When using TUI-managed services, this file is created automatically at ~/.openrag/tui, or you can provide a pre-populated .env file in this directory before starting the TUI. The TUI prompts you for the required values during setup and onboarding, and any values detected in a preexisting .env file are populated automatically. When using self-managed services, you must provide a pre-populated .env file, as you would for any Docker or Podman deployment. For more information, see the instructions for your preferred installation method and the OpenRAG environment variables reference.