diff --git a/Dockerfile.langflow b/Dockerfile.langflow
index 6d868f14..2acb4877 100644
--- a/Dockerfile.langflow
+++ b/Dockerfile.langflow
@@ -33,8 +33,8 @@ RUN uv sync --frozen --no-install-project --no-editable --extra postgresql
# Build frontend
WORKDIR /app/src/frontend
-RUN npm ci && \
- npm run build && \
+RUN NODE_OPTIONS=--max_old_space_size=4096 npm ci && \
+ NODE_OPTIONS=--max_old_space_size=4096 npm run build && \
mkdir -p /app/src/backend/base/langflow/frontend && \
cp -r build/* /app/src/backend/base/langflow/frontend/
diff --git a/docs/docs/_partial-modify-flows.mdx b/docs/docs/_partial-modify-flows.mdx
index 852777e5..02ec1502 100644
--- a/docs/docs/_partial-modify-flows.mdx
+++ b/docs/docs/_partial-modify-flows.mdx
@@ -2,4 +2,4 @@ import Icon from "@site/src/components/icon/icon";
All flows included with OpenRAG are designed to be modular, performant, and provider-agnostic.
To modify a flow, click **Settings**, and click **Edit in Langflow**.
-Flows are edited in the same way as in the [Langflow visual editor](https://docs.langflow.org/concepts-overview).
\ No newline at end of file
+OpenRAG's visual editor is based on the [Langflow visual editor](https://docs.langflow.org/concepts-overview), so you can edit your flows to match your specific use case.
\ No newline at end of file
diff --git a/docs/docs/_partial-onboarding.mdx b/docs/docs/_partial-onboarding.mdx
index aaead4ad..5efbf2eb 100644
--- a/docs/docs/_partial-onboarding.mdx
+++ b/docs/docs/_partial-onboarding.mdx
@@ -1,51 +1,49 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
-### Application onboarding
+## Application onboarding
-The first time you start OpenRAG, whether using the TUI or a `.env` file, a `config.yaml` file is generated if OpenRAG detects one doesn't exist.
-The `config.yaml` file controls application configuration, including language model and embedding model provider, Docling ingestion settings, and API keys.
+The first time you start OpenRAG, whether using the TUI or a `.env` file, you must complete application onboarding.
-Values input during onboarding can be changed later in the OpenRAG **Settings** page, except for the language model and embedding model _provider_. The provider can only be selected during onboarding, and you must use the same provider for your language model and embedding model.
+Values input during onboarding can be changed later in the OpenRAG **Settings** page, except for the language model and embedding model _provider_.
+**Your provider can only be selected once, and you must use the same provider for your language model and embedding model.**
+The language model can be changed, but the embeddings model cannot be changed.
+To change your provider selection, you must completely reinstall OpenRAG.
-1. Select your language model and embedding model provider, and complete the required fields.
- **Your provider can only be selected once, and you must use the same provider for your language model and embedding model.**
- The language model can be changed, but the embeddings model cannot be changed.
- To change your provider selection, you must restart OpenRAG and delete the `config.yml` file.
+
+
+ 1. Enable **Get API key from environment variable** to automatically enter your key from the TUI-generated `.env` file.
+ 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.
+ 4. Click **Complete**.
+ 5. Continue with the [Quickstart](/quickstart).
-
-
- 2. If you already entered a value for `OPENAI_API_KEY` in the TUI in Step 5, enable **Get API key from environment variable**.
- 3. Under **Advanced settings**, select your **Embedding Model** and **Language Model**.
- 4. To load 2 sample PDFs, enable **Sample dataset**.
- This is recommended, but not required.
- 5. Click **Complete**.
-
-
-
- 2. Complete the fields for **watsonx.ai API Endpoint**, **IBM API key**, and **IBM Project ID**.
- These values are found in your IBM watsonx deployment.
- 3. Under **Advanced settings**, select your **Embedding Model** and **Language Model**.
- 4. To load 2 sample PDFs, enable **Sample dataset**.
- This is recommended, but not required.
- 5. Click **Complete**.
-
-
-
- :::tip
- Ollama is not included with OpenRAG. To install Ollama, see the [Ollama documentation](https://docs.ollama.com/).
- :::
- 2. Enter your Ollama server's base URL address.
- The default Ollama server address is `http://localhost:11434`.
- Since OpenRAG is running in a container, you may need to change `localhost` to access services outside of the container. For example, change `http://localhost:11434` to `http://host.docker.internal:11434` to connect to Ollama.
- OpenRAG automatically sends a test connection to your Ollama server to confirm connectivity.
- 3. Select the **Embedding Model** and **Language Model** your Ollama server is running.
- OpenRAG automatically lists the available models from your Ollama server.
- 4. To load 2 sample PDFs, enable **Sample dataset**.
- This is recommended, but not required.
- 5. Click **Complete**.
+
+
+ 1. Complete the fields for **watsonx.ai API Endpoint**, **IBM API key**, and **IBM Project ID**.
+ These values are found in your IBM watsonx deployment.
+ 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.
+ 4. Click **Complete**.
+ 5. Continue with the [Quickstart](/quickstart).
-
-
+
+
+ :::tip
+ Ollama is not included with OpenRAG. To install Ollama, see the [Ollama documentation](https://docs.ollama.com/).
+ :::
+ 1. Enter your Ollama server's base URL address.
+ The default Ollama server address is `http://localhost:11434`.
+ Since OpenRAG is running in a container, you may need to change `localhost` to access services outside of the container. For example, change `http://localhost:11434` to `http://host.docker.internal:11434` to connect to Ollama.
+ OpenRAG automatically sends a test connection to your Ollama server to confirm connectivity.
+ 2. Select the **Embedding Model** and **Language Model** your Ollama server is running.
+ OpenRAG automatically lists the available models from your Ollama server.
+ 3. To load 2 sample PDFs, enable **Sample dataset**.
+ This is recommended, but not required.
+ 4. Click **Complete**.
+ 5. Continue with the [Quickstart](/quickstart).
+
+
-6. Continue with the [Quickstart](/quickstart).
\ No newline at end of file
diff --git a/docs/docs/core-components/agents.mdx b/docs/docs/core-components/agents.mdx
index abfedc8a..9b4adb4b 100644
--- a/docs/docs/core-components/agents.mdx
+++ b/docs/docs/core-components/agents.mdx
@@ -1,5 +1,5 @@
---
-title: Agents powered by Langflow
+title: Langflow Agents
slug: /agents
---
@@ -13,9 +13,13 @@ import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx';
OpenRAG leverages Langflow's Agent component to power the OpenRAG OpenSearch Agent flow.
-This flow intelligently chats with your knowledge by embedding your query, comparing it the vector database embeddings, and generating a response with the LLM.
+[Flows](https://docs.langflow.org/concepts-overview) in Langflow are functional representations of application workflows, with multiple [component](https://docs.langflow.org/concepts-components) nodes connected as single steps in a workflow.
-The Agent component shines here in its ability to make decisions on not only what query should be sent, but when a query is necessary to solve the problem at hand.
+In the OpenRAG OpenSearch Agent flow, components like the Langflow [**Agent** component](https://docs.langflow.org/agents) and [**OpenSearch** component](https://docs.langflow.org/bundles-elastic#opensearch) are connected to intelligently chat with your knowledge by embedding your query, comparing it the vector database embeddings, and generating a response with the LLM.
+
+
+
+The Agent component shines here in its ability to make decisions on not only what query should be sent, but when a query is necessary to solve the problem at hand.
How do agents work?
@@ -33,22 +37,32 @@ In an agentic context, tools are functions that the agent can run to perform tas
## Use the OpenRAG OpenSearch Agent flow
If you've chatted with your knowledge in OpenRAG, you've already experienced the OpenRAG OpenSearch Agent chat flow.
-To view the flow, click **Settings**, and then click **Edit in Langflow**.
-This flow contains seven components:
+To switch OpenRAG over to the [Langflow visual editor](https://docs.langflow.org/concepts-overview) and view the OpenRAG OpenSearch Agentflow, click **Settings**, and then click **Edit in Langflow**.
+This flow contains seven components connected together to chat with your data:
-* The Agent component orchestrates the entire flow by deciding when to search the knowledge base, how to formulate search queries, and how to combine retrieved information with the user's question to generate a comprehensive response.
-The Agent behaves according to the prompt in the **Agent Instructions** field.
-* The Chat Input component is connected to the Agent component's Input port. This allows to flow to be triggered by an incoming prompt from a user or application.
-* The OpenSearch component is connected to the Agent component's Tools port. The agent may not use this database for every request; the agent only uses this connection if it decides the knowledge can help respond to the prompt.
-* The Language Model component is connected to the Agent component's Language Model port. The agent uses the connected LLM to reason through the request sent through Chat Input.
-* The Embedding Model component is connected to the OpenSearch component's Embedding port. This component converts text queries into vector representations that are compared with document embeddings stored in OpenSearch for semantic similarity matching. This gives your Agent's queries context.
-* The Text Input component is populated with the global variable `OPENRAG-QUERY-FILTER`.
-This filter is the Knowledge filter, and filters which knowledge sources to search through.
-* The Agent component's Output port is connected to the Chat Output component, which returns the final response to the user or application.
+* The [**Agent** component](https://docs.langflow.org/agents) orchestrates the entire flow by deciding when to search the knowledge base, how to formulate search queries, and how to combine retrieved information with the user's question to generate a comprehensive response.
+The **Agent** behaves according to the prompt in the **Agent Instructions** field.
+* The [**Chat Input** component](https://docs.langflow.org/components-io) is connected to the Agent component's Input port. This allows to flow to be triggered by an incoming prompt from a user or application.
+* The [**OpenSearch** component](https://docs.langflow.org/bundles-elastic#opensearch) is connected to the Agent component's Tools port. The agent may not use this database for every request; the agent only uses this connection if it decides the knowledge can help respond to the prompt.
+* The [**Language Model** component](https://docs.langflow.org/components-models) is connected to the Agent component's Language Model port. The agent uses the connected LLM to reason through the request sent through Chat Input.
+* The [**Embedding Model** component](https://docs.langflow.org/components-embedding-models) is connected to the OpenSearch component's Embedding port. This component converts text queries into vector representations that are compared with document embeddings stored in OpenSearch for semantic similarity matching. This gives your Agent's queries context.
+* The [**Text Input** component](https://docs.langflow.org/components-io) is populated with the global variable `OPENRAG-QUERY-FILTER`.
+This filter is the [Knowledge filter](/knowledge#create-knowledge-filters), and filters which knowledge sources to search through.
+* The **Agent** component's Output port is connected to the [**Chat Output** component](https://docs.langflow.org/components-io), which returns the final response to the user or application.
For an example of changing out the agent's LLM in OpenRAG, see the [Quickstart](/quickstart#change-components).
To restore the flow to its initial state, in OpenRAG, click **Settings**, and then click **Restore Flow**.
-OpenRAG warns you that this discards all custom settings. Click **Restore** to restore the flow.
\ No newline at end of file
+OpenRAG warns you that this discards all custom settings. Click **Restore** to restore the flow.
+
+## Additional Langflow functionality
+
+Langflow includes features beyond Agents to help you integrate OpenRAG into your application, and all Langflow features are included in OpenRAG.
+
+* Langflow can serve your flows as an [MCP server](https://docs.langflow.org/mcp-server), or consume other MCP servers as an [MCP client](https://docs.langflow.org/mcp-client). Get started with the [MCP tutorial](https://docs.langflow.org/mcp-tutorial).
+
+* If you don't see the component you need, extend Langflow's functionality by creating [custom Python components](https://docs.langflow.org/components-custom-components).
+
+* Langflow offers component [bundles](https://docs.langflow.org/components-bundle-components) to integrate with many popular vector stores, AI/ML providers, and search APIs.
\ No newline at end of file
diff --git a/docs/docs/core-components/knowledge.mdx b/docs/docs/core-components/knowledge.mdx
index 6933b02f..d2a74ca4 100644
--- a/docs/docs/core-components/knowledge.mdx
+++ b/docs/docs/core-components/knowledge.mdx
@@ -12,19 +12,9 @@ import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx';
OpenRAG uses [OpenSearch](https://docs.opensearch.org/latest/) for its vector-backed knowledge store.
+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.
-## Explore knowledge
-
-The Knowledge page lists the documents OpenRAG has ingested into the OpenSearch vector database's `documents` index.
-
-To explore your current knowledge, click **Knowledge**.
-Click on a document to display the chunks derived from splitting the default documents into the vector database.
-
-Documents are processed with the default **Knowledge Ingest** flow, so if you want to split your documents differently, edit the **Knowledge Ingest** flow.
-
-
-
## Ingest knowledge
OpenRAG supports knowledge ingestion through direct file uploads and OAuth connectors.
@@ -33,7 +23,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 **Add Knowledge**, and then click **Add File**.
The file is loaded into your OpenSearch database, and appears in the Knowledge page.
@@ -57,7 +47,7 @@ If you wish to use another provider, add the secrets to another provider.
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**.
@@ -100,6 +90,17 @@ You can monitor the sync progress in the
Once processing is complete, the synced documents become available in your knowledge base and can be searched through the chat interface or Knowledge page.
+## Explore knowledge
+
+The **Knowledge** page lists the documents OpenRAG has ingested into the OpenSearch vector database's `documents` index.
+
+To explore your current knowledge, click **Knowledge**.
+Click on a document to display the chunks derived from splitting the default documents into the vector database.
+
+Documents are processed with the default **Knowledge Ingest** flow, so if you want to split your documents differently, edit the **Knowledge Ingest** flow.
+
+
+
### Knowledge ingestion settings
To configure the knowledge ingestion pipeline parameters, see [Docling Ingestion](/ingestion).
@@ -139,7 +140,7 @@ A new filter is created with default settings that match everything.
OpenRAG automatically detects and configures the correct vector dimensions for embedding models, ensuring optimal search performance and compatibility.
-The complete list of supported models is available at [/src/services/models_service.py](https://github.com/langflow-ai/openrag/blob/main/src/services/models_service.py).
+The complete list of supported models is available at [`models_service.py` in the OpenRAG repository](https://github.com/langflow-ai/openrag/blob/main/src/services/models_service.py).
You can use custom embedding models by specifying them in your configuration.
@@ -147,4 +148,4 @@ If you use an unknown embedding model, OpenRAG will automatically fall back to `
The default embedding dimension is `1536` and the default model is `text-embedding-3-small`.
-For models with known vector dimensions, see [/src/config/settings.py](https://github.com/langflow-ai/openrag/blob/main/src/config/settings.py).
\ No newline at end of file
+For models with known vector dimensions, see [`settings.py` in the OpenRAG repository](https://github.com/langflow-ai/openrag/blob/main/src/config/settings.py).
\ No newline at end of file
diff --git a/docs/docs/get-started/docker.mdx b/docs/docs/get-started/docker.mdx
index ec16da70..01ef1042 100644
--- a/docs/docs/get-started/docker.mdx
+++ b/docs/docs/get-started/docker.mdx
@@ -1,9 +1,9 @@
---
-title: Docker deployment
+title: Deploy with Docker
slug: /get-started/docker
---
-import PartialOnboarding from '@site/docs/_partial-onboarding.mdx';
+import PartialOnboarding from '@site/docs/_partial-onboarding.mdx';
import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx';
@@ -15,7 +15,18 @@ They deploy the same applications and containers, but to different environments.
- [`docker-compose-cpu.yml`](https://github.com/langflow-ai/openrag/blob/main/docker-compose-cpu.yml) is a CPU-only version of OpenRAG for systems without GPU support. Use this Docker compose file for environments where GPU drivers aren't available.
-To install OpenRAG with Docker Compose:
+## Prerequisites
+
+- [Python Version 3.10 to 3.13](https://www.python.org/downloads/release/python-3100/)
+- [uv](https://docs.astral.sh/uv/getting-started/installation/)
+- [Podman](https://podman.io/docs/installation) (recommended) or [Docker](https://docs.docker.com/get-docker/) installed
+- [Docker Compose](https://docs.docker.com/compose/install/) installed. If you're using Podman, use [podman-compose](https://docs.podman.io/en/latest/markdown/podman-compose.1.html) or alias Docker compose commands to Podman commands.
+- 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: GPU support requires an NVIDIA GPU with CUDA support and compatible NVIDIA drivers installed on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment.
+
+## Deploy OpenRAG with Docker Compose
+
+To install OpenRAG with Docker Compose, do the following:
1. Clone the OpenRAG repository.
```bash
@@ -23,7 +34,7 @@ To install OpenRAG with Docker Compose:
cd openrag
```
-2. Copy the example `.env` file that is included in the repository root.
+2. Copy the example `.env` file included in the repository root.
The example file includes all environment variables with comments to guide you in finding and setting their values.
```bash
cp .env.example .env
@@ -34,7 +45,8 @@ To install OpenRAG with Docker Compose:
touch .env
```
-3. Set environment variables. The Docker Compose files are populated with values from your `.env`, so the following values are **required** to be set:
+3. Set environment variables. The Docker Compose files will be populated with values from your `.env`.
+The following values are **required** to be set:
```bash
OPENSEARCH_PASSWORD=your_secure_password
@@ -43,8 +55,8 @@ To install OpenRAG with Docker Compose:
LANGFLOW_SUPERUSER_PASSWORD=your_langflow_password
LANGFLOW_SECRET_KEY=your_secret_key
```
+
For more information on configuring OpenRAG with environment variables, see [Environment variables](/reference/configuration).
- For additional configuration values, including `config.yaml`, see [Configuration](/reference/configuration).
4. Deploy OpenRAG with Docker Compose based on your deployment type.
@@ -79,7 +91,7 @@ To install OpenRAG with Docker Compose:
- **Backend API**: http://localhost:8000
- **Langflow**: http://localhost:7860
-6. To use the OpenRAG application and continue with application onboarding, access the frontend at `http://localhost:3000`.
+6. Continue with [Application Onboarding](#application-onboarding).
diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx
index 2a19da73..2fe09d1f 100644
--- a/docs/docs/get-started/install.mdx
+++ b/docs/docs/get-started/install.mdx
@@ -10,37 +10,47 @@ import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx';
-OpenRAG can be installed in multiple ways:
+[Install the OpenRAG Python wheel](#install-python-wheel) and then use the [OpenRAG Terminal User Interface(TUI)](#setup) to run and configure your OpenRAG deployment with a guided setup process.
-* [**Python wheel**](#install-python-wheel): 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.
-
-* [**Docker Compose**](get-started/docker): Clone the OpenRAG repository and deploy OpenRAG with Docker Compose, including all services and dependencies.
+If you prefer running Docker commands and manually editing `.env` files, see [Deploy with Docker](/get-started/docker).
## Prerequisites
- [Python Version 3.10 to 3.13](https://www.python.org/downloads/release/python-3100/)
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
-- [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/docs/installation) installed
+- [Podman](https://podman.io/docs/installation) (recommended) or [Docker](https://docs.docker.com/get-docker/) installed
- [Docker Compose](https://docs.docker.com/compose/install/) installed. If using Podman, use [podman-compose](https://docs.podman.io/en/latest/markdown/podman-compose.1.html) or alias Docker compose commands to Podman commands.
-- For GPU support: (TBD)
+- 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: GPU support requires an NVIDIA GPU with [CUDA](https://docs.nvidia.com/cuda/) support and compatible NVIDIA drivers installed on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment.
## Install the OpenRAG Python wheel {#install-python-wheel}
-The Python wheel is currently available internally, but will be available on PyPI at launch.
-The wheel installs the OpenRAG wheel, which includes the TUI for installing, running, and managing OpenRAG.
-For more information on virtual environments, see [uv](https://docs.astral.sh/uv/pip/environments).
+:::important
+The `.whl` file is currently available as an internal download during public preview, and will be published to PyPI in a future release.
+:::
-1. Create a new project with a virtual environment using [uv](https://docs.astral.sh/uv/pip/environments).
+The OpenRAG wheel installs the Terminal User Interface (TUI) for running and managing OpenRAG.
+
+1. Create a new project with a virtual environment using `uv`.
+ This creates and activates a virtual environment for your project.
```bash
uv init YOUR_PROJECT_NAME
cd YOUR_PROJECT_NAME
```
-2. Add the OpenRAG wheel to your project and install it in the virtual environment.
- Replace `PATH/TO/` and `VERSION` with your OpenRAG wheel location and version.
+
+ The terminal prompt won't change like it would when using `venv`, but the `uv` commands will use the project's virtual environment.
+ For more information on virtual environments, see the [uv documentation](https://docs.astral.sh/uv/pip/environments).
+
+2. Add the local OpenRAG wheel to your project's virtual environment.
+
```bash
uv add PATH/TO/openrag-VERSION-py3-none-any.whl
```
+ Replace `PATH/TO/` and `VERSION` with the path and version of your downloaded OpenRAG `.whl` file.
+
+ For example, if your `.whl` file is in the `~/Downloads` directory, the command is `uv add ~/Downloads/openrag-0.1.8-py3-none-any.whl`.
+
3. Ensure all dependencies are installed and updated in your virtual environment.
```bash
uv sync
@@ -51,59 +61,64 @@ For more information on virtual environments, see [uv](https://docs.astral.sh/uv
uv run openrag
```
- The OpenRAG TUI opens.
+5. Continue with [Setup OpenRAG with the TUI](#setup).
-5. To install OpenRAG with Basic Setup, click **Basic Setup** or press 1. Basic Setup does not set up OAuth connections for ingestion from Google Drive, OneDrive, or AWS. For OAuth setup, see [Advanced Setup](#advanced-setup).
- The TUI prompts you for the required startup values.
- Click **Generate Passwords** to autocomplete fields that contain **Auto-generated Secure Password**, or bring your own passwords.
-
- Where do I find the required startup values?
-
- | Variable | Where to Find | Description |
- |----------|---------------|-------------|
- | `OPENSEARCH_PASSWORD` | Auto-generated secure password | The password for OpenSearch database access. Must be at least 8 characters and must contain at least one uppercase letter, one lowercase letter, one digit, and one special character. |
- | `OPENAI_API_KEY` | [OpenAI Platform](https://platform.openai.com/api-keys) | API key from your OpenAI account. |
- | `LANGFLOW_SUPERUSER` | User generated | Username for Langflow admin access. For more, see [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-superuser). |
- | `LANGFLOW_SUPERUSER_PASSWORD` | Auto-generated secure password | Password for Langflow admin access. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-superuser). |
- | `LANGFLOW_SECRET_KEY` | Auto-generated secure key | Secret key for Langflow security. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-secret-key). |
- | `LANGFLOW_AUTO_LOGIN` | Auto-generated or manual | Auto-login configuration. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login). |
- | `LANGFLOW_NEW_USER_IS_ACTIVE` | Langflow | New user activation setting. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-new-user-is-active). |
- | `LANGFLOW_ENABLE_SUPERUSER_CLI` | Langflow server | Superuser CLI access setting. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-enable-superuser-cli). |
- | `DOCUMENTS_PATH` | Set your local path | Path to your document storage directory. |
-
-
-
- To complete credentials, click **Save Configuration**.
+## Set up OpenRAG with the TUI {#setup}
-6. To start OpenRAG with your credentials, click **Start Container Services**.
- Startup pulls container images and starts them, so it can take some time.
- The operation has completed when the **Close** button is available and the terminal displays:
- ```bash
- Services started successfully
- Command completed successfully
- ```
+**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.
+For OAuth setup, use **Advanced Setup**.
-7. To open the OpenRAG application and continue with application onboarding, click **Open App**, press 6, or navigate to `http://localhost:3000`.
- The application opens.
+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.
+
+
+
+ 1. To install OpenRAG with **Basic Setup**, click **Basic Setup** or press 1.
+ 2. Click **Generate Passwords** to generate passwords for OpenSearch and Langflow.
+ 3. Paste your OpenAI API key in the OpenAI API key field.
+ 4. Click **Save Configuration**.
+ 5. To start OpenRAG, click **Start Container Services**.
+ Startup pulls container images and runs them, so it can take some time.
+ When startup is complete, the TUI displays the following:
+ ```bash
+ Services started successfully
+ Command completed successfully
+ ```
+ 6. To open the OpenRAG application, click **Open App**.
+ 7. Continue with [Application Onboarding](#application-onboarding).
+
+
+ 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.
+ 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.
+ 6. Click **Save Configuration**.
+ 7. To start OpenRAG, click **Start Container Services**.
+ Startup pulls container images and runs them, so it can take some time.
+ When startup is complete, the TUI displays the following:
+ ```bash
+ Services started successfully
+ 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.
+
+ Two additional variables are available for Advanced Setup:
+
+ The `LANGFLOW_PUBLIC_URL` controls where the Langflow web interface can be accessed. This is where users interact with their flows in a browser.
+
+ 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`.
+
+ 9. Continue with [Application Onboarding](#application-onboarding).
+
+
-
-### Advanced Setup {#advanced-setup}
-
-**Advanced Setup** includes the required values from **Basic Setup**, with additional settings for OAuth credentials.
-If the OpenRAG TUI detects OAuth credentials, it enforces the Advanced Setup path.
-1. Add your client and secret values for Google, Azure, or AWS OAuth.
-These values can be found in your OAuth provider.
-2. 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.
-3. To open the OpenRAG application, click **Open App** or press 6.
-You will be presented with your provider's OAuth sign-in screen, and be redirected to the redirect URI after sign-in.
-
-Two additional variables are available for Advanced Setup:
-
-The `LANGFLOW_PUBLIC_URL` controls where the Langflow web interface can be accessed. This is where users interact with their flows in a browser.
-
-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`.
\ No newline at end of file
diff --git a/docs/docs/get-started/quickstart.mdx b/docs/docs/get-started/quickstart.mdx
index 5d09f67d..838ad006 100644
--- a/docs/docs/get-started/quickstart.mdx
+++ b/docs/docs/get-started/quickstart.mdx
@@ -15,40 +15,6 @@ Get started with OpenRAG by loading your knowledge, swapping out your language m
## Prerequisites
- [Install and start OpenRAG](/install)
-- Create a [Langflow API key](https://docs.langflow.org/api-keys-and-authentication)
-
- Create a Langflow API key
-
- A Langflow API key is a user-specific token you can use with Langflow.
- It is **only** used for sending requests to the Langflow server.
- It does **not** access to OpenRAG.
-
- To create a Langflow API key, do the following:
-
- 1. In Langflow, click your user icon, and then select **Settings**.
- 2. Click **Langflow API Keys**, and then click **Add New**.
- 3. Name your key, and then click **Create API Key**.
- 4. Copy the API key and store it securely.
- 5. To use your Langflow API key in a request, set a `LANGFLOW_API_KEY` environment variable in your terminal, and then include an `x-api-key` header or query parameter with your request.
- For example:
-
- ```bash
- # Set variable
- export LANGFLOW_API_KEY="sk..."
-
- # Send request
- curl --request POST \
- --url "http://LANGFLOW_SERVER_ADDRESS/api/v1/run/FLOW_ID" \
- --header "Content-Type: application/json" \
- --header "x-api-key: $LANGFLOW_API_KEY" \
- --data '{
- "output_type": "chat",
- "input_type": "chat",
- "input_value": "Hello"
- }'
- ```
-
-
## Find your way around
@@ -99,12 +65,44 @@ You can more quickly access the **Language Model** and **Agent Instructions** fi
## Integrate OpenRAG into your application
To integrate OpenRAG into your application, use the [Langflow API](https://docs.langflow.org/api-reference-api-examples).
-Make requests with Python, TypeScript, or any HTTP client to run one of OpenRAG's default flows and get a response, and then modify the flow further to improve results.
+Make requests with Python, TypeScript, or any HTTP client to run one of OpenRAG's default flows and get a response, and then modify the flow further to improve results. Langflow provides code snippets to help you get started.
-Langflow provides code snippets to help you get started with the Langflow API.
-
-1. To navigate to the OpenRAG OpenSearch Agent flow, click **Settings**, and then click **Edit in Langflow** in the OpenRAG OpenSearch Agent flow.
-2. Click **Share**, and then click **API access**.
+1. Create a [Langflow API key](https://docs.langflow.org/api-keys-and-authentication).
+
+ Create a Langflow API key
+
+ A Langflow API key is a user-specific token you can use with Langflow.
+ It is **only** used for sending requests to the Langflow server.
+ It does **not** access to OpenRAG.
+
+ To create a Langflow API key, do the following:
+
+ 1. In Langflow, click your user icon, and then select **Settings**.
+ 2. Click **Langflow API Keys**, and then click **Add New**.
+ 3. Name your key, and then click **Create API Key**.
+ 4. Copy the API key and store it securely.
+ 5. To use your Langflow API key in a request, set a `LANGFLOW_API_KEY` environment variable in your terminal, and then include an `x-api-key` header or query parameter with your request.
+ For example:
+
+ ```bash
+ # Set variable
+ export LANGFLOW_API_KEY="sk..."
+
+ # Send request
+ curl --request POST \
+ --url "http://LANGFLOW_SERVER_ADDRESS/api/v1/run/FLOW_ID" \
+ --header "Content-Type: application/json" \
+ --header "x-api-key: $LANGFLOW_API_KEY" \
+ --data '{
+ "output_type": "chat",
+ "input_type": "chat",
+ "input_value": "Hello"
+ }'
+ ```
+
+
+2. To navigate to the OpenRAG OpenSearch Agent flow, click **Settings**, and then click **Edit in Langflow** in the OpenRAG OpenSearch Agent flow.
+3. Click **Share**, and then click **API access**.
The default code in the API access pane constructs a request with the Langflow server `url`, `headers`, and a `payload` of request data. The code snippets automatically include the `LANGFLOW_SERVER_ADDRESS` and `FLOW_ID` values for the flow. Replace these values if you're using the code for a different server or flow. The default Langflow server address is http://localhost:7860.
@@ -189,7 +187,7 @@ Langflow provides code snippets to help you get started with the Langflow API.
-3. Copy the snippet, paste it in a script file, and then run the script to send the request. If you are using the curl snippet, you can run the command directly in your terminal.
+4. Copy the snippet, paste it in a script file, and then run the script to send the request. If you are using the curl snippet, you can run the command directly in your terminal.
If the request is successful, the response includes many details about the flow run, including the session ID, inputs, outputs, components, durations, and more.
The following is an example of a response from running the **Simple Agent** template flow:
diff --git a/docs/docs/get-started/tui.mdx b/docs/docs/get-started/tui.mdx
index 49c676f7..f3cfe51e 100644
--- a/docs/docs/get-started/tui.mdx
+++ b/docs/docs/get-started/tui.mdx
@@ -7,11 +7,10 @@ import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx';
-The OpenRAG Terminal User Interface (TUI) provides a streamlined way to set up, configure, and monitor your OpenRAG deployment directly from the terminal, on any operating system.
+The OpenRAG Terminal User Interface (TUI) allows you to set up, configure, and monitor your OpenRAG deployment directly from the terminal, on any operating system.
-The TUI offers an easier way to use OpenRAG without sacrificing control.
Instead of starting OpenRAG using Docker commands and manually editing values in the `.env` file, the TUI walks you through the setup. It prompts for variables where required, creates a `.env` file for you, and then starts OpenRAG.
Once OpenRAG is running, use the TUI to monitor your application, control your containers, and retrieve logs.
@@ -19,7 +18,6 @@ Once OpenRAG is running, use the TUI to monitor your application, control your c
## Start the TUI
To start the TUI, run the following commands from the directory where you installed OpenRAG.
-For more information, see [Install OpenRAG](/install).
```bash
uv sync
diff --git a/docs/docs/get-started/what-is-openrag.mdx b/docs/docs/get-started/what-is-openrag.mdx
index 5540d92d..18c01482 100644
--- a/docs/docs/get-started/what-is-openrag.mdx
+++ b/docs/docs/get-started/what-is-openrag.mdx
@@ -18,6 +18,8 @@ OpenRAG connects and amplifies three popular, proven open-source projects into o
* [Docling](https://docling-project.github.io/docling/) - Docling simplifies document processing, parsing diverse formats — including advanced PDF understanding — and providing seamless integrations with the gen AI ecosystem.
-OpenRAG builds on Langflow's familiar interface while adding OpenSearch for vector storage and Docling for simplified document parsing, with opinionated flows that serve as ready-to-use recipes for ingestion, retrieval, and generation from popular sources like OneDrive, Google Drive, and AWS. And don't fear: every part of the stack is swappable. Write your own custom components in Python, try different language models, and customize your flows to build an agentic RAG system that solves problems.
+OpenRAG builds on Langflow's familiar interface while adding OpenSearch for vector storage and Docling for simplified document parsing, with opinionated flows that serve as ready-to-use recipes for ingestion, retrieval, and generation from popular sources like OneDrive, Google Drive, and AWS.
-Ready to get started? Install OpenRAG and then run the Quickstart to create a powerful RAG pipeline.
\ No newline at end of file
+What's more, every part of the stack is swappable. Write your own custom components in Python, try different language models, and customize your flows to build an agentic RAG system.
+
+Ready to get started? [Install OpenRAG](/install) and then run the [Quickstart](/quickstart) to create a powerful RAG pipeline.
\ No newline at end of file
diff --git a/docs/docs/support/troubleshoot.mdx b/docs/docs/support/troubleshoot.mdx
index fca6935e..dc62cf43 100644
--- a/docs/docs/support/troubleshoot.mdx
+++ b/docs/docs/support/troubleshoot.mdx
@@ -13,12 +13,12 @@ This page provides troubleshooting advice for issues you might encounter when us
## OpenSearch fails to start
-Check that `OPENSEARCH_PASSWORD` is set and meets requirements.
+Check that `OPENSEARCH_PASSWORD` set in [Environment variables](/configure/configuration) meets requirements.
The password must contain at least 8 characters, and must contain at least one uppercase letter, one lowercase letter, one digit, and one special character that is strong.
## Langflow connection issues
-Verify the `LANGFLOW_SUPERUSER` credentials are correct.
+Verify the `LANGFLOW_SUPERUSER` credentials set in [Environment variables](/configure/configuration) are correct.
## Memory errors
@@ -51,57 +51,58 @@ To reset your local containers and pull new images, do the following:
1. Stop your containers and completely remove them.
-
-
-
- ```bash
- # Stop all running containers
- docker stop $(docker ps -q)
+
+
- # Remove all containers (including stopped ones)
- docker rm --force $(docker ps -aq)
+ ```bash
+ # Stop all running containers
+ podman stop --all
+
+ # Remove all containers (including stopped ones)
+ podman rm --all --force
+
+ # Remove all images
+ podman rmi --all --force
+
+ # Remove all volumes
+ podman volume prune --force
+
+ # Remove all networks (except default)
+ podman network prune --force
+
+ # Clean up any leftover data
+ podman system prune --all --force --volumes
+ ```
- # Remove all images
- docker rmi --force $(docker images -q)
+
+
- # Remove all volumes
- docker volume prune --force
+ ```bash
+ # Stop all running containers
+ docker stop $(docker ps -q)
+
+ # Remove all containers (including stopped ones)
+ docker rm --force $(docker ps -aq)
+
+ # Remove all images
+ docker rmi --force $(docker images -q)
+
+ # Remove all volumes
+ docker volume prune --force
+
+ # Remove all networks (except default)
+ docker network prune --force
+
+ # Clean up any leftover data
+ docker system prune --all --force --volumes
+ ```
- # Remove all networks (except default)
- docker network prune --force
-
- # Clean up any leftover data
- docker system prune --all --force --volumes
- ```
-
-
-
-
- ```bash
- # Stop all running containers
- podman stop --all
-
- # Remove all containers (including stopped ones)
- podman rm --all --force
-
- # Remove all images
- podman rmi --all --force
-
- # Remove all volumes
- podman volume prune --force
-
- # Remove all networks (except default)
- podman network prune --force
-
- # Clean up any leftover data
- podman system prune --all --force --volumes
- ```
-
-
-
+
+
2. Restart OpenRAG and upgrade to get the latest images for your containers.
```bash
+ uv sync
uv run openrag
```
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 7f038137..9d0c49c8 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -28,22 +28,22 @@ const sidebars = {
{
type: "doc",
id: "get-started/install",
- label: "Installation"
+ label: "Install OpenRAG"
+ },
+ {
+ type: "doc",
+ id: "get-started/docker",
+ label: "Deploy with Docker"
},
{
type: "doc",
id: "get-started/quickstart",
label: "Quickstart"
},
- {
- type: "doc",
- id: "get-started/docker",
- label: "Docker Deployment"
- },
{
type: "doc",
id: "get-started/tui",
- label: "Terminal Interface (TUI)"
+ label: "Terminal User Interface (TUI)"
},
],
},
diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css
index 0e56814d..b2b0ee5c 100644
--- a/docs/src/css/custom.css
+++ b/docs/src/css/custom.css
@@ -29,6 +29,34 @@
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}
+/* Tabs Styling */
+.tabs-container {
+ border: 1px solid var(--ifm-color-emphasis-300);
+ border-radius: var(--ifm-global-radius);
+ padding: 1rem;
+ margin-bottom: 1rem;
+}
+
+.tabs {
+ margin-bottom: 1rem;
+}
+
+.tabs__item {
+ border: none;
+ border-bottom: 1px solid var(--ifm-color-emphasis-200);
+ margin-right: 0rem;
+ padding-bottom: 0.5rem;
+ border-radius: 0;
+}
+
+.tabs__item:hover {
+ background-color: var(--ifm-hover-overlay);
+}
+
+.tabs__item--active {
+ border-bottom-color: var(--ifm-tabs-color-active);
+}
+
/* GitHub Icon Button */
.header-github-link:hover {
opacity: 0.6;
diff --git a/frontend/components/filter-icon-popover.tsx b/frontend/components/filter-icon-popover.tsx
index c0ce416b..72504759 100644
--- a/frontend/components/filter-icon-popover.tsx
+++ b/frontend/components/filter-icon-popover.tsx
@@ -133,7 +133,7 @@ export function FilterIconPopover({
type="button"
onClick={() => onColorChange(c)}
className={cn(
- "flex items-center justify-center h-6 w-6 rounded-sm transition-colors text-primary",
+ "flex items-center justify-center h-6 w-6 rounded-sm transition-colors text-white",
colorSwatchClasses[c]
)}
aria-label={c}
diff --git a/frontend/components/knowledge-filter-list.tsx b/frontend/components/knowledge-filter-list.tsx
index bac0e5ca..129e8204 100644
--- a/frontend/components/knowledge-filter-list.tsx
+++ b/frontend/components/knowledge-filter-list.tsx
@@ -66,7 +66,7 @@ export function KnowledgeFilterList({
return (
<>
-