48 lines
No EOL
26 KiB
HTML
48 lines
No EOL
26 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configure/configuration" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.8.1">
|
||
<title data-rh="true">Configuration | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://langflow-ai.github.io/openrag/configure/configuration"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Configuration | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG supports multiple configuration methods with the following priority:"><meta data-rh="true" property="og:description" content="OpenRAG supports multiple configuration methods with the following priority:"><link data-rh="true" rel="icon" href="/openrag/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://langflow-ai.github.io/openrag/configure/configuration"><link data-rh="true" rel="alternate" href="https://langflow-ai.github.io/openrag/configure/configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://langflow-ai.github.io/openrag/configure/configuration" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Environment Variables","item":"https://langflow-ai.github.io/openrag/configure/configuration"}]}</script><link rel="stylesheet" href="/openrag/assets/css/styles.4376ff55.css">
|
||
<script src="/openrag/assets/js/runtime~main.5bd84645.js" defer="defer"></script>
|
||
<script src="/openrag/assets/js/main.7dea55cc.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;"><defs>
|
||
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t="light";var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/openrag/img/logo-openrag-light.svg"><link rel="preload" as="image" href="/openrag/img/logo-openrag-dark.svg"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/openrag/"><div class="navbar__logo"><img src="/openrag/img/logo-openrag-light.svg" alt="OpenRAG Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/openrag/img/logo-openrag-dark.svg" alt="OpenRAG Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/openrag/openrag" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/openrag/">Get Started</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/openrag/agents">Core components</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/openrag/configure/configuration">Configuration</a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/openrag/configure/configuration">Environment Variables</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/openrag/support/troubleshoot">Support</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/openrag/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Configuration</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Environment Variables</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Configuration</h1></header>
|
||
<p>OpenRAG supports multiple configuration methods with the following priority:</p>
|
||
<ol>
|
||
<li><strong>Environment Variables</strong> (highest priority)</li>
|
||
<li><strong>Configuration File</strong> (<code>config.yaml</code>)</li>
|
||
<li><strong>Langflow Flow Settings</strong> (runtime override)</li>
|
||
<li><strong>Default Values</strong> (fallback)</li>
|
||
</ol>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-file">Configuration File<a href="#configuration-file" class="hash-link" aria-label="Direct link to Configuration File" title="Direct link to Configuration File"></a></h2>
|
||
<p>Create a <code>config.yaml</code> file in the project root to configure OpenRAG:</p>
|
||
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic"># OpenRAG Configuration File</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token key atrule" style="color:#00a4db">provider</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">model_provider</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"openai"</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic"># openai, anthropic, azure, etc.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">api_key</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"your-api-key"</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic"># or use OPENAI_API_KEY env var</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token key atrule" style="color:#00a4db">knowledge</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">embedding_model</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"text-embedding-3-small"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">chunk_size</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1000</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">chunk_overlap</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">200</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">ocr</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean important" style="color:#36acaa">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">picture_descriptions</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean important" style="color:#36acaa">false</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token key atrule" style="color:#00a4db">agent</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">llm_model</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"gpt-4o-mini"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">system_prompt</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"You are a helpful AI assistant..."</span><br></span></code></pre></div></div>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="environment-variables">Environment Variables<a href="#environment-variables" class="hash-link" aria-label="Direct link to Environment Variables" title="Direct link to Environment Variables"></a></h2>
|
||
<p>Environment variables will override configuration file settings. You can still use <code>.env</code> files:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">cp .env.example .env</span><br></span></code></pre></div></div>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="required-variables">Required Variables<a href="#required-variables" class="hash-link" aria-label="Direct link to Required Variables" title="Direct link to Required Variables"></a></h2>
|
||
<table><thead><tr><th>Variable</th><th>Description</th></tr></thead><tbody><tr><td><code>OPENAI_API_KEY</code></td><td>Your OpenAI API key</td></tr><tr><td><code>OPENSEARCH_PASSWORD</code></td><td>Password for OpenSearch admin user</td></tr><tr><td><code>LANGFLOW_SUPERUSER</code></td><td>Langflow admin username</td></tr><tr><td><code>LANGFLOW_SUPERUSER_PASSWORD</code></td><td>Langflow admin password</td></tr><tr><td><code>LANGFLOW_CHAT_FLOW_ID</code></td><td>ID of your Langflow chat flow</td></tr><tr><td><code>LANGFLOW_INGEST_FLOW_ID</code></td><td>ID of your Langflow ingestion flow</td></tr><tr><td><code>NUDGES_FLOW_ID</code></td><td>ID of your Langflow nudges/suggestions flow</td></tr></tbody></table>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="ingestion-configuration">Ingestion Configuration<a href="#ingestion-configuration" class="hash-link" aria-label="Direct link to Ingestion Configuration" title="Direct link to Ingestion Configuration"></a></h2>
|
||
<table><thead><tr><th>Variable</th><th>Description</th></tr></thead><tbody><tr><td><code>DISABLE_INGEST_WITH_LANGFLOW</code></td><td>Disable Langflow ingestion pipeline (default: <code>false</code>)</td></tr></tbody></table>
|
||
<ul>
|
||
<li><code>false</code> or unset: Uses Langflow pipeline (upload → ingest → delete)</li>
|
||
<li><code>true</code>: Uses traditional OpenRAG processor for document ingestion</li>
|
||
</ul>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="optional-variables">Optional Variables<a href="#optional-variables" class="hash-link" aria-label="Direct link to Optional Variables" title="Direct link to Optional Variables"></a></h2>
|
||
<table><thead><tr><th>Variable</th><th>Description</th></tr></thead><tbody><tr><td><code>LANGFLOW_PUBLIC_URL</code></td><td>Public URL for Langflow (default: <code>http://localhost:7860</code>)</td></tr><tr><td><code>GOOGLE_OAUTH_CLIENT_ID</code> / <code>GOOGLE_OAUTH_CLIENT_SECRET</code></td><td>Google OAuth authentication</td></tr><tr><td><code>MICROSOFT_GRAPH_OAUTH_CLIENT_ID</code> / <code>MICROSOFT_GRAPH_OAUTH_CLIENT_SECRET</code></td><td>Microsoft OAuth</td></tr><tr><td><code>WEBHOOK_BASE_URL</code></td><td>Base URL for webhook endpoints</td></tr><tr><td><code>AWS_ACCESS_KEY_ID</code> / <code>AWS_SECRET_ACCESS_KEY</code></td><td>AWS integrations</td></tr><tr><td><code>SESSION_SECRET</code></td><td>Session management (default: auto-generated, change in production)</td></tr><tr><td><code>LANGFLOW_KEY</code></td><td>Explicit Langflow API key (auto-generated if not provided)</td></tr><tr><td><code>LANGFLOW_SECRET_KEY</code></td><td>Secret key for Langflow internal operations</td></tr></tbody></table>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="openrag-configuration-variables">OpenRAG Configuration Variables<a href="#openrag-configuration-variables" class="hash-link" aria-label="Direct link to OpenRAG Configuration Variables" title="Direct link to OpenRAG Configuration Variables"></a></h2>
|
||
<p>These environment variables override settings in <code>config.yaml</code>:</p>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="provider-settings">Provider Settings<a href="#provider-settings" class="hash-link" aria-label="Direct link to Provider Settings" title="Direct link to Provider Settings"></a></h3>
|
||
<table><thead><tr><th>Variable</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>MODEL_PROVIDER</code></td><td>Model provider (openai, anthropic, etc.)</td><td><code>openai</code></td></tr><tr><td><code>PROVIDER_API_KEY</code></td><td>API key for the model provider</td><td></td></tr><tr><td><code>OPENAI_API_KEY</code></td><td>OpenAI API key (backward compatibility)</td><td></td></tr></tbody></table>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="knowledge-settings">Knowledge Settings<a href="#knowledge-settings" class="hash-link" aria-label="Direct link to Knowledge Settings" title="Direct link to Knowledge Settings"></a></h3>
|
||
<table><thead><tr><th>Variable</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>EMBEDDING_MODEL</code></td><td>Embedding model for vector search</td><td><code>text-embedding-3-small</code></td></tr><tr><td><code>CHUNK_SIZE</code></td><td>Text chunk size for document processing</td><td><code>1000</code></td></tr><tr><td><code>CHUNK_OVERLAP</code></td><td>Overlap between chunks</td><td><code>200</code></td></tr><tr><td><code>OCR_ENABLED</code></td><td>Enable OCR for image processing</td><td><code>true</code></td></tr><tr><td><code>PICTURE_DESCRIPTIONS_ENABLED</code></td><td>Enable picture descriptions</td><td><code>false</code></td></tr></tbody></table>
|
||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="agent-settings">Agent Settings<a href="#agent-settings" class="hash-link" aria-label="Direct link to Agent Settings" title="Direct link to Agent Settings"></a></h3>
|
||
<table><thead><tr><th>Variable</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>LLM_MODEL</code></td><td>Language model for the chat agent</td><td><code>gpt-4o-mini</code></td></tr><tr><td><code>SYSTEM_PROMPT</code></td><td>System prompt for the agent</td><td>Default assistant prompt</td></tr></tbody></table>
|
||
<p>See <code>.env.example</code> for a complete list with descriptions, and <code>docker-compose*.yml</code> for runtime usage.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/configure/configuration.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/openrag/ingestion"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Docling Ingestion</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/openrag/support/troubleshoot"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Troubleshoot</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#configuration-file" class="table-of-contents__link toc-highlight">Configuration File</a></li><li><a href="#environment-variables" class="table-of-contents__link toc-highlight">Environment Variables</a></li><li><a href="#required-variables" class="table-of-contents__link toc-highlight">Required Variables</a></li><li><a href="#ingestion-configuration" class="table-of-contents__link toc-highlight">Ingestion Configuration</a></li><li><a href="#optional-variables" class="table-of-contents__link toc-highlight">Optional Variables</a></li><li><a href="#openrag-configuration-variables" class="table-of-contents__link toc-highlight">OpenRAG Configuration Variables</a><ul><li><a href="#provider-settings" class="table-of-contents__link toc-highlight">Provider Settings</a></li><li><a href="#knowledge-settings" class="table-of-contents__link toc-highlight">Knowledge Settings</a></li><li><a href="#agent-settings" class="table-of-contents__link toc-highlight">Agent Settings</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Documentation</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/openrag/">Getting Started</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/openrag/openrag" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://discord.gg/openrag" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 OpenRAG. Built with Docusaurus.</div></div></div></footer></div>
|
||
</body>
|
||
</html> |