gmakstutis/openrag
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #223 from langflow-ai/docs-opensearch-jwt-values

Browse source 
docs: jwt behavior in basic and advanced installations
This commit is contained in:
Nate McCall 2025-10-09 06:47:28 +13:00 • committed by GitHub
commit ab26b0b44a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 15 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/docs/core-components/knowledge.mdx
View file

@ -12,6 +12,14 @@ OpenRAG uses [OpenSearch](https://docs.opensearch.org/latest/) for its vector-ba
This is a specialized database for storing and retrieving embeddings, which helps your Agent efficiently find relevant information.
OpenSearch provides powerful hybrid search capabilities with enterprise-grade security and multi-tenancy support.
## Authentication and document access {#auth}
OpenRAG supports two authentication modes based on how you [install OpenRAG](/install), and which mode you choose affects document access.
**No-auth mode (Basic Setup)**: This mode uses a single anonymous JWT token for OpenSearch authentication, so documents uploaded to the `documents` index by one user are visible to all other users on the OpenRAG server.
**OAuth mode (Advanced Setup)**: Each OpenRAG user is granted a JWT token, and each document is tagged with user ownership. Documents are filtered by user ownership, ensuring users only see documents they uploaded or have access to.
## Ingest knowledge
OpenRAG supports knowledge ingestion through direct file uploads and OAuth connectors.

11
docs/docs/get-started/install.mdx
View file

@ -62,13 +62,15 @@ The OpenRAG wheel installs the Terminal User Interface (TUI) for configuring and
## Set up OpenRAG with the TUI {#setup}
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 except the OpenAI API key.
**Basic Setup** does not set up OAuth connections for ingestion from Google Drive, OneDrive, or AWS.
**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**.
If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path.
If the TUI detects a `.env` file in the OpenRAG root directory, it will source any variables from the `.env` file.
**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).
<Tabs groupId="Setup method">
<TabItem value="Basic setup" label="Basic setup" default>
@ -87,6 +89,7 @@ If the TUI detects a `.env` file in the OpenRAG root directory, it will source a
7. Continue with [Application Onboarding](#application-onboarding).
</TabItem>
<TabItem value="Advanced setup" label="Advanced setup">
1. To install OpenRAG with **Advanced Setup**, click **Advanced Setup** or press <kbd>2</kbd>.
2. Click **Generate Passwords** to generate passwords for OpenSearch and Langflow.
3. Paste your OpenAI API key in the OpenAI API key field.