From bac94fd7da3a51bb51e135b18baffd1f4d8f4b81 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Thu, 6 Nov 2025 17:21:18 -0500 Subject: [PATCH 1/8] anchor-name --- docs/docs/get-started/install.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index c52b6ec3..2fd59835 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -28,7 +28,7 @@ If you prefer running Podman or Docker containers and manually editing `.env` fi - 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: 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. -## Installation Methods {#install} +## Install OpenRAG {#install} :::note Windows users To use OpenRAG on Windows, use [WSL (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install). From 010415cece52733f7475dfca5c02c65f9b980dd4 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Thu, 6 Nov 2025 17:23:14 -0500 Subject: [PATCH 2/8] install-sentence-structure --- docs/docs/get-started/install.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index 2fd59835..03d64c75 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -36,7 +36,7 @@ To use OpenRAG on Windows, use [WSL (Windows Subsystem for Linux)](https://learn Choose an installation method based on your needs: -* The automatic installer script detects and installs prerequisites and then runs OpenRAG. Recommended for first-time users. +* For new users, the automatic installer script detects and installs prerequisites and then runs OpenRAG. * For a quick test, use `uvx` to run OpenRAG without creating a project or modifying files. * Use `uv add` to install OpenRAG as a managed dependency in a new or existing Python project. * Use `uv pip install` to install OpenRAG into an existing virtual environment. From fe57f09d48cee8442eb482d602b9dce35d5ae602 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Mon, 10 Nov 2025 11:24:36 -0500 Subject: [PATCH 3/8] quickstart-install- --- docs/docs/get-started/quickstart.mdx | 44 ++++++++++++++++++++++++++-- docs/sidebars.js | 10 +++---- 2 files changed, 47 insertions(+), 7 deletions(-) diff --git a/docs/docs/get-started/quickstart.mdx b/docs/docs/get-started/quickstart.mdx index 92ed71c8..6ab08639 100644 --- a/docs/docs/get-started/quickstart.mdx +++ b/docs/docs/get-started/quickstart.mdx @@ -11,7 +11,47 @@ Get started with OpenRAG by loading your knowledge, swapping out your language m ## Prerequisites -- Install and start OpenRAG with the [TUI](/install) or [Docker](/get-started/docker) +:::tip +This quickstart uses a minimal setup to demonstrate OpenRAG's core functionality. After you complete the quickstart, it is recommended that you reinstall OpenRAG with your preferred configuration because some settings are immutable after initial setup. For all installation options, see [Install OpenRAG with TUI](/install) and [Install OpenRAG with containers](/docker). +::: + +Install OpenRAG with the automatic installer. +The script detects and installs uv, Docker/Podman, and Docker Compose prerequisites, and then starts OpenRAG with `uvx`. + + 1. Create a directory to store the OpenRAG configuration files: + ```bash + mkdir openrag-workspace + cd openrag-workspace + ``` + + 2. Run the installer: + ```bash + curl -fsSL https://docs.openr.ag/files/run_openrag_with_prereqs.sh | bash + ``` + + The TUI creates a `.env` file and docker-compose files in the current working directory, and then starts OpenRAG. + + 3. Select **Basic Setup**. + 4. To generate a password for OpenSearch, click **Generate Passwords**. + The other fields aren't required. + 5. To start OpenRAG, click **Start All Services**. + Startup pulls container images and runs them, so it can take some time. + When startup is complete, the TUI displays the following: + ```bash + Services started successfully + Command completed successfully + ``` + 6. To open the OpenRAG application, navigate to the TUI main menu, and then click **Open App**. + Alternatively, in your browser, navigate to `localhost:3000`. + 7. For your model provider, select **OpenAI**. + 8. In the **OpenAI API key** field, paste your OpenAI API key. + The default model settings are fine for the quickstart. + 9. To confirm your provider settings, click **Complete**. + 10. To complete onboarding, click **What is OpenRAG**, and then click **Add a document**. + Alternatively, click