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

tweaks-override-defaults

Browse source
This commit is contained in:
Mendon Kissling 2025-09-29 17:25:03 -04:00
parent f45441a9e5
commit 90e5ed3d2d
3 changed files with 22 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -62,7 +62,7 @@ LANGFLOW_CHAT_FLOW_ID=your_chat_flow_id
LANGFLOW_INGEST_FLOW_ID=your_ingest_flow_id LANGFLOW_INGEST_FLOW_ID=your_ingest_flow_id
NUDGES_FLOW_ID=your_nudges_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 ### 3. Start OpenRAG
```bash ```bash

27
docs/docs/configure/configuration.md → docs/docs/reference/configuration.md
View file

@ -1,18 +1,19 @@
--- ---
title: Environment variables and configuration values 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) 1. [Environment variables](#environment-variables)
2. **Configuration File** (`config.yaml`) 2. [Configuration file (`config.yaml`)](#configuration-file)
3. **Default Values** (fallback) 3. [Langflow runtime overrides](#langflow-runtime-overrides)
4. [Default or fallback values](#default-values-and-fallbacks)
## Environment variables ## Environment variables
Environment variables will override configuration file settings. Environment variables override configuration file settings.
You can create a `.env` file in the project root to set these variables. 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 ## Required variables
@ -90,7 +91,15 @@ These environment variables override settings in `config.yaml`:
See `docker-compose-*.yml` files for runtime usage examples. 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: 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." 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. 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. These values can be found in the code base at the following locations.

12
docs/sidebars.js
View file

@ -65,19 +65,13 @@ const sidebars = {
}, },
{ {
type: "category", type: "category",
label: "Configuration", label: "Reference",
items: [ items: [
{ {
type: "doc", type: "doc",
id: "configure/configuration", id: "reference/configuration",
label: "Environment Variables" label: "Environment Variables and Configuration File"
}, },
],
},
{
type: "category",
label: "Reference",
items: [
{ {
type: "doc", type: "doc",
id: "reference/troubleshooting", id: "reference/troubleshooting",