Skip to content

OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.

Python

partial for auth modes

April M004900dcdd92
diff --git a/docs/docs/_partial-opensearch-auth-modes.mdx b/docs/docs/_partial-opensearch-auth-modes.mdx
new file mode 100644
index 000000000..a6ce8896b
--- /dev/null
+++ b/docs/docs/_partial-opensearch-auth-modes.mdx
@@ -0,0 +1,20 @@
+When you [install OpenRAG](/install-options), you provide the initial configuration values for your OpenRAG services, including authentication credentials for OpenSearch and optional OAuth connectors.
+
+:::warning
+Google is the only supported OAuth provider for OpenRAG.
+
+Other [OAuth credentials](/reference/configuration#oauth-and-cloud-storage-connector-settings) are used only to authorize [cloud storage connectors](/knowledge-connectors).
+:::
+
+The presence of Google OAuth credentials determines how OpenRAG authenticates with your deployment's OpenSearch knowledge base, and how it controls user access to documents in your knowledge base:
+
+* **No-auth mode**: If you don't provide Google OAuth credentials, then the OpenRAG OpenSearch knowledge base runs in no-auth mode. This mode uses one anonymous JWT token for OpenSearch authentication. There is no differentiation between users; all users that access your OpenRAG instance can access all documents uploaded to your knowledge base.
+
+* **OAuth mode**: If you provide Google OAuth credentials, then the OpenRAG OpenSearch knowledge base runs in OAuth mode. This mode uses a unique JWT token for each OpenRAG user, and each document is tagged with user ownership. Documents are filtered by user owner; users see only the documents that they uploaded or have access to through their cloud storage accounts.
+
+:::tip
+To enable OAuth mode, you must [configure the Google Drive cloud storage connector for document ingestion](/knowledge-connectors).
+This is because OpenRAG uses Google OAuth credentials for both OAuth mode _and_ the Google Drive cloud storage connector.
+
+You can enable OAuth mode after initial setup by configuring the Google Drive connector.
+:::
\ No newline at end of file
diff --git a/docs/docs/_partial-setup.mdx b/docs/docs/_partial-setup.mdx
index b698d848d..b15592bd2 100644
--- a/docs/docs/_partial-setup.mdx
+++ b/docs/docs/_partial-setup.mdx
@@ -5,11 +5,11 @@ import PartialOAuthCredentials from '@site/docs/_partial-oauth-credentials.mdx';
1. In the TUI, click either **Basic Setup** or **Advanced Setup**.
:::info
- You must use **Advanced Setup** if you want to enable either of the following during initial set up:
+ You must use **Advanced Setup** if you want to enable either [OAuth mode or cloud storage connectors](/knowledge-connectors) during initial set up:
- * [OAuth mode](/knowledge#auth): Controls document ownership and access in your OpenRAG OpenSearch knowledge base.
+ * **OAuth mode**: Controls document ownership and access in your OpenRAG [OpenSearch knowledge base](/knowledge).
Without OAuth mode, there is no differentiation between users; all users that access your OpenRAG instance can access and manage all uploaded documents.
- * [Cloud storage connectors](/ingestion#oauth-ingestion): Ingest documents from external storage services.
+ * **Cloud storage connectors**: Enables ingestion of documents from external storage services.
:::
If OpenRAG detects [OAuth or cloud storage connector credentials](/reference/configuration#oauth-and-cloud-storage-connector-settings) during setup, it recommends **Advanced Setup** in the TUI.
diff --git a/docs/docs/core-components/knowledge-connectors.mdx b/docs/docs/core-components/knowledge-connectors.mdx
index f9cda6afd..61c7d13f8 100644
--- a/docs/docs/core-components/knowledge-connectors.mdx
+++ b/docs/docs/core-components/knowledge-connectors.mdx
@@ -4,6 +4,7 @@ slug: /knowledge-connectors
---
import Icon from "@site/src/components/icon/icon";
+import PartialOpensearchAuthModes from '@site/docs/_partial-opensearch-auth-modes.mdx';
<!--
Proposed plan to reorganize the knowledge content again:
@@ -43,6 +44,10 @@ Related tasks: Check all links to the 3 existing pages, check all anchors and se
-->
+## OAuth credentials and OpenSearch authentication modes
+
+<PartialOpensearchAuthModes />
+
## See also
* [About knowledge](/knowledge)
diff --git a/docs/docs/core-components/knowledge.mdx b/docs/docs/core-components/knowledge.mdx
index 3c85f2504..8cee2ca2d 100644
--- a/docs/docs/core-components/knowledge.mdx
+++ b/docs/docs/core-components/knowledge.mdx
@@ -5,10 +5,8 @@ slug: /knowledge
import Icon from "@site/src/components/icon/icon";
import PartialAnonymousUserOwner from '@site/docs/_partial-anonymous-user-owner.mdx';
+import PartialOpensearchAuthModes from '@site/docs/_partial-opensearch-auth-modes.mdx';
-
-## What is knowledge
-## The role of OpenSearch
## The index (only 1, possibly soon easier to rename)
## Auth modes (maybe use a partial)
@@ -27,24 +25,7 @@ You can configure how documents are ingested and how the **Chat** interacts with
## OpenSearch authentication and document access {#auth}
-When you [install OpenRAG](/install-options), you provide the initial configuration values for your OpenRAG services, including authentication credentials for OpenSearch and OAuth connectors.
-
-:::warning
-Google is the only supported OAuth provider for OpenRAG.
-
-Other [OAuth credentials](/reference/configuration#oauth-and-cloud-storage-connector-settings) are used only to authorize cloud storage connectors.
-:::
-
-The presence of Google OAuth credentials determines how OpenRAG authenticates with your deployment's OpenSearch knowledge base, and how it controls user access to documents in your knowledge base:
-
-* **No-auth mode**: If you don't provide Google OAuth credentials, then the OpenRAG OpenSearch knowledge base runs in no-auth mode. This mode uses one anonymous JWT token for OpenSearch authentication. There is no differentiation between users; all users that access your OpenRAG instance can access all documents uploaded to your knowledge base.
-
-* **OAuth mode**: If you provide Google OAuth credentials, then the OpenRAG OpenSearch knowledge base runs in OAuth mode. This mode uses a unique JWT token for each OpenRAG user, and each document is tagged with user ownership. Documents are filtered by user owner; users see only the documents that they uploaded or have access to through their cloud storage accounts.
-
-:::tip
-To enable OAuth mode after initial setup, you must [configure the Google Drive cloud storage connector for document ingestion](/ingestion#oauth-ingestion).
-This is because OpenRAG uses Google OAuth credentials for both OAuth mode _and_ the Google Drive cloud storage connector.
-:::
+<PartialOpensearchAuthModes />
## OpenSearch index {#index}
@@ -52,6 +33,8 @@ An [OpenSearch index](https://docs.opensearch.org/latest/getting-started/intro/#
By default, all documents you upload to your OpenRAG knowledge base are stored in an index named `documents`.
+<!-- TBD - better way to rename -->
+
It is possible to change the index name by [editing the ingestion flow](/agents#inspect-and-modify-flows).
However, this can impact dependent processes, such as the [filters](/knowledge-filters) and [**Chat**](/chat), that reference the `documents` index by default.
Make sure you edit other flows as needed to ensure all processes use the same index name.
diff --git a/docs/docs/get-started/docker.mdx b/docs/docs/get-started/docker.mdx
index 44fe19cdd..d4b3f16ee 100644
--- a/docs/docs/get-started/docker.mdx
+++ b/docs/docs/get-started/docker.mdx
@@ -80,7 +80,7 @@ The following variables are required or recommended:
* `WATSONX_ENDPOINT`
* `WATSONX_PROJECT_ID`
-6. To enable [OAuth mode](/knowledge#auth) or [cloud storage connectors](/ingestion#oauth-ingestion), do the following:
+6. To enable [OAuth mode or cloud storage connectors](/knowledge-connectors), do the following:
1. Register OpenRAG as an OAuth application in your cloud provider, and then obtain the app's OAuth credentials, such as a client ID and secret key. To enable multiple connectors, you must register an app and generate credentials for each provider.
diff --git a/docs/docs/reference/configuration.mdx b/docs/docs/reference/configuration.mdx
index c22a231a1..561674cf8 100644
--- a/docs/docs/reference/configuration.mdx
+++ b/docs/docs/reference/configuration.mdx
@@ -122,7 +122,7 @@ Use these variables to enable OAuth mode and configure cloud storage connectors.
:::warning
Additional configuration is required for these features.
-For more information, see [OpenSearch authentication](/knowledge#auth) and [Ingest files with cloud storage connectors](/ingestion#oauth-ingestion).
+For more information, see [Configure connectors](/knowledge-connectors).
:::
| Variable | Default | Description |