From e9a295361da3097135afb1f459723901d5e09b3b Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Wed, 29 Oct 2025 11:58:27 -0400 Subject: [PATCH 1/5] windows-users-note --- docs/docs/get-started/install.mdx | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index d8fa252f..b50bbe45 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -28,6 +28,10 @@ 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. +:::note Windows users +The OpenRAG TUI has limited compatibility with PowerShell. To use the TUI, use [WSL (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install). Alternatively, skip the TUI and follow the [OpenRAG container installation](/get-started/docker) steps instead. +::: + ## Install the OpenRAG Python wheel {#install-python-wheel} The OpenRAG wheel installs the Terminal User Interface (TUI) for configuring and running OpenRAG. @@ -155,7 +159,15 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path. -## Manage OpenRAG containers with the TUI +## Close the OpenRAG TUI + +To close the OpenRAG TUI, press q. +The OpenRAG containers will continue to be served until the containers are stopped. +For more information, see [Manage OpenRAG containers with the TUI ](#tui-container-management). + +To start the TUI again, run `uvx openrag`. + +## Manage OpenRAG containers with the TUI {#tui-container-management} After installation, the TUI can deploy, manage, and upgrade your OpenRAG containers. From add8e57164b0cb33948a642ae63a1b2b791ee3fd Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Wed, 29 Oct 2025 13:10:28 -0400 Subject: [PATCH 2/5] clarify-langflow-auth --- docs/docs/get-started/docker.mdx | 19 ++++++++++++++++--- docs/docs/get-started/install.mdx | 8 ++++++++ 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/docs/docs/get-started/docker.mdx b/docs/docs/get-started/docker.mdx index a43825bd..72a56195 100644 --- a/docs/docs/get-started/docker.mdx +++ b/docs/docs/get-started/docker.mdx @@ -48,15 +48,28 @@ To install OpenRAG with Docker Compose, do the following: touch .env ``` -4. The Docker Compose files are populated with the values from your .env. The following values must be set: +4. The Docker Compose files are populated with the values from your `.env` file. The following values must be set: ```bash OPENSEARCH_PASSWORD=your_secure_password OPENAI_API_KEY=your_openai_api_key - LANGFLOW_SUPERUSER=admin - LANGFLOW_SUPERUSER_PASSWORD=your_langflow_password LANGFLOW_SECRET_KEY=your_secret_key ``` + + `OPENSEARCH_PASSWORD` is automatically generated when using the TUI, but for a Docker Compose installation, you must set it manually. To generate an OpenSearch admin password, see the [OpenSearch documentation](https://docs.opensearch.org/latest/security/configuration/demo-configuration/#setting-up-a-custom-admin-password). + + The `OPENAI_API_KEY` is found in your OpenAI account. + + `LANGFLOW_SECRET_KEY` is automatically generated when using the TUI, and Langflow will also auto-generate it if not set. For more information, see the [Langflow documentation](https://docs.langflow.org/api-keys-and-authentication#langflow-secret-key). + + Optional values: + + ```bash + LANGFLOW_SUPERUSER=admin + LANGFLOW_SUPERUSER_PASSWORD=your_langflow_password + ``` + + `LANGFLOW_SUPERUSER` defaults to `admin`. You can omit it or set it to a different username. `LANGFLOW_SUPERUSER_PASSWORD` is optional. If omitted, Langflow runs in [autologin mode](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login) with no password required. If set, Langflow requires password authentication. For more information on configuring OpenRAG with environment variables, see [Environment variables](/reference/configuration). diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index b50bbe45..316497e0 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -106,6 +106,10 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path. 1. To install OpenRAG with **Basic Setup**, click **Basic Setup** or press 1. 2. Click **Generate Passwords** to generate passwords for OpenSearch and Langflow. + + The OpenSearch password is required. The Langflow admin password is optional. + If no Langflow admin password is generated, Langflow runs in [autologin mode](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login) with no password required. + 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. @@ -123,6 +127,10 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path. 1. To install OpenRAG with **Advanced Setup**, click **Advanced Setup** or press 2. 2. Click **Generate Passwords** to generate passwords for OpenSearch and Langflow. + + The OpenSearch password is required. The Langflow admin password is optional. + If no Langflow admin password is generated, Langflow runs in [autologin mode](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login) with no password required. + 3. Paste your OpenAI API key in the OpenAI API key field. 4. Add your client and secret values for Google or Microsoft OAuth. These values can be found with your OAuth provider. From 854ede54191c18600f3a53306641caa7cb17957f Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Wed, 29 Oct 2025 13:13:13 -0400 Subject: [PATCH 3/5] change-sentence --- docs/docs/get-started/docker.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/get-started/docker.mdx b/docs/docs/get-started/docker.mdx index 72a56195..3d616af2 100644 --- a/docs/docs/get-started/docker.mdx +++ b/docs/docs/get-started/docker.mdx @@ -62,7 +62,7 @@ To install OpenRAG with Docker Compose, do the following: `LANGFLOW_SECRET_KEY` is automatically generated when using the TUI, and Langflow will also auto-generate it if not set. For more information, see the [Langflow documentation](https://docs.langflow.org/api-keys-and-authentication#langflow-secret-key). - Optional values: + The following Langflow configuration values are optional but important to consider: ```bash LANGFLOW_SUPERUSER=admin From 84e90339187778c0dbb72e855a3a10ac1287f4e4 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Wed, 29 Oct 2025 16:06:27 -0400 Subject: [PATCH 4/5] Apply suggestion from @mendonk --- 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 6d9b18b6..f770b073 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -173,7 +173,7 @@ To close the OpenRAG TUI, press q. The OpenRAG containers will continue to be served until the containers are stopped. For more information, see [Manage OpenRAG containers with the TUI ](#tui-container-management). -To start the TUI again, run `uvx openrag`. +To start the TUI again, run `uv run openrag`. ## Manage OpenRAG containers with the TUI {#tui-container-management} From 1f64e9017ba4e6dcab25cff618a513c44e331145 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Fri, 31 Oct 2025 10:36:29 -0400 Subject: [PATCH 5/5] code-review --- docs/docs/get-started/docker.mdx | 2 +- docs/docs/get-started/install.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/get-started/docker.mdx b/docs/docs/get-started/docker.mdx index 3d616af2..24658a0b 100644 --- a/docs/docs/get-started/docker.mdx +++ b/docs/docs/get-started/docker.mdx @@ -56,7 +56,7 @@ To install OpenRAG with Docker Compose, do the following: LANGFLOW_SECRET_KEY=your_secret_key ``` - `OPENSEARCH_PASSWORD` is automatically generated when using the TUI, but for a Docker Compose installation, you must set it manually. To generate an OpenSearch admin password, see the [OpenSearch documentation](https://docs.opensearch.org/latest/security/configuration/demo-configuration/#setting-up-a-custom-admin-password). + `OPENSEARCH_PASSWORD` can be automatically generated when using the TUI, but for a Docker Compose installation, you can set it manually instead. To generate an OpenSearch admin password, see the [OpenSearch documentation](https://docs.opensearch.org/latest/security/configuration/demo-configuration/#setting-up-a-custom-admin-password). The `OPENAI_API_KEY` is found in your OpenAI account. diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index f770b073..5d9ae686 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -29,7 +29,7 @@ If you prefer running Podman or Docker containers and manually editing `.env` fi - 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. :::note Windows users -The OpenRAG TUI has limited compatibility with PowerShell. To use the TUI, use [WSL (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install). Alternatively, skip the TUI and follow the [OpenRAG container installation](/get-started/docker) steps instead. +To use OpenRAG on Windows, use [WSL (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install). ::: ## Install the OpenRAG Python wheel {#install-python-wheel}