From 459032ad6779b3ceb638aa7f384e0833387ed432 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Thu, 23 Oct 2025 20:19:16 -0400 Subject: [PATCH] install-page --- docs/docs/get-started/install.mdx | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index 585bef91..a776cb98 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -9,16 +9,16 @@ import PartialOnboarding from '@site/docs/_partial-onboarding.mdx'; [Install the OpenRAG Python wheel](#install-python-wheel), and then run the [OpenRAG Terminal User Interface(TUI)](#setup) to start your OpenRAG deployment with a guided setup process. -If you prefer running Docker commands and manually editing `.env` files, see [Deploy with Docker](/get-started/docker). +If you prefer running Docker commands and manually editing `.env` files, see [Install with Docker](/get-started/docker). ## Prerequisites -- [Python Version 3.10 to 3.13](https://www.python.org/downloads/release/python-3100/) -- [uv](https://docs.astral.sh/uv/getting-started/installation/) -- [Podman](https://podman.io/docs/installation) (recommended) or [Docker](https://docs.docker.com/get-docker/) installed -- [Docker Compose](https://docs.docker.com/compose/install/) installed. If using Podman, use [podman-compose](https://docs.podman.io/en/latest/markdown/podman-compose.1.html) or alias Docker compose commands to Podman commands. +- Install [Python Version 3.10 to 3.13](https://www.python.org/downloads/release/python-3100/) +- Install [uv](https://docs.astral.sh/uv/getting-started/installation/) +- Install [Podman](https://podman.io/docs/installation) (recommended) or [Docker](https://docs.docker.com/get-docker/) +- Install [Docker Compose](https://docs.docker.com/compose/install/). If using Podman, use [podman-compose](https://docs.podman.io/en/latest/markdown/podman-compose.1.html) or alias Docker compose commands to Podman commands. - Create an [OpenAI API key](https://platform.openai.com/api-keys). This key is **required** to start OpenRAG, but you can choose a different model provider during [Application Onboarding](#application-onboarding). -- Optional: GPU support requires an NVIDIA GPU with [CUDA](https://docs.nvidia.com/cuda/) support and compatible NVIDIA drivers installed on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment. +- Optional: Install GPU support with an NVIDIA GPU, [CUDA](https://docs.nvidia.com/cuda/) support, and compatible NVIDIA drivers on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment. ## Install the OpenRAG Python wheel {#install-python-wheel} @@ -57,7 +57,7 @@ The OpenRAG wheel installs the Terminal User Interface (TUI) for configuring and uv run openrag ``` -5. Continue with [Setup OpenRAG with the TUI](#setup). +5. Continue with [Set up OpenRAG with the TUI](#setup). ## Set up OpenRAG with the TUI {#setup} @@ -65,19 +65,19 @@ The TUI creates a `.env` file in your OpenRAG directory root and starts OpenRAG. If the TUI detects a `.env` file in the OpenRAG root directory, it sources any variables from the `.env` file. If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path. -**Basic Setup** generates all of the required values for OpenRAG except the OpenAI API key. -**Basic Setup** does not set up OAuth connections for ingestion from cloud providers. -For OAuth setup, use **Advanced Setup**. - -**Basic Setup** and **Advanced Setup** enforce the same authentication settings for the Langflow server, but manage document access differently. For more information, see [Authentication and document access](/knowledge#auth). - + **Basic Setup** generates all of the required values for OpenRAG except the OpenAI API key. + **Basic Setup** does not set up OAuth connections for ingestion from cloud providers. + For OAuth setup, use **Advanced Setup**. + For information about the difference between basic (no auth) and OAuth in OpenRAG, see [Authentication and document access](/knowledge#auth). + 1. To install OpenRAG with **Basic Setup**, click **Basic Setup** or press 1. 2. Click **Generate Passwords** to generate passwords for OpenSearch and Langflow. 3. Paste your OpenAI API key in the OpenAI API key field. 4. Click **Save Configuration**. + Your passwords are saved in the `.env` file used to start OpenRAG. 5. To start OpenRAG, click **Start Container Services**. Startup pulls container images and runs them, so it can take some time. When startup is complete, the TUI displays the following: