From f3be92726bd144bf2e477fe30526e2a50456fcf4 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Mon, 20 Oct 2025 09:41:05 -0400 Subject: [PATCH 1/9] link-out-to-oauth-docs --- docs/docs/get-started/install.mdx | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index ff9872aa..585bef91 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -93,8 +93,9 @@ For OAuth setup, use **Advanced Setup**. 1. To install OpenRAG with **Advanced Setup**, click **Advanced Setup** or press 2. 2. Click **Generate Passwords** to generate passwords for OpenSearch and Langflow. 3. Paste your OpenAI API key in the OpenAI API key field. - 4. Add your client and secret values for Google, Azure, or AWS OAuth. - These values can be found in your OAuth provider. + 4. Add your client and secret values for Google or Microsoft OAuth. + These values can be found with your OAuth provider. + For more information, see the [Google OAuth client](https://developers.google.com/identity/protocols/oauth2) or [Microsoft Graph OAuth client](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/graph-oauth) documentation. 5. The OpenRAG TUI presents redirect URIs for your OAuth app. These are the URLs your OAuth provider will redirect back to after user sign-in. Register these redirect values with your OAuth provider as they are presented in the TUI. @@ -107,8 +108,8 @@ For OAuth setup, use **Advanced Setup**. Command completed successfully ``` 8. To open the OpenRAG application, click **Open App**, press 6, or navigate to `http://localhost:3000`. - You will be presented with your provider's OAuth sign-in screen, and be redirected to the redirect URI after sign-in. - Continue with Application Onboarding. + You are presented with your provider's OAuth sign-in screen. + After sign-in, you are redirected to the redirect URI. Two additional variables are available for Advanced Setup: @@ -116,7 +117,10 @@ For OAuth setup, use **Advanced Setup**. The `WEBHOOK_BASE_URL` controls where the endpoint for `/connectors/CONNECTOR_TYPE/webhook` will be available. This connection enables real-time document synchronization with external services. - For example, for Google Drive file synchronization the webhook URL is `/connectors/google_drive/webhook`. + Supported webhook endpoints: + - Google Drive: `/connectors/google_drive/webhook` + - OneDrive: `/connectors/onedrive/webhook` + - SharePoint: `/connectors/sharepoint/webhook` 9. Continue with [Application Onboarding](#application-onboarding). From 4fac72c98b75de27f4b88485ee30cb75be575f1f Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Mon, 20 Oct 2025 09:41:15 -0400 Subject: [PATCH 2/9] remove-model-restrictions --- docs/docs/_partial-onboarding.mdx | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/docs/_partial-onboarding.mdx b/docs/docs/_partial-onboarding.mdx index 44222371..3c5c031d 100644 --- a/docs/docs/_partial-onboarding.mdx +++ b/docs/docs/_partial-onboarding.mdx @@ -5,16 +5,12 @@ import TabItem from '@theme/TabItem'; The first time you start OpenRAG, whether using the TUI or a `.env` file, you must complete application onboarding. -Most values from onboarding can be changed later in the OpenRAG **Settings** page, but there are important restrictions. - -The **language model provider** and **embeddings model provider** can only be selected at onboarding, and you must use the same provider for your language model and embedding model. -To change your provider selection later, you must completely reinstall OpenRAG. - -The **language model** can be changed later in **Settings**, but the **embeddings model** cannot be changed later. +Values from onboarding can be changed later in the OpenRAG **Settings** page. 1. Enable **Get API key from environment variable** to automatically enter your key from the TUI-generated `.env` file. + Alternatively, paste an OpenAI API key into the field. 2. Under **Advanced settings**, select your **Embedding Model** and **Language Model**. 3. To load 2 sample PDFs, enable **Sample dataset**. This is recommended, but not required. From 419543f378afd9a810e6d2440210732d5fcc6fae Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Mon, 20 Oct 2025 09:59:29 -0400 Subject: [PATCH 3/9] docs-docker-install-instead-of-deploy --- docs/docs/get-started/docker.mdx | 4 ++-- docs/docs/get-started/quickstart.mdx | 2 -- docs/sidebars.js | 2 +- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/docs/get-started/docker.mdx b/docs/docs/get-started/docker.mdx index 366d71de..ebf86554 100644 --- a/docs/docs/get-started/docker.mdx +++ b/docs/docs/get-started/docker.mdx @@ -1,12 +1,12 @@ --- -title: Deploy with Docker +title: Install with Docker slug: /get-started/docker --- import PartialOnboarding from '@site/docs/_partial-onboarding.mdx'; There are two different Docker Compose files. -They deploy the same applications and containers, but to different environments. +They deploy the same applications and containers locally, but to different environments. - [`docker-compose.yml`](https://github.com/langflow-ai/openrag/blob/main/docker-compose.yml) is an OpenRAG deployment with GPU support for accelerated AI processing. diff --git a/docs/docs/get-started/quickstart.mdx b/docs/docs/get-started/quickstart.mdx index c2f4b3a5..942433b5 100644 --- a/docs/docs/get-started/quickstart.mdx +++ b/docs/docs/get-started/quickstart.mdx @@ -44,8 +44,6 @@ If you aren't getting the results you need, you can further tune the knowledge i To modify the knowledge ingestion or Agent behavior, click