Merge branch 'main' into sdks
This commit is contained in:
Sebastián Estévez
GitHub
commit
0332538d86
22 changed files with 177 additions and 215 deletions
1
docs/docs/_partial-export-flows.mdx
Normal file
1
docs/docs/_partial-export-flows.mdx
Normal file
|
|
@ -0,0 +1 @@
|
|||
1. If you modified the built-in flows or created custom flows in your [OpenRAG Langflow instance](/agents), and you want to preserve those changes, then you must [export your flows](https://docs.langflow.org/concepts-flows-import) before starting this process. Afterwards, you can import your flows or reference the exported flow JSON as needed.
|
||||
|
|
@ -1,14 +1,11 @@
|
|||
:::warning
|
||||
This is a destructive action that does the following:
|
||||
This is a destructive operation that does the following:
|
||||
|
||||
* Destroys all OpenRAG containers, volumes, and local images with `docker compose down --volumes --remove-orphans --rmi local`.
|
||||
* Prunes any additional container objects with `docker system prune -f`.
|
||||
* Deletes the contents of OpenRAG's `config` and `./opensearch-data` directories.
|
||||
* Deletes the `conversations.json` file.
|
||||
* Destroys all OpenRAG containers, volumes, and local images.
|
||||
* Prunes any additional container objects.
|
||||
* Deletes the contents of the `~/.openrag` directory _except_ for OpenRAG's `.env` file and the `/documents` subdirectory.
|
||||
|
||||
<p/>Destroyed containers and deleted data are lost and cannot be recovered after running this operation.
|
||||
|
||||
This operation _doesn't_ remove the `.env` file or the contents of the `./openrag-documents` directory.
|
||||
:::
|
||||
|
||||
<!--
|
||||
|
|
|
|||
13
docs/docs/_partial-ollama-models.mdx
Normal file
13
docs/docs/_partial-ollama-models.mdx
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
OpenRAG isn't guaranteed to be compatible with all models that are available through Ollama.
|
||||
For example, some models might produce unexpected results, such as JSON-formatted output instead of natural language responses, and some models aren't appropriate for the types of tasks that OpenRAG performs, such as those that generate media.
|
||||
|
||||
The OpenRAG team recommends the following models when using Ollama as your model provider:
|
||||
|
||||
* **Language models**: `gpt-oss:20b` or `mistral-nemo:12b`.
|
||||
|
||||
If you choose `gpt-oss:20b`, consider using Ollama Cloud or running Ollama on a remote machine because this model requires at least 16GB of RAM.
|
||||
|
||||
* **Embedding models**: [`nomic-embed-text:latest`](https://ollama.com/library/nomic-embed-text), `mxbai-embed-large:latest`, or `embeddinggemma:latest`.
|
||||
|
||||
You can experiment with other models, but if you encounter issues that you are unable to resolve through other RAG best practices (like context filters and prompt engineering), try switching to one of the recommended models.
|
||||
You can submit an [OpenRAG GitHub issue](https://github.com/langflow-ai/openrag/issues) to request support for specific models.
|
||||
|
|
@ -1,6 +1,7 @@
|
|||
import Icon from "@site/src/components/icon/icon";
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import PartialOllamaModels from '@site/docs/_partial-ollama-models.mdx';
|
||||
|
||||
## Complete the application onboarding process {#application-onboarding}
|
||||
|
||||
|
|
@ -68,16 +69,14 @@ The overview demonstrates some basic functionality that is covered in the [quick
|
|||
</TabItem>
|
||||
<TabItem value="Ollama" label="Ollama">
|
||||
|
||||
Using Ollama as your language and embedding model provider offers greater flexibility and configuration options for hosting models.
|
||||
However, it requires additional setup because Ollama isn't included with OpenRAG.
|
||||
You must deploy Ollama separately if you want to use Ollama as a model provider.
|
||||
|
||||
:::info
|
||||
Ollama isn't installed with OpenRAG. You must install it separately if you want to use Ollama as a model provider.
|
||||
<PartialOllamaModels />
|
||||
:::
|
||||
|
||||
Using Ollama as your language and embedding model provider offers greater flexibility and configuration options for hosting models, but it can be advanced for new users.
|
||||
The recommendations given here are a reasonable starting point for users with at least one GPU and experience running LLMs locally.
|
||||
|
||||
The OpenRAG team recommends the OpenAI `gpt-oss:20b` lanuage model and the [`nomic-embed-text`](https://ollama.com/library/nomic-embed-text) embedding model.
|
||||
However, `gpt-oss:20b` uses 16GB of RAM, so consider using Ollama Cloud or running Ollama on a remote machine.
|
||||
|
||||
1. [Install Ollama locally or on a remote server](https://docs.ollama.com/), or [run models in Ollama Cloud](https://docs.ollama.com/cloud).
|
||||
|
||||
If you are running a remote server, it must be accessible from your OpenRAG deployment.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
import PartialOllamaModels from '@site/docs/_partial-ollama-models.mdx';
|
||||
|
||||
* Gather the credentials and connection details for your preferred model providers.
|
||||
You must have access to at least one language model and one embedding model.
|
||||
If a provider offers both types, you can use the same provider for both models.
|
||||
|
|
@ -7,6 +9,10 @@ If a provider offers only one type, you must select two providers.
|
|||
* **Anthropic**: Create an [Anthropic API key](https://www.anthropic.com/docs/api/reference).
|
||||
Anthropic provides language models only; you must select an additional provider for embeddings.
|
||||
* **IBM watsonx.ai**: Get your watsonx.ai API endpoint, IBM project ID, and IBM API key from your watsonx deployment.
|
||||
* **Ollama**: Deploy an [Ollama instance and models](https://docs.ollama.com/) locally, in the cloud, or on a remote server, and then get your Ollama server's base URL and the names of the models that you want to use.
|
||||
* **Ollama**: Deploy an [Ollama instance and models](https://docs.ollama.com/) locally, in the cloud, or on a remote server. Then, get your Ollama server's base URL and the names of the models that you want to use.
|
||||
|
||||
:::info
|
||||
<PartialOllamaModels />
|
||||
:::
|
||||
|
||||
* Optional: Install GPU support with an NVIDIA GPU, [CUDA](https://docs.nvidia.com/cuda/) support, and compatible NVIDIA drivers on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment.
|
||||
|
|
@ -37,7 +37,7 @@ If OpenRAG detects OAuth credentials during setup, it recommends **Advanced Setu
|
|||
|
||||
4. Click **Save Configuration**.
|
||||
|
||||
Your passwords and API key, if provided, are stored in the [OpenRAG `.env` file](/reference/configuration) in your OpenRAG installation directory.
|
||||
Your passwords and API key, if provided, are stored in the [OpenRAG `.env` file](/reference/configuration) at `~/.openrag/tui`.
|
||||
If you modified any credentials that were pulled from an existing `.env` file, those values are updated in the `.env` file.
|
||||
|
||||
5. Click **Start All Services** to start the OpenRAG services that run in containers.
|
||||
|
|
@ -81,7 +81,7 @@ If OpenRAG detects OAuth credentials during setup, it recommends **Advanced Setu
|
|||
If you aren't sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG's default model configuration.
|
||||
If you want to use a different model provider, you can leave this field empty.
|
||||
|
||||
4. To upload documents from external storage, such as Google Drive, add the required OAuth credentials for the connectors that you want to use. These settings can be populated automatically if OpenRAG detects these credentials in an [OpenRAG `.env` file](/reference/configuration) in the OpenRAG installation directory.
|
||||
4. To upload documents from external storage, such as Google Drive, add the required OAuth credentials for the connectors that you want to use. These settings can be populated automatically if OpenRAG detects these credentials in an [OpenRAG `.env` file](/reference/configuration) at `~/.openrag/tui`.
|
||||
|
||||
* **Amazon**: Provide your AWS Access Key ID and AWS Secret Access Key with access to your S3 instance. For more information, see the AWS documentation on [Configuring access to AWS applications](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-applications.html).
|
||||
* **Google**: Provide your Google OAuth Client ID and Google OAuth Client Secret. You can generate these in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials). For more information, see the [Google OAuth client documentation](https://developers.google.com/identity/protocols/oauth2).
|
||||
|
|
@ -95,7 +95,7 @@ Register these redirect values with your OAuth provider as they are presented in
|
|||
|
||||
6. Click **Save Configuration**.
|
||||
|
||||
Your passwords, API key, and OAuth credentials, if provided, are stored in the [OpenRAG `.env` file](/reference/configuration) in your OpenRAG installation directory.
|
||||
Your passwords, API key, and OAuth credentials, if provided, are stored in the [OpenRAG `.env` file](/reference/configuration) at `~/.openrag/tui`.
|
||||
If you modified any credentials that were pulled from an existing `.env` file, those values are updated in the `.env` file.
|
||||
|
||||
7. Click **Start All Services** to start the OpenRAG services that run in containers.
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ For example, to view and edit the built-in **Chat** flow (the **OpenRAG OpenSear
|
|||
|
||||
If prompted to acknowledge that you are entering Langflow, click **Proceed**.
|
||||
|
||||
If Langflow requests login information, enter the `LANGFLOW_SUPERUSER` and `LANGFLOW_SUPERUSER_PASSWORD` from your [OpenRAG `.env` file](/reference/configuration) in your OpenRAG installation directory.
|
||||
If Langflow requests login information, enter the `LANGFLOW_SUPERUSER` and `LANGFLOW_SUPERUSER_PASSWORD` from your [OpenRAG `.env` file](/reference/configuration).
|
||||
|
||||
|
||||
|
||||
|
|
@ -59,6 +59,12 @@ In addition to OpenRAG's built-in flows, all Langflow features are available thr
|
|||
|
||||
Explore the [Langflow documentation](https://docs.langflow.org/) to learn more about the Langflow platform, features, and visual editor.
|
||||
|
||||
## Modify a flow at runtime {#modify-a-flow-at-runtime}
|
||||
|
||||
You can use _tweaks_ to modify flow settings at runtime without permanently changing the flow's configuration.
|
||||
Tweaks are one-time parameter modifications that are passed to specific Langflow components during flow execution.
|
||||
For more information on tweaks, see the Langflow documentation on [Input schema (tweaks)](https://docs.langflow.org/concepts-publish#input-schema).
|
||||
|
||||
## Set the Langflow version
|
||||
|
||||
By default, OpenRAG is pinned to the latest Langflow Docker image for stability.
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ You can upload files and folders from your local machine to your knowledge base:
|
|||
|
||||
3. To upload one file, click <Icon name="File" aria-hidden="true"/> **File**. To upload all documents in a folder, click <Icon name="Folder" aria-hidden="true"/> **Folder**.
|
||||
|
||||
The default path is the `./documents` subdirectory in your OpenRAG installation directory.
|
||||
The default path is `~/.openrag/documents`.
|
||||
To change this path, see [Set the local documents path](/knowledge#set-the-local-documents-path).
|
||||
|
||||
The selected files are processed in the background through the **OpenSearch Ingestion** flow.
|
||||
|
|
|
|||
|
|
@ -137,14 +137,17 @@ The default value is 200 characters, which represents an overlap of 20 percent i
|
|||
|
||||
### Set the local documents path {#set-the-local-documents-path}
|
||||
|
||||
The default path for local uploads is the `./openrag-documents` subdirectory in your OpenRAG installation directory. This is mounted to the `/app/openrag-documents/` directory inside the OpenRAG container. Files added to the host or container directory are visible in both locations.
|
||||
The default path for local uploads is `~/.openrag/documents`. This is mounted to the `/app/openrag-documents/` directory inside the OpenRAG container. Files added to the host or container directory are visible in both locations.
|
||||
|
||||
To change this location, modify the **Documents Paths** variable in either the [**Advanced Setup** menu](/install#setup) or in your [OpenRAG `.env` file](/reference/configuration).
|
||||
|
||||
## Delete knowledge {#delete-knowledge}
|
||||
|
||||
To clear your entire knowledge base, delete the contents of the `./opensearch-data` folder in your OpenRAG installation directory.
|
||||
:::warning
|
||||
This is a destructive operation that cannot be undone.
|
||||
:::
|
||||
|
||||
To clear your entire knowledge base, [reset your OpenRAG containers](/manage-services#reset-containers) or [reinstall OpenRAG](/reinstall).
|
||||
|
||||
## See also
|
||||
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ import PartialPrereqNoScript from '@site/docs/_partial-prereq-no-script.mdx';
|
|||
import PartialPrereqWindows from '@site/docs/_partial-prereq-windows.mdx';
|
||||
import PartialPrereqPython from '@site/docs/_partial-prereq-python.mdx';
|
||||
import PartialInstallNextSteps from '@site/docs/_partial-install-next-steps.mdx';
|
||||
import PartialOllamaModels from '@site/docs/_partial-ollama-models.mdx';
|
||||
|
||||
To manage your own OpenRAG services, deploy OpenRAG with Docker or Podman.
|
||||
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ This is required for all installation methods because it prepares the minimum re
|
|||
For TUI-managed services, you must also complete initial setup before you start the OpenRAG services.
|
||||
For more information, see the instructions for your preferred installation method.
|
||||
|
||||
Your OpenRAG configuration is stored in a `.env` file in the OpenRAG installation directory.
|
||||
When using TUI-managed services, this file is created automatically, or you can provide a pre-populated `.env` file before starting the TUI.
|
||||
Your OpenRAG configuration is stored in a `.env` file.
|
||||
When using TUI-managed services, this file is created automatically at `~/.openrag/tui`, or you can provide a pre-populated `.env` file in this directory before starting the TUI.
|
||||
The TUI prompts you for the required values during setup and onboarding, and any values detected in a preexisting `.env` file are populated automatically.
|
||||
When using self-managed services, you must provide a pre-populated `.env` file, as you would for any Docker or Podman deployment.
|
||||
For more information, see the instructions for your preferred installation method and the [OpenRAG environment variables reference](/reference/configuration).
|
||||
|
|
@ -13,6 +13,7 @@ import PartialPrereqWindows from '@site/docs/_partial-prereq-windows.mdx';
|
|||
import PartialPrereqPython from '@site/docs/_partial-prereq-python.mdx';
|
||||
import PartialInstallNextSteps from '@site/docs/_partial-install-next-steps.mdx';
|
||||
import PartialOpenSearchAuthMode from '@site/docs/_partial-opensearch-auth-mode.mdx';
|
||||
import PartialOllamaModels from '@site/docs/_partial-ollama-models.mdx';
|
||||
|
||||
Use [`uv`](https://docs.astral.sh/uv/getting-started/installation/) to install OpenRAG as a managed or unmanaged dependency in a new or existing Python project.
|
||||
|
||||
|
|
@ -80,7 +81,7 @@ If you encounter errors during installation, see [Troubleshoot OpenRAG](/support
|
|||
|
||||
For more options, see [Managing dependencies with `uv`](https://docs.astral.sh/uv/concepts/projects/dependencies/).
|
||||
|
||||
4. Optional: If you want to use a pre-populated [OpenRAG `.env` file](/reference/configuration), copy it to this directory before starting OpenRAG.
|
||||
4. Optional: If you want to use a pre-populated [OpenRAG `.env` file](/reference/configuration), create one at `~/.openrag/tui` before starting OpenRAG.
|
||||
|
||||
5. Start the OpenRAG TUI:
|
||||
|
||||
|
|
@ -98,7 +99,7 @@ If you encounter errors during installation, see [Troubleshoot OpenRAG](/support
|
|||
uv pip install openrag
|
||||
```
|
||||
|
||||
3. Optional: If you want to use a pre-populated [OpenRAG `.env` file](/reference/configuration), copy it to this directory before starting OpenRAG.
|
||||
3. Optional: If you want to use a pre-populated [OpenRAG `.env` file](/reference/configuration), create one at `~/.openrag/tui` before starting OpenRAG.
|
||||
|
||||
4. Start the OpenRAG TUI:
|
||||
|
||||
|
|
@ -111,7 +112,7 @@ If you encounter errors during installation, see [Troubleshoot OpenRAG](/support
|
|||
When you install OpenRAG with `uv`, you manage the OpenRAG services with the TUI.
|
||||
The TUI guides you through the initial configuration process before you start the OpenRAG services.
|
||||
|
||||
Your configuration values are stored in an [OpenRAG `.env` file](/reference/configuration) that is created automatically in the Python project where you installed OpenRAG.
|
||||
Your configuration values are stored in an [OpenRAG `.env` file](/reference/configuration) that is created automatically at `~/.openrag/tui`.
|
||||
If OpenRAG detects an existing `.env` file in this directory, then the TUI can populate those values automatically during setup and onboarding.
|
||||
|
||||
Container definitions are stored in the `docker-compose` files in the same directory as the OpenRAG `.env` file.
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ import PartialPrereqWindows from '@site/docs/_partial-prereq-windows.mdx';
|
|||
import PartialPrereqPython from '@site/docs/_partial-prereq-python.mdx';
|
||||
import PartialInstallNextSteps from '@site/docs/_partial-install-next-steps.mdx';
|
||||
import PartialOpenSearchAuthMode from '@site/docs/_partial-opensearch-auth-mode.mdx';
|
||||
import PartialOllamaModels from '@site/docs/_partial-ollama-models.mdx';
|
||||
|
||||
Use [`uvx`](https://docs.astral.sh/uv/guides/tools/#running-tools) to invoke OpenRAG outside of a Python project or without modifying your project's dependencies.
|
||||
|
||||
|
|
@ -44,7 +45,7 @@ For other installation methods, see [Select an installation method](/install-opt
|
|||
cd openrag-workspace
|
||||
```
|
||||
|
||||
2. Optional: If you want to use a pre-populated [OpenRAG `.env` file](/reference/configuration), copy it to this directory before invoking OpenRAG.
|
||||
2. Optional: If you want to use a pre-populated [OpenRAG `.env` file](/reference/configuration), create one at `~/.openrag/tui` before invoking OpenRAG.
|
||||
|
||||
3. Invoke OpenRAG:
|
||||
|
||||
|
|
@ -70,7 +71,7 @@ If you encounter errors during installation, see [Troubleshoot OpenRAG](/support
|
|||
When you install OpenRAG with `uvx`, you manage the OpenRAG services with the TUI.
|
||||
The TUI guides you through the initial configuration process before you start the OpenRAG services.
|
||||
|
||||
Your configuration values are stored in an [OpenRAG `.env` file](/reference/configuration) that is created automatically in the OpenRAG installation directory, which is the directory where you invoked OpenRAG.
|
||||
Your configuration values are stored in an [OpenRAG `.env` file](/reference/configuration) that is created automatically at `~/.openrag/tui`.
|
||||
If OpenRAG detects an existing `.env` file in this directory, then the TUI can populate those values automatically during setup and onboarding.
|
||||
|
||||
Container definitions are stored in the `docker-compose` files in the same directory as the OpenRAG `.env` file.
|
||||
|
|
|
|||
|
|
@ -12,6 +12,7 @@ import PartialPrereqWindows from '@site/docs/_partial-prereq-windows.mdx';
|
|||
import PartialPrereqPython from '@site/docs/_partial-prereq-python.mdx';
|
||||
import PartialInstallNextSteps from '@site/docs/_partial-install-next-steps.mdx';
|
||||
import PartialOpenSearchAuthMode from '@site/docs/_partial-opensearch-auth-mode.mdx';
|
||||
import PartialOllamaModels from '@site/docs/_partial-ollama-models.mdx';
|
||||
|
||||
:::tip
|
||||
To quickly install and test OpenRAG's core features, try the [quickstart](/quickstart).
|
||||
|
|
@ -69,7 +70,7 @@ If you encounter errors during installation, see [Troubleshoot OpenRAG](/support
|
|||
When you install OpenRAG with the installer script, you manage the OpenRAG services with the TUI.
|
||||
The TUI guides you through the initial configuration process before you start the OpenRAG services.
|
||||
|
||||
Your configuration values are stored in an [OpenRAG `.env` file](/reference/configuration) that is created automatically in the OpenRAG installation directory, which is the directory where you ran the installer script.
|
||||
Your configuration values are stored in an [OpenRAG `.env` file](/reference/configuration) that is created automatically at `~/.openrag/tui`.
|
||||
If OpenRAG detects an existing `.env` file in this directory, then the TUI can populate those values automatically during setup and onboarding.
|
||||
|
||||
Container definitions are stored in the `docker-compose` files in the same directory as the OpenRAG `.env` file.
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ import TabItem from '@theme/TabItem';
|
|||
import PartialDockerComposeUp from '@site/docs/_partial-docker-compose-up.mdx';
|
||||
import PartialDockerComposeDownAndPrune from '@site/docs/_partial-docker-compose-down-and-prune.mdx';
|
||||
import PartialFactorResetWarning from '@site/docs/_partial-factory-reset-warning.mdx';
|
||||
import PartialExportFlows from '@site/docs/_partial-export-flows.mdx';
|
||||
|
||||
Service management is an essential part of maintaining your OpenRAG deployment.
|
||||
|
||||
|
|
@ -120,67 +121,45 @@ See [Upgrade OpenRAG](/upgrade).
|
|||
|
||||
## Reset containers (destructive) {#reset-containers}
|
||||
|
||||
Reset your OpenRAG deployment by recreating the containers and removing some related data.
|
||||
|
||||
To completely reset your OpenRAG deployment and delete all OpenRAG data, see [Reinstall OpenRAG](/reinstall).
|
||||
|
||||
### Export customized flows before resetting containers {#export-customized-flows-before-resetting-containers}
|
||||
|
||||
If you modified the built-in flows or created custom flows in your OpenRAG Langflow instance, and you want to preserve those changes, [export your flows](https://docs.langflow.org/concepts-flows-import) before resetting your OpenRAG containers.
|
||||
|
||||
### Factory Reset with the TUI
|
||||
|
||||
<PartialFactorResetWarning />
|
||||
|
||||
1. To destroy and recreate your OpenRAG containers, open the TUI's **Status** menu (<kbd>3</kbd>), and then click **Factory Reset**.
|
||||
Use these steps to reset your OpenRAG deployment by recreating the containers and deleting all data in the `~/.openrag` directory _except_ for the `.env` file and the `/documents` subdirectory.
|
||||
|
||||
2. Repeat the [setup process](/install#setup) to restart the services and launch the OpenRAG app. Your OpenRAG passwords, OAuth credentials (if previously set), and onboarding configuration are restored from the `.env` file.
|
||||
This restores your OpenRAG deployment to a near-initial state while preserving your configuration (in `.env`) and uploaded documents (in `/documents`).
|
||||
Your documents are reingested into a fresh OpenSearch index after the reset.
|
||||
|
||||
### Rebuild self-managed containers
|
||||
To reset your OpenRAG deployment _and_ delete all OpenRAG data, see [Reinstall OpenRAG](/reinstall).
|
||||
|
||||
This command destroys and recreates the containers. Data stored exclusively on the containers is lost, such as Langflow flows.
|
||||
<Tabs>
|
||||
<TabItem value="TUI" label="TUI-managed services" default>
|
||||
|
||||
If you want to preserve customized flows, see [Export customized flows before resetting containers](#export-customized-flows-before-resetting-containers).
|
||||
<PartialExportFlows />
|
||||
|
||||
The `.env` file, `config` directory, `./openrag-documents` directory, `./opensearch-data` directory, and the `conversations.json` file are preserved.
|
||||
2. To destroy and recreate your OpenRAG containers, open the TUI's **Status** menu (<kbd>3</kbd>), and then click **Factory Reset**.
|
||||
|
||||
```bash title="Docker"
|
||||
docker compose up --build --force-recreate --remove-orphans
|
||||
```
|
||||
3. Repeat the [setup process](/install#setup) to restart the services and launch the OpenRAG app. Your OpenRAG passwords, OAuth credentials (if previously set), and onboarding configuration are restored from the `.env` file.
|
||||
|
||||
```bash title="Podman"
|
||||
podman compose up --build --force-recreate --remove-orphans
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="env" label="Self-managed services">
|
||||
|
||||
### Destroy and recreate self-managed containers
|
||||
<PartialExportFlows />
|
||||
|
||||
Use separate commands to destroy and recreate the containers if you want to modify the configuration or delete other OpenRAG data before recreating the containers.
|
||||
2. Recreate the containers:
|
||||
|
||||
:::warning
|
||||
These are destructive operations that reset your OpenRAG deployment to an initial state.
|
||||
Destroyed containers and deleted data are lost and cannot be recovered after running this operation.
|
||||
:::
|
||||
```bash title="Docker"
|
||||
docker compose up --build --force-recreate --remove-orphans
|
||||
```
|
||||
|
||||
1. Destroy the containers, volumes, and local images, and then remove (prune) any additional container objects:
|
||||
```bash title="Podman"
|
||||
podman compose up --build --force-recreate --remove-orphans
|
||||
```
|
||||
|
||||
<PartialDockerComposeDownAndPrune />
|
||||
3. Launch the OpenRAG app, and then repeat the [application onboarding process](/docker#application-onboarding).
|
||||
|
||||
2. Optional: Remove data that wasn't deleted by the previous commands:
|
||||
4. If you exported customized flows, [import your flows](https://docs.langflow.org/concepts-flows-import) into Langflow after completing the onboarding process.
|
||||
|
||||
* OpenRAG's `.env` file
|
||||
* The contents of OpenRAG's `config` directory
|
||||
* The contents of the `./openrag-documents` directory
|
||||
* The contents of the `./opensearch-data` directory
|
||||
* The `conversations.json` file
|
||||
|
||||
3. If you deleted the `.env` file, prepare a new `.env` before redeploying the containers.
|
||||
For more information, see [Deploy OpenRAG with self-managed services](/docker).
|
||||
|
||||
4. Recreate the containers:
|
||||
|
||||
<PartialDockerComposeUp />
|
||||
|
||||
5. Launch the OpenRAG app, and then repeat the [application onboarding process](/docker#application-onboarding).
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## See also
|
||||
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ The script installs OpenRAG dependencies, including Docker or Podman, and then i
|
|||
Command completed successfully
|
||||
```
|
||||
|
||||
Your OpenRAG configuration and passwords are stored in an [OpenRAG `.env` file](/reference/configuration) file that is created automatically in your OpenRAG installation directory, which is the directory where you ran the installer script.
|
||||
Your OpenRAG configuration and passwords are stored in an [OpenRAG `.env` file](/reference/configuration) file that is created automatically at `~/.openrag/tui`.
|
||||
Container definitions are stored in the `docker-compose` files in the same directory.
|
||||
|
||||
7. Under [**Native Services**](/manage-services), click **Start** to start the Docling service.
|
||||
|
|
@ -96,7 +96,7 @@ You can click a document to view the chunks of the document as they are stored i
|
|||
|
||||
For this quickstart, use either the <Icon name="File" aria-hidden="true"/> **File** or <Icon name="Folder" aria-hidden="true"/> **Folder** upload options to load documents from your local machine.
|
||||
**Folder** uploads an entire directory.
|
||||
The default directory is the `/openrag-documents` subdirectory in your OpenRAG installation directory.
|
||||
The default directory is `~/.openrag/documents`.
|
||||
|
||||
For information about the cloud storage provider options, see [Ingest files with OAuth connectors](/ingestion#oauth-ingestion).
|
||||
|
||||
|
|
@ -121,7 +121,7 @@ You can click a document to view the chunks of the document as they are stored i
|
|||
|
||||
2. For greater insight into the underlying [Langflow flow](/agents) that drives the OpenRAG chat, click **Edit in Langflow** and then click **Proceed** to launch the Langflow visual editor in a new browser window.
|
||||
|
||||
If Langflow requests login information, enter the `LANGFLOW_SUPERUSER` and `LANGFLOW_SUPERUSER_PASSWORD` from the `.env` file in your OpenRAG installation directory.
|
||||
If Langflow requests login information, enter the `LANGFLOW_SUPERUSER` and `LANGFLOW_SUPERUSER_PASSWORD` from the `.env` file at `~/.openrag/tui`.
|
||||
|
||||
The **OpenRAG OpenSearch Agent** flow opens in a new browser window.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ import PartialDockerComposeDownAndPrune from '@site/docs/_partial-docker-compose
|
|||
import PartialDockerStopAll from '@site/docs/_partial-docker-stop-all.mdx';
|
||||
import PartialDockerRemoveAndCleanupSteps from '@site/docs/_partial-docker-remove-and-cleanup-steps.mdx';
|
||||
import PartialFactorResetWarning from '@site/docs/_partial-factory-reset-warning.mdx';
|
||||
import PartialExportFlows from '@site/docs/_partial-export-flows.mdx';
|
||||
|
||||
You can reset your OpenRAG deployment to its initial state by recreating the containers and deleting accessory data, such as the `.env` file and ingested documents.
|
||||
|
||||
|
|
@ -16,55 +17,50 @@ These are destructive operations that reset your OpenRAG deployment to an initia
|
|||
Destroyed containers and deleted data are lost and cannot be recovered after running these operations.
|
||||
:::
|
||||
|
||||
## Export customized flows before reinstalling
|
||||
|
||||
If you modified the built-in flows or created custom flows in your OpenRAG Langflow instance, and you want to preserve those changes, [export your flows](https://docs.langflow.org/concepts-flows-import) before reinstalling OpenRAG.
|
||||
|
||||
## Reinstall TUI-managed containers
|
||||
|
||||
1. In the TUI's **Status** menu (<kbd>3</kbd>), click **Factory Reset** to destroy your OpenRAG containers and some related data.
|
||||
<PartialExportFlows />
|
||||
|
||||
2. In the TUI's **Status** menu (<kbd>3</kbd>), click **Factory Reset** to [reset your OpenRAG containers](/manage-services#reset-containers).
|
||||
|
||||
<PartialFactorResetWarning />
|
||||
|
||||
2. Exit the TUI with <kbd>q</kbd>.
|
||||
|
||||
3. Optional: Remove data that wasn't deleted by the **Factory Reset** operation.
|
||||
For a completely fresh installation, delete all of this data.
|
||||
3. Optional: Delete or edit [OpenRAG's `.env` file](/reference/configuration), which is stored at `~/.openrag/tui`.
|
||||
|
||||
* **OpenRAG's `.env` file**: Contains your OpenRAG configuration, including OpenRAG passwords, API keys, OAuth settings, and other [environment variables](/reference/configuration). If you delete this file, OpenRAG automatically generates a new one after you repeat the setup and onboarding process. Alternatively, you can add a prepopulated `.env` file to your OpenRAG installation directory before restarting OpenRAG.
|
||||
* **The contents of the `./openrag-documents` directory**: Contains documents that you uploaded to OpenRAG. Delete these files to prevent documents from being reingested to your knowledge base after restarting OpenRAG. However, you might want to preserve OpenRAG's [default documents](https://github.com/langflow-ai/openrag/tree/main/openrag-documents).
|
||||
This file contains your OpenRAG configuration, including OpenRAG passwords, API keys, OAuth settings, and other environment variables. If you delete this file, the TUI automatically generates a new one after you repeat the setup and onboarding process. If you preserve this file, the TUI can read values from the existing `.env` file during setup and onboarding.
|
||||
|
||||
4. Restart the TUI with `uv run openrag` or `uvx openrag`.
|
||||
4. Optional: Remove any files from the `~/.openrag/documents` subdirectory that you don't want to reingest after redeploying the containers.
|
||||
It is recommended that you preserve OpenRAG's [default documents](https://github.com/langflow-ai/openrag/tree/main/openrag-documents).
|
||||
|
||||
5. Repeat the [setup process](/install#setup) to configure OpenRAG and restart all services.
|
||||
5. Restart the TUI with `uv run openrag` or `uvx openrag`.
|
||||
|
||||
6. Repeat the [setup process](/install#setup) to configure OpenRAG and restart all services.
|
||||
Then, launch the OpenRAG app and repeat the [application onboarding process](/install#application-onboarding).
|
||||
|
||||
If OpenRAG detects a `.env` file during setup and onboarding, it automatically populates any OpenRAG passwords, OAuth credentials, and onboarding configuration set in that file.
|
||||
|
||||
## Reinstall self-managed containers with `docker compose` or `podman compose`
|
||||
|
||||
Use these steps to reinstall OpenRAG containers with streamlined `docker compose` or `podman compose` commands:
|
||||
|
||||
1. Destroy the containers, volumes, and local images, and then remove (prune) any additional container objects:
|
||||
<PartialExportFlows />
|
||||
|
||||
2. Destroy the containers, volumes, and local images, and then remove (prune) any additional container objects.
|
||||
|
||||
<PartialFactorResetWarning />
|
||||
|
||||
<PartialDockerComposeDownAndPrune />
|
||||
|
||||
2. Optional: Remove data that wasn't deleted by the previous commands:
|
||||
3. Optional: Edit OpenRAG's `.env` file if needed.
|
||||
|
||||
* OpenRAG's `.env` file
|
||||
* The contents of OpenRAG's `config` directory
|
||||
* The contents of the `./openrag-documents` directory
|
||||
* The contents of the `./opensearch-data` directory
|
||||
* The `conversations.json` file
|
||||
4. Optional: Remove any files from the `~/.openrag/documents` subdirectory that you don't want to reingest after redeploying the containers.
|
||||
It is recommended that you preserve OpenRAG's [default documents](https://github.com/langflow-ai/openrag/tree/main/openrag-documents).
|
||||
|
||||
3. If you deleted the `.env` file, prepare a new `.env` before redeploying the containers.
|
||||
For more information, see [Deploy OpenRAG with self-managed services](/docker).
|
||||
|
||||
4. Redeploy OpenRAG:
|
||||
5. Redeploy OpenRAG:
|
||||
|
||||
<PartialDockerComposeUp />
|
||||
|
||||
5. Launch the OpenRAG app, and then repeat the [application onboarding process](/docker#application-onboarding).
|
||||
6. Launch the OpenRAG app, and then repeat the [application onboarding process](/docker#application-onboarding).
|
||||
|
||||
## Reinstall self-managed containers with discrete `docker` or `podman` commands
|
||||
|
||||
|
|
@ -72,19 +68,18 @@ Use these commands to remove and clean up OpenRAG containers with discrete `dock
|
|||
|
||||
If you want to reinstall one container, specify the container name in the commands instead of running the commands on all containers.
|
||||
|
||||
1. Stop all running containers:
|
||||
<PartialExportFlows />
|
||||
|
||||
2. Stop all running containers:
|
||||
|
||||
<PartialDockerStopAll />
|
||||
|
||||
<PartialDockerRemoveAndCleanupSteps />
|
||||
|
||||
7. Optional: Remove data that wasn't deleted by the previous commands:
|
||||
8. Optional: Edit OpenRAG's `.env` file if needed.
|
||||
|
||||
* OpenRAG's `.env` file
|
||||
* The contents of OpenRAG's `config` directory
|
||||
* The contents of the `./openrag-documents` directory
|
||||
* The contents of the `./opensearch-data` directory
|
||||
* The `conversations.json` file
|
||||
9. Optional: If you removed all containers or specifically the OpenSearch container, then you can remove any files from the `~/.openrag/documents` subdirectory that you don't want to reingest after redeploying the containers.
|
||||
It is recommended that you preserve OpenRAG's [default documents](https://github.com/langflow-ai/openrag/tree/main/openrag-documents).
|
||||
|
||||
8. If you removed all OpenRAG containers, [redeploy OpenRAG](/docker).
|
||||
10. If you removed all OpenRAG containers, [redeploy OpenRAG](/docker).
|
||||
If you removed only one container, redeploy that container with the appropriate `docker run` or `podman run` command.
|
||||
|
|
@ -10,7 +10,7 @@ The OpenRAG Terminal User Interface (TUI) provides a simplified and guided exper
|
|||
If you install OpenRAG with the [automatic installer script](/install), [`uv`](/install-uv), or [`uvx`](/install-uvx), you use the TUI to manage your OpenRAG deployment.
|
||||
The TUI guides you through the initial setup, automatically manages your OpenRAG `.env` and `docker-compose` files, and provides convenient access to [service management](/manage-services) controls.
|
||||
|
||||
In contrast, when you [deploy OpenRAG with self-managed services](/docker), you must manually configure OpenRAG by preparing a `.env` file and using Docker or Podman commands to deploy and manage your OpenRAG services.
|
||||
In contrast, when you [deploy OpenRAG with self-managed services](/docker), you must manually configure OpenRAG by preparing a `.env` file, and then use Docker or Podman commands to deploy and manage your OpenRAG services.
|
||||
|
||||
## Access the TUI {#access-the-tui}
|
||||
|
||||
|
|
|
|||
|
|
@ -29,13 +29,7 @@ Use these steps to uninstall a self-managed OpenRAG deployment with streamlined
|
|||
|
||||
<PartialDockerComposeDownAndPrune />
|
||||
|
||||
2. Remove data that wasn't deleted by the previous commands:
|
||||
|
||||
* OpenRAG's `.env` file
|
||||
* The contents of OpenRAG's `config` directory
|
||||
* The contents of the `./openrag-documents` directory
|
||||
* The contents of the `./opensearch-data` directory
|
||||
* The `conversations.json` file
|
||||
2. Remove OpenRAG's `.env` file and the `~/.openrag/documents` directory, which aren't deleted by the previous commands.
|
||||
|
||||
3. Stop `docling-serve`:
|
||||
|
||||
|
|
@ -53,13 +47,7 @@ Use these commands to uninstall a self-managed OpenRAG deployment with discrete
|
|||
|
||||
<PartialDockerRemoveAndCleanupSteps />
|
||||
|
||||
7. Remove data that wasn't deleted by the previous commands:
|
||||
|
||||
* OpenRAG's `.env` file
|
||||
* The contents of OpenRAG's `config` directory
|
||||
* The contents of the `./openrag-documents` directory
|
||||
* The contents of the `./opensearch-data` directory
|
||||
* The `conversations.json` file
|
||||
7. Remove OpenRAG's `.env` file and the `~/.openrag/documents` directory, which aren't deleted by the previous commands.
|
||||
|
||||
8. Stop `docling-serve`:
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@ slug: /upgrade
|
|||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import PartialExportFlows from '@site/docs/_partial-export-flows.mdx';
|
||||
|
||||
Use these steps to upgrade your OpenRAG deployment to the latest version or a specific version.
|
||||
|
||||
|
|
@ -21,12 +22,14 @@ Upgrading the Python package also upgrades Docling by bumping the dependency in
|
|||
|
||||
This is a two-part process because upgrading the OpenRAG Python package updates the Terminal User Interface (TUI) and Python code, but the container versions are controlled by environment variables in your [OpenRAG `.env` file](/reference/configuration).
|
||||
|
||||
1. To check for updates, open the TUI's **Status** menu (<kbd>3</kbd>), and then click **Upgrade**.
|
||||
<PartialExportFlows />
|
||||
|
||||
2. If there is an update, stop all OpenRAG services.
|
||||
2. To check for updates, open the TUI's **Status** menu (<kbd>3</kbd>), and then click **Upgrade**.
|
||||
|
||||
3. If there is an update, stop all OpenRAG services.
|
||||
In the **Status** menu, click **Stop Services**.
|
||||
|
||||
3. Upgrade the OpenRAG Python package to the latest version from [PyPI](https://pypi.org/project/openrag/).
|
||||
4. Upgrade the OpenRAG Python package to the latest version from [PyPI](https://pypi.org/project/openrag/).
|
||||
The commands to upgrade the package depend on how you installed OpenRAG.
|
||||
|
||||
<Tabs>
|
||||
|
|
@ -109,12 +112,12 @@ The commands to upgrade the package depend on how you installed OpenRAG.
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
4. In the OpenRAG TUI, click **Start All Services**, and then wait while the upgraded containers start.
|
||||
5. In the OpenRAG TUI, click **Start All Services**, and then wait while the upgraded containers start.
|
||||
|
||||
When you start services after upgrading the Python package, OpenRAG runs `docker compose pull` to get the appropriate container images matching the version specified in your OpenRAG `.env` file. Then, it recreates the containers with the new images using `docker compose up -d --force-recreate`.
|
||||
|
||||
:::tip Pin container versions
|
||||
In the `.env` file, the `OPENRAG_VERSION` [environment variable](/reference/configuration#system-settings) is set to `latest` by default, which pulls the `latest` available container images.
|
||||
In the OpenRAG `.env` file, the `OPENRAG_VERSION` [environment variable](/reference/configuration#system-settings) is set to `latest` by default, which pulls the `latest` available container images.
|
||||
To pin a specific container image version, you can set `OPENRAG_VERSION` to the desired container image version, such as `OPENRAG_VERSION=0.1.33`.
|
||||
|
||||
However, when you upgrade the Python package, OpenRAG automatically attempts to keep the `OPENRAG_VERSION` synchronized with the Python package version.
|
||||
|
|
@ -124,24 +127,27 @@ The commands to upgrade the package depend on how you installed OpenRAG.
|
|||
|
||||
If you get an error that `langflow container already exists` error during upgrade, see [Langflow container already exists during upgrade](/support/troubleshoot#langflow-container-already-exists-during-upgrade).
|
||||
|
||||
5. Under [**Native Services**](/manage-services), click **Start** to start the Docling service.
|
||||
6. Under [**Native Services**](/manage-services), click **Start** to start the Docling service.
|
||||
|
||||
6. When the upgrade process is complete, you can close the **Status** window and continue using OpenRAG.
|
||||
7. When the upgrade process is complete, you can close the **Status** window and continue using OpenRAG.
|
||||
|
||||
## Upgrade self-managed containers
|
||||
|
||||
To fetch and apply the latest container images while preserving your OpenRAG data, run the commands for your container management tool.
|
||||
By default, OpenRAG's `docker-compose` files pull the latest container images.
|
||||
<PartialExportFlows />
|
||||
|
||||
```bash title="Docker"
|
||||
docker compose pull
|
||||
docker compose up -d --force-recreate
|
||||
```
|
||||
2. Fetch and apply the latest container images while preserving your OpenRAG data:
|
||||
|
||||
```bash title="Podman"
|
||||
podman compose pull
|
||||
podman compose up -d --force-recreate
|
||||
```
|
||||
```bash title="Docker"
|
||||
docker compose pull
|
||||
docker compose up -d --force-recreate
|
||||
```
|
||||
|
||||
```bash title="Podman"
|
||||
podman compose pull
|
||||
podman compose up -d --force-recreate
|
||||
```
|
||||
|
||||
By default, OpenRAG's `docker-compose` files pull the latest container images.
|
||||
|
||||
## See also
|
||||
|
||||
|
|
|
|||
|
|
@ -5,62 +5,40 @@ slug: /reference/configuration
|
|||
|
||||
import PartialDockerComposeUp from '@site/docs/_partial-docker-compose-up.mdx';
|
||||
|
||||
OpenRAG recognizes environment variables from the following sources:
|
||||
OpenRAG's `.env` file is the primary configuration file for OpenRAG.
|
||||
Environment variables in `.env` always take precedence over other sources.
|
||||
|
||||
* [Environment variables](#configure-environment-variables): Values set in the `.env` file in the OpenRAG installation directory.
|
||||
* [Langflow runtime overrides](#langflow-runtime-overrides): Langflow components can set environment variables at runtime.
|
||||
* [Default or fallback values](#default-values-and-fallbacks): These values are default or fallback values if OpenRAG doesn't find a value.
|
||||
For deployments managed with the Terminal User Interface (TUI), this file is located at `~/.openrag/tui`, and it can be created automatically during [installation](/install-options).
|
||||
|
||||
## Configure environment variables
|
||||
For [self-managed deployments](/docker), this file can be located at the root of your OpenRAG project directory or referenced from another location.
|
||||
|
||||
Environment variables are set in a `.env` file in the root of your OpenRAG project directory.
|
||||
For an example, see [`.env.example` in the OpenRAG repository](https://github.com/langflow-ai/openrag/blob/main/.env.example).
|
||||
|
||||
For an example `.env` file, see [`.env.example` in the OpenRAG repository](https://github.com/langflow-ai/openrag/blob/main/.env.example).
|
||||
:::tip
|
||||
OpenRAG's Docker Compose files are populated automatically using values from the `.env` file, so you don't need to edit the Docker Compose files manually.
|
||||
:::
|
||||
|
||||
The Docker Compose files are populated with values from your `.env`, so you don't need to edit the Docker Compose files manually.
|
||||
If a variable isn't set, OpenRAG uses default or fallback values where available.
|
||||
Not all variables have default values, and errors can occur if required variables aren't set.
|
||||
Default values can be found in the reference tables on this page and in [`config_manager.py`](https://github.com/langflow-ai/openrag/blob/main/src/config/config_manager.py), [`settings.py`](https://github.com/langflow-ai/openrag/blob/main/src/config/settings.py), and [`logging_config.py`](https://github.com/langflow-ai/openrag/blob/main/src/utils/logging_config.py).
|
||||
|
||||
Environment variables always take precedence over other variables.
|
||||
You can [temporarily set Langflow variables at runtime](#modify-a-flow-at-runtime).
|
||||
However, these temporary overrides don't overlap with most OpenRAG environment variables.
|
||||
The only exceptions are flow-level Langflow settings, such as the language model used in a flow.
|
||||
|
||||
### Set environment variables {#set-environment-variables}
|
||||
## Edit the `.env` file {#set-environment-variables}
|
||||
|
||||
Environment variables are either mutable or immutable.
|
||||
During [installation](/install-options), an initial `.env` file is created automatically or manually.
|
||||
You can edit this file to change OpenRAG configuration settings after installation.
|
||||
|
||||
If you edit mutable environment variables, you can apply the changes by stopping and restarting the OpenRAG services after editing the `.env` file:
|
||||
Each OpenRAG environment variable is either mutable or immutable.
|
||||
This determines the actions you must take to apply changes after editing the `.env` file:
|
||||
|
||||
1. [Stop the OpenRAG services](/manage-services).
|
||||
* **Mutable environment variables**: You can apply changes to mutable environment variables by [stopping and restarting the OpenRAG services](/manage-services) after editing the `.env` file.
|
||||
|
||||
2. Edit your `.env` file.
|
||||
* **Immutable environment variables**: You must [redeploy OpenRAG](/reinstall) with your modified `.env` file if you change immutable environment variables.
|
||||
|
||||
3. [Restart the OpenRAG services](/manage-services).
|
||||
|
||||
If you edit immutable environment variables, you must [redeploy OpenRAG](/reinstall) with your modified `.env` file.
|
||||
For example, with self-managed services, do the following:
|
||||
|
||||
1. Stop the deployment:
|
||||
|
||||
```bash title="Docker"
|
||||
docker compose down
|
||||
```
|
||||
|
||||
```bash title="Podman"
|
||||
podman compose down
|
||||
```
|
||||
|
||||
2. Edit your `.env` file.
|
||||
|
||||
3. Redeploy OpenRAG:
|
||||
|
||||
<PartialDockerComposeUp />
|
||||
|
||||
4. Restart the Docling service.
|
||||
|
||||
5. Launch the OpenRAG app, and then repeat the [application onboarding process](/install#application-onboarding). The values in your `.env` file are automatically populated.
|
||||
|
||||
## Supported environment variables
|
||||
|
||||
All OpenRAG configuration can be controlled through environment variables.
|
||||
|
||||
### Model provider settings {#model-provider-settings}
|
||||
## Model provider settings {#model-provider-settings}
|
||||
|
||||
Configure which models and providers OpenRAG uses to generate text and embeddings.
|
||||
You only need to provide credentials for the providers you are using in OpenRAG.
|
||||
|
|
@ -80,7 +58,7 @@ Some of these variables are immutable and can only be changed by redeploying Ope
|
|||
| `WATSONX_ENDPOINT` | Not set | Custom provider endpoint for the IBM watsonx.ai model provider. |
|
||||
| `WATSONX_PROJECT_ID` | Not set | Project ID for the IBM watsonx.ai model provider. |
|
||||
|
||||
### Document processing settings {#document-processing-settings}
|
||||
## Document processing settings {#document-processing-settings}
|
||||
|
||||
Control how OpenRAG [processes and ingests documents](/ingestion) into your knowledge base.
|
||||
|
||||
|
|
@ -91,10 +69,10 @@ Control how OpenRAG [processes and ingests documents](/ingestion) into your know
|
|||
| `DISABLE_INGEST_WITH_LANGFLOW` | `false` | Disable Langflow ingestion pipeline. |
|
||||
| `DOCLING_OCR_ENGINE` | Set by OS | OCR engine for document processing. For macOS, `ocrmac`. For any other OS, `easyocr`. |
|
||||
| `OCR_ENABLED` | `false` | Enable OCR for image processing. |
|
||||
| `OPENRAG_DOCUMENTS_PATHS` | `./openrag-documents` | Document paths for ingestion. |
|
||||
| `OPENRAG_DOCUMENTS_PATHS` | `~/.openrag/documents` | Document paths for ingestion. |
|
||||
| `PICTURE_DESCRIPTIONS_ENABLED` | `false` | Enable picture descriptions. |
|
||||
|
||||
### Langflow settings {#langflow-settings}
|
||||
## Langflow settings {#langflow-settings}
|
||||
|
||||
Configure the OpenRAG Langflow server's authentication, contact point, and built-in flow definitions.
|
||||
|
||||
|
|
@ -120,7 +98,7 @@ For better security, it is recommended to set `LANGFLOW_SUPERUSER_PASSWORD` so t
|
|||
| `LANGFLOW_CHAT_FLOW_ID`, `LANGFLOW_INGEST_FLOW_ID`, `NUDGES_FLOW_ID` | Built-in flow IDs | These variables are set automatically to the IDs of the chat, ingestion, and nudges [flows](/agents). The default values are found in [`.env.example`](https://github.com/langflow-ai/openrag/blob/main/.env.example). Only change these values if you want to replace a built-in flow with your own custom flow. The flow JSON must be present in your version of the OpenRAG codebase. For example, if you [deploy self-managed services](/docker), you can add the flow JSON to your local clone of the OpenRAG repository before deploying OpenRAG. |
|
||||
| `SYSTEM_PROMPT` | `You are a helpful AI assistant with access to a knowledge base. Answer questions based on the provided context.` | System prompt instructions for the agent driving the **Chat** flow. |
|
||||
|
||||
### OAuth provider settings
|
||||
## OAuth provider settings
|
||||
|
||||
Configure [OAuth providers](/ingestion#oauth-ingestion) and external service integrations.
|
||||
|
||||
|
|
@ -131,7 +109,7 @@ Configure [OAuth providers](/ingestion#oauth-ingestion) and external service int
|
|||
| `MICROSOFT_GRAPH_OAUTH_CLIENT_ID`<br/>`MICROSOFT_GRAPH_OAUTH_CLIENT_SECRET` | Not set | Enable the [Microsoft Graph OAuth client](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/graph-oauth) integration by providing [Azure application registration credentials for SharePoint and OneDrive](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/app-registration?view=odsp-graph-online). |
|
||||
| `WEBHOOK_BASE_URL` | Not set | Base URL for OAuth connector webhook endpoints. If this variable isn't set, a default base URL is used. |
|
||||
|
||||
### OpenSearch settings
|
||||
## OpenSearch settings
|
||||
|
||||
Configure OpenSearch database authentication.
|
||||
|
||||
|
|
@ -142,7 +120,7 @@ Configure OpenSearch database authentication.
|
|||
| `OPENSEARCH_USERNAME` | `admin` | OpenSearch administrator username. |
|
||||
| `OPENSEARCH_PASSWORD` | Must be set at start up | Required. OpenSearch administrator password. Must adhere to the [OpenSearch password complexity requirements](https://docs.opensearch.org/latest/security/configuration/demo-configuration/#setting-up-a-custom-admin-password). You must set this directly in the `.env` or in the TUI's [**Basic/Advanced Setup**](/install#setup). |
|
||||
|
||||
### System settings
|
||||
## System settings
|
||||
|
||||
Configure general system components, session management, and logging.
|
||||
|
||||
|
|
@ -156,23 +134,4 @@ Configure general system components, session management, and logging.
|
|||
| `MAX_WORKERS` | `1` | Maximum number of workers for document processing. |
|
||||
| `OPENRAG_VERSION` | `latest` | The version of the OpenRAG Docker images to run. For more information, see [Upgrade OpenRAG](/upgrade) |
|
||||
| `SERVICE_NAME` | `openrag` | Service name for logging. |
|
||||
| `SESSION_SECRET` | Automatically generated | Session management. |
|
||||
|
||||
## Langflow runtime overrides
|
||||
|
||||
You can modify [flow](/agents) settings at runtime without permanently changing the flow's configuration.
|
||||
|
||||
Runtime overrides are implemented through _tweaks_, which are one-time parameter modifications that are passed to specific Langflow components during flow execution.
|
||||
|
||||
For more information on tweaks, see the Langflow documentation on [Input schema (tweaks)](https://docs.langflow.org/concepts-publish#input-schema).
|
||||
|
||||
## Default values and fallbacks
|
||||
|
||||
If a variable isn't set by environment variables or a configuration file, OpenRAG can use a default value if one is defined in the codebase.
|
||||
Default values can be found in the OpenRAG repository:
|
||||
|
||||
* OpenRAG configuration: [`config_manager.py`](https://github.com/langflow-ai/openrag/blob/main/src/config/config_manager.py)
|
||||
|
||||
* System configuration: [`settings.py`](https://github.com/langflow-ai/openrag/blob/main/src/config/settings.py)
|
||||
|
||||
* Logging configuration: [`logging_config.py`](https://github.com/langflow-ai/openrag/blob/main/src/utils/logging_config.py)
|
||||
| `SESSION_SECRET` | Automatically generated | Session management. |
|
||||
|
|
@ -3,6 +3,8 @@ title: Troubleshoot OpenRAG
|
|||
slug: /support/troubleshoot
|
||||
---
|
||||
|
||||
import PartialOllamaModels from '@site/docs/_partial-ollama-models.mdx';
|
||||
|
||||
This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG.
|
||||
|
||||
## OpenSearch fails to start
|
||||
|
|
@ -68,7 +70,7 @@ This is likely due to a stale `uv` cache when you [install OpenRAG with `uvx`](/
|
|||
|
||||
When you invoke OpenRAG with `uvx openrag`, `uvx` creates a cached, ephemeral environment that doesn't modify your project.
|
||||
The location and path of this cache depends on your operating system.
|
||||
For example, on macOS, this is typically a user cache directory, such as `/Users/USER_NAME/.cache/uv`.
|
||||
For example, on macOS, this is typically a user cache directory, such as `~/.cache/uv`.
|
||||
|
||||
This cache can become stale, producing errors like missing dependencies.
|
||||
|
||||
|
|
@ -137,4 +139,8 @@ To resolve this issue, do the following:
|
|||
|
||||
## Document ingestion or similarity search issues
|
||||
|
||||
See [Troubleshoot ingestion](/ingestion#troubleshoot-ingestion).
|
||||
See [Troubleshoot ingestion](/ingestion#troubleshoot-ingestion).
|
||||
|
||||
## Ollama model issues
|
||||
|
||||
<PartialOllamaModels />
|
||||
Loading…
Add table
Reference in a new issue