From 90e5ed3d2dfe86e6b93ff24a215aae60227bfff0 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Mon, 29 Sep 2025 17:25:03 -0400 Subject: [PATCH] tweaks-override-defaults --- README.md | 2 +- .../{configure => reference}/configuration.md | 27 ++++++++++++------- docs/sidebars.js | 12 +++------ 3 files changed, 22 insertions(+), 19 deletions(-) rename docs/docs/{configure => reference}/configuration.md (88%) diff --git a/README.md b/README.md index d79011a0..bc020dae 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ LANGFLOW_CHAT_FLOW_ID=your_chat_flow_id LANGFLOW_INGEST_FLOW_ID=your_ingest_flow_id NUDGES_FLOW_ID=your_nudges_flow_id ``` -See extended configuration, including ingestion and optional variables: [docs/configure/configuration.md](docs/docs/configure/configuration.md) +See extended configuration, including ingestion and optional variables: [docs/reference/configuration.md](docs/docs/reference/configuration.md) ### 3. Start OpenRAG ```bash diff --git a/docs/docs/configure/configuration.md b/docs/docs/reference/configuration.md similarity index 88% rename from docs/docs/configure/configuration.md rename to docs/docs/reference/configuration.md index 79a5226a..a8aeff5f 100644 --- a/docs/docs/configure/configuration.md +++ b/docs/docs/reference/configuration.md @@ -1,18 +1,19 @@ --- title: Environment variables and configuration values -slug: /configure/configuration +slug: /reference/configuration --- -OpenRAG supports multiple configuration methods with the following priority: +OpenRAG supports multiple configuration methods with the following priority, from highest to lowest: -1. **Environment Variables** (highest priority) -2. **Configuration File** (`config.yaml`) -3. **Default Values** (fallback) +1. [Environment variables](#environment-variables) +2. [Configuration file (`config.yaml`)](#configuration-file) +3. [Langflow runtime overrides](#langflow-runtime-overrides) +4. [Default or fallback values](#default-values-and-fallbacks) ## Environment variables -Environment variables will override configuration file settings. -You can create a `.env` file in the project root to set these variables. +Environment variables override configuration file settings. +You can create a `.env` file in the project root to set these variables, or set them in the TUI, which will create a `.env` file for you. ## Required variables @@ -90,7 +91,15 @@ These environment variables override settings in `config.yaml`: See `docker-compose-*.yml` files for runtime usage examples. -## Configuration file +## Langflow runtime overrides + +Langflow runtime overrides allow you to modify component settings at runtime without changing the base configuration. + +Runtime overrides are implemented through **tweaks** - parameter modifications that are passed to specific Langflow components during flow execution. + +For more information on tweaks, see [Input schema (tweaks)](https://docs.langflow.org/concepts-publish#input-schema). + +## Configuration file (`config.yaml) {#configuration-file} Create a `config.yaml` file in the project root to configure OpenRAG: @@ -115,7 +124,7 @@ agent: system_prompt: "You are a helpful AI assistant with access to a knowledge base. Answer questions based on the provided context." ``` -## Default Values and Fallbacks +## Default values and fallbacks When no environment variables or configuration file values are provided, OpenRAG uses default values. These values can be found in the code base at the following locations. diff --git a/docs/sidebars.js b/docs/sidebars.js index 3048cb70..1e81a3cd 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -65,19 +65,13 @@ const sidebars = { }, { type: "category", - label: "Configuration", + label: "Reference", items: [ { type: "doc", - id: "configure/configuration", - label: "Environment Variables" + id: "reference/configuration", + label: "Environment Variables and Configuration File" }, - ], - }, - { - type: "category", - label: "Reference", - items: [ { type: "doc", id: "reference/troubleshooting",