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

links

Browse source
This commit is contained in:
Mendon Kissling 2025-09-30 22:39:32 -04:00
parent 762ad224f0
commit 76c26b3eb0
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -30,7 +30,7 @@ OpenRAG supports knowledge ingestion through direct file uploads and OAuth conne
The **Knowledge Ingest** flow uses Langflow's [**File** component](https://docs.langflow.org/components-data#file) to split and embed files loaded from your local machine into the OpenSearch database.
The default path to your local folder is mounted from the `./documents` folder in your OpenRAG project directory to the `/app/documents/` directory inside the Docker container. Files added to the host or the container will be visible in both locations. To configure this location, modify the **Documents Paths** variable in either the TUI's [Advanced Setup](/install#advanced-setup) or in the `.env` used by Docker Compose.
The default path to your local folder is mounted from the `./documents` folder in your OpenRAG project directory to the `/app/documents/` directory inside the Docker container. Files added to the host or the container will be visible in both locations. To configure this location, modify the **Documents Paths** variable in either the TUI's [Advanced Setup](/install#setup) menu or in the `.env` used by Docker Compose.
To load and process a single file from the mapped location, click <Icon name="Plus" aria-hidden="true"/> **Add Knowledge**, and then click **Add File**.
The file is loaded into your OpenSearch database, and appears in the Knowledge page.
@ -54,7 +54,7 @@ If you wish to use another provider, add the secrets to another provider.
<TabItem value="TUI" label="TUI" default>
1. If OpenRAG is running, stop it with **Status** > **Stop Services**.
2. Click **Advanced Setup**.
3. Add the OAuth provider's client and secret key in the [Advanced Setup](/install#advanced-setup) menu.
3. Add the OAuth provider's client and secret key in the [Advanced Setup](/install#setup) menu.
4. Click **Save Configuration**.
The TUI generates a new `.env` file with your OAuth values.
5. Click **Start Container Services**.

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

@ -9,7 +9,7 @@ import PartialOnboarding from '@site/docs/_partial-onboarding.mdx';
Install the OpenRAG Python wheel and use the [OpenRAG Terminal User Interface (TUI)](/get-started/tui) to install, run, and configure your OpenRAG deployment without running Docker commands.
If you prefer running Docker commands and manually editing `.env` files, see [Deploy with Docker](/docker).
If you prefer running Docker commands and manually editing `.env` files, see [Deploy with Docker](/get-started/docker).
## Prerequisites
@ -45,7 +45,7 @@ The wheel includes the TUI for installing, running, and managing OpenRAG.
uv run openrag
```
## Setup OpenRAG with the TUI
## Setup OpenRAG with the TUI {#setup}
**Basic Setup** completes or auto-generates most of the required values to start OpenRAG.
**Basic Setup** does not set up OAuth connections for ingestion from Google Drive, OneDrive, or AWS.