107 lines
No EOL
37 KiB
HTML
107 lines
No EOL
37 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-reference/configuration" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.9.2">
|
||
<title data-rh="true">Environment variables | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/reference/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="Environment variables | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG recognizes environment variables from the following sources:"><meta data-rh="true" property="og:description" content="OpenRAG recognizes environment variables from the following sources:"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/reference/configuration"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reference/configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reference/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://docs.openr.ag/reference/configuration"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||
<script src="/assets/js/runtime~main.5f015f17.js" defer="defer"></script>
|
||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<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=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",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),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="/img/logo-openrag-light.svg"><link rel="preload" as="image" href="/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="/"><div class="navbar__logo"><img src="/img/logo-openrag-light.svg" alt="OpenRAG Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/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/langflow-ai/openrag" target="_blank" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></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-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/"><span title="About OpenRAG" class="linkLabel_WmDU">About OpenRAG</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/quickstart"><span title="Quickstart" class="linkLabel_WmDU">Quickstart</span></a></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="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/install-options"><span title="Installation" class="categoryLinkLabel_W154">Installation</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tui"><span title="Use the TUI" class="linkLabel_WmDU">Use the TUI</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/manage-services"><span title="Manage services" class="linkLabel_WmDU">Manage services</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/agents"><span title="Flows" class="linkLabel_WmDU">Flows</span></a></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="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/knowledge"><span title="Knowledge" class="categoryLinkLabel_W154">Knowledge</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/chat"><span title="Chat" class="linkLabel_WmDU">Chat</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/reference/configuration"><span title="Environment variables" class="linkLabel_WmDU">Environment variables</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/support/troubleshoot"><span title="Troubleshoot OpenRAG" class="linkLabel_WmDU">Troubleshoot OpenRAG</span></a></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="/"><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 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>Environment variables</h1></header><p>OpenRAG recognizes environment variables from the following sources:</p>
|
||
<ul>
|
||
<li class=""><a href="#configure-environment-variables" class="">Environment variables</a>: Values set in the <code>.env</code> file in the OpenRAG installation directory.</li>
|
||
<li class=""><a href="#langflow-runtime-overrides" class="">Langflow runtime overrides</a>: Langflow components can set environment variables at runtime.</li>
|
||
<li class=""><a href="#default-values-and-fallbacks" class="">Default or fallback values</a>: These values are default or fallback values if OpenRAG doesn't find a value.</li>
|
||
</ul>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="configure-environment-variables">Configure environment variables<a href="#configure-environment-variables" class="hash-link" aria-label="Direct link to Configure environment variables" title="Direct link to Configure environment variables" translate="no"></a></h2>
|
||
<p>Environment variables are set in a <code>.env</code> file in the root of your OpenRAG project directory.</p>
|
||
<p>For an example <code>.env</code> file, see <a href="https://github.com/langflow-ai/openrag/blob/main/.env.example" target="_blank" rel="noopener noreferrer" class=""><code>.env.example</code> in the OpenRAG repository</a>.</p>
|
||
<p>The Docker Compose files are populated with values from your <code>.env</code>, so you don't need to edit the Docker Compose files manually.</p>
|
||
<p>Environment variables always take precedence over other variables.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="set-environment-variables">Set environment variables<a href="#set-environment-variables" class="hash-link" aria-label="Direct link to Set environment variables" title="Direct link to Set environment variables" translate="no"></a></h3>
|
||
<p>Environment variables are either mutable or immutable.</p>
|
||
<p>If you edit mutable environment variables, you can apply the changes by stopping and restarting the OpenRAG services after editing the <code>.env</code> file:</p>
|
||
<ol>
|
||
<li class="">
|
||
<p><a class="" href="/manage-services">Stop the OpenRAG services</a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Edit your <code>.env</code> file.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><a class="" href="/manage-services">Restart the OpenRAG services</a>.</p>
|
||
</li>
|
||
</ol>
|
||
<p>If you edit immutable environment variables, you must <a class="" href="/reinstall">redeploy OpenRAG</a> with your modified <code>.env</code> file.
|
||
For example, with self-managed services, do the following:</p>
|
||
<ol>
|
||
<li class="">
|
||
<p>Stop the deployment:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Docker</div><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 function" style="color:#d73a49">docker</span><span class="token plain"> compose down</span><br></span></code></pre></div></div>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><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 function" style="color:#d73a49">podman</span><span class="token plain"> compose down</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Edit your <code>.env</code> file.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Redeploy OpenRAG:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Docker</div><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 function" style="color:#d73a49">docker</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">-d</span><br></span></code></pre></div></div>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><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 function" style="color:#d73a49">podman</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">-d</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Restart the Docling service.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Launch the OpenRAG app, and then repeat the <a class="" href="/install#application-onboarding">application onboarding process</a>. The values in your <code>.env</code> file are automatically populated.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="supported-environment-variables">Supported environment variables<a href="#supported-environment-variables" class="hash-link" aria-label="Direct link to Supported environment variables" title="Direct link to Supported environment variables" translate="no"></a></h2>
|
||
<p>All OpenRAG configuration can be controlled through environment variables.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="model-provider-settings">Model provider settings<a href="#model-provider-settings" class="hash-link" aria-label="Direct link to Model provider settings" title="Direct link to Model provider settings" translate="no"></a></h3>
|
||
<p>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.</p>
|
||
<p>These variables are initially set during the <a class="" href="/install#application-onboarding">application onboarding process</a>.
|
||
Some of these variables are immutable and can only be changed by redeploying OpenRAG, as explained in <a href="#set-environment-variables" class="">Set environment variables</a>.</p>
|
||
<table><thead><tr><th>Variable</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>EMBEDDING_MODEL</code></td><td><code>text-embedding-3-small</code></td><td>Embedding model for generating vector embeddings for documents in the knowledge base and similarity search queries. Can be changed after the application onboarding process. Accepts one or more models.</td></tr><tr><td><code>LLM_MODEL</code></td><td><code>gpt-4o-mini</code></td><td>Language model for language processing and text generation in the <strong>Chat</strong> feature.</td></tr><tr><td><code>MODEL_PROVIDER</code></td><td><code>openai</code></td><td>Model provider, as one of <code>openai</code>, <code>watsonx</code>, <code>ollama</code>, or <code>anthropic</code>.</td></tr><tr><td><code>ANTHROPIC_API_KEY</code></td><td>Not set</td><td>API key for the Anthropic language model provider.</td></tr><tr><td><code>OPENAI_API_KEY</code></td><td>Not set</td><td>API key for the OpenAI model provider, which is also the default model provider.</td></tr><tr><td><code>OLLAMA_ENDPOINT</code></td><td>Not set</td><td>Custom provider endpoint for the Ollama model provider.</td></tr><tr><td><code>WATSONX_API_KEY</code></td><td>Not set</td><td>API key for the IBM watsonx.ai model provider.</td></tr><tr><td><code>WATSONX_ENDPOINT</code></td><td>Not set</td><td>Custom provider endpoint for the IBM watsonx.ai model provider.</td></tr><tr><td><code>WATSONX_PROJECT_ID</code></td><td>Not set</td><td>Project ID for the IBM watsonx.ai model provider.</td></tr></tbody></table>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="document-processing-settings">Document processing settings<a href="#document-processing-settings" class="hash-link" aria-label="Direct link to Document processing settings" title="Direct link to Document processing settings" translate="no"></a></h3>
|
||
<p>Control how OpenRAG <a class="" href="/ingestion">processes and ingests documents</a> into your knowledge base.</p>
|
||
<table><thead><tr><th>Variable</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>CHUNK_OVERLAP</code></td><td><code>200</code></td><td>Overlap between chunks.</td></tr><tr><td><code>CHUNK_SIZE</code></td><td><code>1000</code></td><td>Text chunk size for document processing.</td></tr><tr><td><code>DISABLE_INGEST_WITH_LANGFLOW</code></td><td><code>false</code></td><td>Disable Langflow ingestion pipeline.</td></tr><tr><td><code>DOCLING_OCR_ENGINE</code></td><td>Set by OS</td><td>OCR engine for document processing. For macOS, <code>ocrmac</code>. For any other OS, <code>easyocr</code>.</td></tr><tr><td><code>OCR_ENABLED</code></td><td><code>false</code></td><td>Enable OCR for image processing.</td></tr><tr><td><code>OPENRAG_DOCUMENTS_PATHS</code></td><td><code>./openrag-documents</code></td><td>Document paths for ingestion.</td></tr><tr><td><code>PICTURE_DESCRIPTIONS_ENABLED</code></td><td><code>false</code></td><td>Enable picture descriptions.</td></tr></tbody></table>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="langflow-settings">Langflow settings<a href="#langflow-settings" class="hash-link" aria-label="Direct link to Langflow settings" title="Direct link to Langflow settings" translate="no"></a></h3>
|
||
<p>Configure the OpenRAG Langflow server's authentication, contact point, and built-in flow definitions.</p>
|
||
<div class="theme-admonition theme-admonition-info admonition_xJq3 alert alert--info"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>info</div><div class="admonitionContent_BuS1"><p>The <code>LANGFLOW_SUPERUSER_PASSWORD</code> is set in your <code>.env</code> file, and this value determines the default values for several other Langflow authentication variables.</p><p>If the <code>LANGFLOW_SUPERUSER_PASSWORD</code> variable isn't set, then the Langflow server starts <em>without</em> authentication enabled.</p><p>For better security, it is recommended to set <code>LANGFLOW_SUPERUSER_PASSWORD</code> so the <a href="https://docs.langflow.org/api-keys-and-authentication#start-a-langflow-server-with-authentication-enabled" target="_blank" rel="noopener noreferrer" class="">Langflow server starts with authentication enabled</a>.</p></div></div>
|
||
<table><thead><tr><th>Variable</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>LANGFLOW_AUTO_LOGIN</code></td><td>Determined by <code>LANGFLOW_SUPERUSER_PASSWORD</code></td><td>Whether to enable <a href="https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login" target="_blank" rel="noopener noreferrer" class="">auto-login mode</a> for the Langflow visual editor and CLI. If <code>LANGFLOW_SUPERUSER_PASSWORD</code> isn't set, then <code>LANGFLOW_AUTO_LOGIN</code> is <code>True</code> and auto-login mode is enabled. If <code>LANGFLOW_SUPERUSER_PASSWORD</code> is set, then <code>LANGFLOW_AUTO_LOGIN</code> is <code>False</code> and auto-login mode is disabled. Langflow API calls always require authentication with a Langflow API key regardless of the auto-login setting.</td></tr><tr><td><code>LANGFLOW_ENABLE_SUPERUSER_CLI</code></td><td>Determined by <code>LANGFLOW_SUPERUSER_PASSWORD</code></td><td>Whether to enable the <a href="https://docs.langflow.org/api-keys-and-authentication#langflow-enable-superuser-cli" target="_blank" rel="noopener noreferrer" class="">Langflow CLI <code>langflow superuser</code> command</a>. If <code>LANGFLOW_SUPERUSER_PASSWORD</code> isn't set, then <code>LANGFLOW_ENABLE_SUPERUSER_CLI</code> is <code>True</code> and superuser accounts can be created with the Langflow CLI. If <code>LANGFLOW_SUPERUSER_PASSWORD</code> is set, then <code>LANGFLOW_ENABLE_SUPERUSER_CLI</code> is <code>False</code> and the <code>langflow superuser</code> command is disabled.</td></tr><tr><td><code>LANGFLOW_NEW_USER_IS_ACTIVE</code></td><td>Determined by <code>LANGFLOW_SUPERUSER_PASSWORD</code></td><td>Whether new <a href="https://docs.langflow.org/api-keys-and-authentication#langflow-new-user-is-active" target="_blank" rel="noopener noreferrer" class="">Langflow user accounts are active by default</a>. If <code>LANGFLOW_SUPERUSER_PASSWORD</code> isn't set, then <code>LANGFLOW_NEW_USER_IS_ACTIVE</code> is <code>True</code> and new user accounts are active by default. If <code>LANGFLOW_SUPERUSER_PASSWORD</code> is set, then <code>LANGFLOW_NEW_USER_IS_ACTIVE</code> is <code>False</code> and new user accounts are inactive by default.</td></tr><tr><td><code>LANGFLOW_PUBLIC_URL</code></td><td><code>http://localhost:7860</code></td><td>Public URL for the Langflow instance. Forms the base URL for Langflow API calls and other interfaces with your OpenRAG Langflow instance.</td></tr><tr><td><code>LANGFLOW_KEY</code></td><td>Automatically generated</td><td>A Langflow API key to run flows with Langflow API calls. Because Langflow API keys are server-specific, allow OpenRAG to generate this key initially. You can create additional Langflow API keys after deploying OpenRAG.</td></tr><tr><td><code>LANGFLOW_SECRET_KEY</code></td><td>Automatically generated</td><td>Secret encryption key for Langflow internal operations. It is recommended to <a href="https://docs.langflow.org/api-keys-and-authentication#langflow-secret-key" target="_blank" rel="noopener noreferrer" class="">generate your own Langflow secret key</a> for this variable. If this variable isn't set, then Langflow generates a secret key automatically.</td></tr><tr><td><code>LANGFLOW_SUPERUSER</code></td><td><code>admin</code></td><td>Username for the Langflow administrator user.</td></tr><tr><td><code>LANGFLOW_SUPERUSER_PASSWORD</code></td><td>Not set</td><td>Langflow administrator password. If this variable isn't set, then the Langflow server starts <em>without</em> authentication enabled. It is recommended to set <code>LANGFLOW_SUPERUSER_PASSWORD</code> so the <a href="https://docs.langflow.org/api-keys-and-authentication#start-a-langflow-server-with-authentication-enabled" target="_blank" rel="noopener noreferrer" class="">Langflow server starts with authentication enabled</a>.</td></tr><tr><td><code>LANGFLOW_URL</code></td><td><code>http://localhost:7860</code></td><td>URL for the Langflow instance.</td></tr><tr><td><code>LANGFLOW_CHAT_FLOW_ID</code>, <code>LANGFLOW_INGEST_FLOW_ID</code>, <code>NUDGES_FLOW_ID</code></td><td>Built-in flow IDs</td><td>These variables are set automatically to the IDs of the chat, ingestion, and nudges <a class="" href="/agents">flows</a>. The default values are found in <a href="https://github.com/langflow-ai/openrag/blob/main/.env.example" target="_blank" rel="noopener noreferrer" class=""><code>.env.example</code></a>. 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 <a class="" href="/docker">deploy self-managed services</a>, you can add the flow JSON to your local clone of the OpenRAG repository before deploying OpenRAG.</td></tr><tr><td><code>SYSTEM_PROMPT</code></td><td><code>You are a helpful AI assistant with access to a knowledge base. Answer questions based on the provided context.</code></td><td>System prompt instructions for the agent driving the <strong>Chat</strong> flow.</td></tr></tbody></table>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="oauth-provider-settings">OAuth provider settings<a href="#oauth-provider-settings" class="hash-link" aria-label="Direct link to OAuth provider settings" title="Direct link to OAuth provider settings" translate="no"></a></h3>
|
||
<p>Configure <a class="" href="/ingestion#oauth-ingestion">OAuth providers</a> and external service integrations.</p>
|
||
<table><thead><tr><th>Variable</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>AWS_ACCESS_KEY_ID</code><br><code>AWS_SECRET_ACCESS_KEY</code></td><td>Not set</td><td>Enable access to AWS S3 with an <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-applications.html" target="_blank" rel="noopener noreferrer" class="">AWS OAuth app</a> integration.</td></tr><tr><td><code>GOOGLE_OAUTH_CLIENT_ID</code><br><code>GOOGLE_OAUTH_CLIENT_SECRET</code></td><td>Not set</td><td>Enable the <a href="https://developers.google.com/identity/protocols/oauth2" target="_blank" rel="noopener noreferrer" class="">Google OAuth client</a> integration. You can generate these values in the <a href="https://console.cloud.google.com/apis/credentials" target="_blank" rel="noopener noreferrer" class="">Google Cloud Console</a>.</td></tr><tr><td><code>MICROSOFT_GRAPH_OAUTH_CLIENT_ID</code><br><code>MICROSOFT_GRAPH_OAUTH_CLIENT_SECRET</code></td><td>Not set</td><td>Enable the <a href="https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/graph-oauth" target="_blank" rel="noopener noreferrer" class="">Microsoft Graph OAuth client</a> integration by providing <a href="https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/app-registration?view=odsp-graph-online" target="_blank" rel="noopener noreferrer" class="">Azure application registration credentials for SharePoint and OneDrive</a>.</td></tr><tr><td><code>WEBHOOK_BASE_URL</code></td><td>Not set</td><td>Base URL for OAuth connector webhook endpoints. If this variable isn't set, a default base URL is used.</td></tr></tbody></table>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="opensearch-settings">OpenSearch settings<a href="#opensearch-settings" class="hash-link" aria-label="Direct link to OpenSearch settings" title="Direct link to OpenSearch settings" translate="no"></a></h3>
|
||
<p>Configure OpenSearch database authentication.</p>
|
||
<table><thead><tr><th>Variable</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>OPENSEARCH_HOST</code></td><td><code>localhost</code></td><td>OpenSearch instance host.</td></tr><tr><td><code>OPENSEARCH_PORT</code></td><td><code>9200</code></td><td>OpenSearch instance port.</td></tr><tr><td><code>OPENSEARCH_USERNAME</code></td><td><code>admin</code></td><td>OpenSearch administrator username.</td></tr><tr><td><code>OPENSEARCH_PASSWORD</code></td><td>Must be set at start up</td><td>Required. OpenSearch administrator password. Must adhere to the <a href="https://docs.opensearch.org/latest/security/configuration/demo-configuration/#setting-up-a-custom-admin-password" target="_blank" rel="noopener noreferrer" class="">OpenSearch password complexity requirements</a>. You must set this directly in the <code>.env</code> or in the TUI's <a class="" href="/install#setup"><strong>Basic/Advanced Setup</strong></a>.</td></tr></tbody></table>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="system-settings">System settings<a href="#system-settings" class="hash-link" aria-label="Direct link to System settings" title="Direct link to System settings" translate="no"></a></h3>
|
||
<p>Configure general system components, session management, and logging.</p>
|
||
<table><thead><tr><th>Variable</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>LANGFLOW_KEY_RETRIES</code></td><td><code>15</code></td><td>Number of retries for Langflow key generation.</td></tr><tr><td><code>LANGFLOW_KEY_RETRY_DELAY</code></td><td><code>2.0</code></td><td>Delay between retries in seconds.</td></tr><tr><td><code>LANGFLOW_VERSION</code></td><td><code>OPENRAG_VERSION</code></td><td>Langflow Docker image version. By default, OpenRAG uses the <code>OPENRAG_VERSION</code> for the Langflow Docker image version.</td></tr><tr><td><code>LOG_FORMAT</code></td><td>Not set</td><td>Set to <code>json</code> to enabled JSON-formatted log output. If this variable isn't set, then the default logging format is used.</td></tr><tr><td><code>LOG_LEVEL</code></td><td><code>INFO</code></td><td>Logging level. Can be one of <code>DEBUG</code>, <code>INFO</code>, <code>WARNING</code>, or <code>ERROR</code>. <code>DEBUG</code> provides the most detailed logs but can impact performance.</td></tr><tr><td><code>MAX_WORKERS</code></td><td><code>1</code></td><td>Maximum number of workers for document processing.</td></tr><tr><td><code>OPENRAG_VERSION</code></td><td><code>latest</code></td><td>The version of the OpenRAG Docker images to run. For more information, see <a class="" href="/upgrade">Upgrade OpenRAG</a></td></tr><tr><td><code>SERVICE_NAME</code></td><td><code>openrag</code></td><td>Service name for logging.</td></tr><tr><td><code>SESSION_SECRET</code></td><td>Automatically generated</td><td>Session management.</td></tr></tbody></table>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="langflow-runtime-overrides">Langflow runtime overrides<a href="#langflow-runtime-overrides" class="hash-link" aria-label="Direct link to Langflow runtime overrides" title="Direct link to Langflow runtime overrides" translate="no"></a></h2>
|
||
<p>You can modify <a class="" href="/agents">flow</a> settings at runtime without permanently changing the flow's configuration.</p>
|
||
<p>Runtime overrides are implemented through <em>tweaks</em>, which are one-time parameter modifications that are passed to specific Langflow components during flow execution.</p>
|
||
<p>For more information on tweaks, see the Langflow documentation on <a href="https://docs.langflow.org/concepts-publish#input-schema" target="_blank" rel="noopener noreferrer" class="">Input schema (tweaks)</a>.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="default-values-and-fallbacks">Default values and fallbacks<a href="#default-values-and-fallbacks" class="hash-link" aria-label="Direct link to Default values and fallbacks" title="Direct link to Default values and fallbacks" translate="no"></a></h2>
|
||
<p>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:</p>
|
||
<ul>
|
||
<li class="">
|
||
<p>OpenRAG configuration: <a href="https://github.com/langflow-ai/openrag/blob/main/src/config/config_manager.py" target="_blank" rel="noopener noreferrer" class=""><code>config_manager.py</code></a></p>
|
||
</li>
|
||
<li class="">
|
||
<p>System configuration: <a href="https://github.com/langflow-ai/openrag/blob/main/src/config/settings.py" target="_blank" rel="noopener noreferrer" class=""><code>settings.py</code></a></p>
|
||
</li>
|
||
<li class="">
|
||
<p>Logging configuration: <a href="https://github.com/langflow-ai/openrag/blob/main/src/utils/logging_config.py" target="_blank" rel="noopener noreferrer" class=""><code>logging_config.py</code></a></p>
|
||
</li>
|
||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/reference/configuration.mdx" 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="/chat"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Chat</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/support/troubleshoot"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Troubleshoot OpenRAG</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="#configure-environment-variables" class="table-of-contents__link toc-highlight">Configure environment variables</a><ul><li><a href="#set-environment-variables" class="table-of-contents__link toc-highlight">Set environment variables</a></li></ul></li><li><a href="#supported-environment-variables" class="table-of-contents__link toc-highlight">Supported environment variables</a><ul><li><a href="#model-provider-settings" class="table-of-contents__link toc-highlight">Model provider settings</a></li><li><a href="#document-processing-settings" class="table-of-contents__link toc-highlight">Document processing settings</a></li><li><a href="#langflow-settings" class="table-of-contents__link toc-highlight">Langflow settings</a></li><li><a href="#oauth-provider-settings" class="table-of-contents__link toc-highlight">OAuth provider settings</a></li><li><a href="#opensearch-settings" class="table-of-contents__link toc-highlight">OpenSearch settings</a></li><li><a href="#system-settings" class="table-of-contents__link toc-highlight">System settings</a></li></ul></li><li><a href="#langflow-runtime-overrides" class="table-of-contents__link toc-highlight">Langflow runtime overrides</a></li><li><a href="#default-values-and-fallbacks" class="table-of-contents__link toc-highlight">Default values and fallbacks</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
|
||
<span>© 2025 OpenRAG</span>
|
||
</div></li></ul></div></div></div></footer></div>
|
||
</body>
|
||
</html> |