pengjunjie/langflow
1
0
Fork 1
mirror of https://github.com/langflow-ai/langflow.git synced 2026-07-24 04:13:36 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
1a49d99f628f829726d2928fe4272a831702b970
langflow/environment-variables.html
github-merge-queue[bot] 1a49d99f62 deploy: cd313b73d7
2025-03-06 14:30:11 +00:00

72 lines
41 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-Configuration/environment-variables" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.7.0">
<title data-rh="true">Environment variables | Langflow Documentation</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://docs.langflow.org/environment-variables"><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 | Langflow Documentation"><meta data-rh="true" name="description" content="Langflow lets you configure a number of settings using environment variables."><meta data-rh="true" property="og:description" content="Langflow lets you configure a number of settings using environment variables."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.langflow.org/environment-variables"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/environment-variables" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/environment-variables" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://UZK6BDPCVY-dsn.algolia.net" crossorigin="anonymous"><link rel="preconnect" href="https://www.google-analytics.com">
<link rel="preconnect" href="https://www.googletagmanager.com">
<script async src="https://www.googletagmanager.com/gtag/js?id=G-XHC7G628ZP"></script>
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-XHC7G628ZP",{anonymize_ip:!0})</script>
<link rel="preconnect" href="https://www.googletagmanager.com">
<script>window.dataLayer=window.dataLayer||[]</script>
<script>!function(e,t,a,n){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var g=t.getElementsByTagName(a)[0],m=t.createElement(a);m.async=!0,m.src="https://www.googletagmanager.com/gtm.js?id=GTM-NK5M4ZT8",g.parentNode.insertBefore(m,g)}(window,document,"script","dataLayer")</script>
<link rel="search" type="application/opensearchdescription+xml" title="Langflow Documentation" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e5a88218.css">
<script src="/assets/js/runtime~main.22d1d3f1.js" defer="defer"></script>
<script src="/assets/js/main.950e95c5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NK5M4ZT8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,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"><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="navbar navbar--fixed-top navbarHideable_m1mJ"><div class="navbar__inner"><div class="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/langflow-logo-black.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/langflow-logo-white.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/langflow-ai/langflow" target="_blank" class="navbar__item navbar__link header-github-link"></a><a href="https://twitter.com/langflow_ai" target="_blank" class="navbar__item navbar__link header-twitter-link"></a><a href="https://discord.gg/EqksyE2EX9" target="_blank" class="navbar__item navbar__link header-discord-link"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite" aria-pressed="false"><svg viewBox="0 0 24 24" width="24" height="24" class="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" class="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></button></div><div class="navbarSearchContainer_Bca1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Command+K)"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="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 sidebarWithHideableNavbar_wUlq"><a tabindex="-1" class="sidebarLogo_isFc" href="/"><img src="/img/langflow-logo-black.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/langflow-logo-white.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--dark_xIcU"></a><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="/">Welcome to Langflow</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="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/get-started-installation">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="/starter-projects-basic-prompting">Starter projects</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="/tutorials-blog-writer">Tutorials</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="/concepts-overview">Concepts</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="/components-agents">Components</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="/agents-overview">Agents</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="/configuration-api-keys">Configuration</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-api-keys">API keys</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-authentication">Authentication</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-auto-save">Auto-saving</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-backend-only">Run Langflow in backend-only mode</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-cli">Langflow CLI</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-global-variables">Global variables</a></li><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="/environment-variables">Environment variables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/configuration-security-best-practices">Security best practices</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="/deployment-docker">Deployment</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="/api">API reference</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="/integrations-apify">Integrations</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="/contributing-community">Contributing</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 href="https://github.com/langflow-ai/langflow/releases/latest" target="_blank" rel="noopener noreferrer" class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false">Changelog</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" itemscope="" itemtype="https://schema.org/BreadcrumbList"><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"><span class="breadcrumbs__link">Configuration</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Environment variables</span><meta itemprop="position" content="2"></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><style>[data-ch-theme="github-dark"] { --ch-t-colorScheme: dark;--ch-t-foreground: #c9d1d9;--ch-t-background: #0d1117;--ch-t-lighter-inlineBackground: #0d1117e6;--ch-t-editor-background: #0d1117;--ch-t-editor-foreground: #c9d1d9;--ch-t-editor-lineHighlightBackground: #6e76811a;--ch-t-editor-rangeHighlightBackground: #ffffff0b;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #264F78;--ch-t-focusBorder: #1f6feb;--ch-t-tab-activeBackground: #0d1117;--ch-t-tab-activeForeground: #c9d1d9;--ch-t-tab-inactiveBackground: #010409;--ch-t-tab-inactiveForeground: #8b949e;--ch-t-tab-border: #30363d;--ch-t-tab-activeBorder: #0d1117;--ch-t-editorGroup-border: #30363d;--ch-t-editorGroupHeader-tabsBackground: #010409;--ch-t-editorLineNumber-foreground: #6e7681;--ch-t-input-background: #0d1117;--ch-t-input-foreground: #c9d1d9;--ch-t-input-border: #30363d;--ch-t-icon-foreground: #8b949e;--ch-t-sideBar-background: #010409;--ch-t-sideBar-foreground: #c9d1d9;--ch-t-sideBar-border: #30363d;--ch-t-list-activeSelectionBackground: #6e768166;--ch-t-list-activeSelectionForeground: #c9d1d9;--ch-t-list-hoverBackground: #6e76811a;--ch-t-list-hoverForeground: #c9d1d9; }</style>
<!-- -->
<p>Langflow lets you configure a number of settings using environment variables.</p>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" 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">​</a></h2>
<p>Langflow recognizes <a href="#supported-variables">supported environment variables</a> from the following sources:</p>
<ul>
<li>Environment variables that you&#x27;ve set in your terminal.</li>
<li>Environment variables that you&#x27;ve imported from a <code>.env</code> file using the <code>--env-file</code> option in the Langflow CLI.</li>
</ul>
<p>You can choose to use one source exclusively, or use both sources together.
If you choose to use both sources together, be aware that environment variables imported from a <code>.env</code> file take <a href="#precedence">precedence</a> over those set in your terminal.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="configure-variables-terminal">Set environment variables in your terminal<a href="#configure-variables-terminal" class="hash-link" aria-label="Direct link to Set environment variables in your terminal" title="Direct link to Set environment variables in your terminal">​</a></h3>
<p>Run the following commands to set environment variables for your current terminal session:</p>
<div class="tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Linux or macOS</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Windows</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Docker</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>export VARIABLE_NAME=&#x27;VALUE&#x27;</span></div></div><br></code></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>set VARIABLE_NAME=&#x27;VALUE&#x27;</span></div></div><br></code></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>docker run -it --rm \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -p 7860:7860 \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -e VARIABLE_NAME=&#x27;VALUE&#x27; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> langflowai/langflow:latest</span></div></div><br></code></div></div></div></div></div>
<p>When you start Langflow, it looks for environment variables that you&#x27;ve set in your terminal.
If it detects a supported environment variable, then it automatically adopts the specified value, subject to <a href="#precedence">precedence rules</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="configure-variables-env-file">Import environment variables from a .env file<a href="#configure-variables-env-file" class="hash-link" aria-label="Direct link to Import environment variables from a .env file" title="Direct link to Import environment variables from a .env file">​</a></h3>
<ol>
<li>
<p>Create a <code>.env</code> file and open it in your preferred editor.</p>
</li>
<li>
<p>Add your environment variables to the file:</p>
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>VARIABLE_NAME=&#x27;VALUE&#x27;</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>VARIABLE_NAME=&#x27;VALUE&#x27;</span></div></div><br></code></div></div>
<div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_BuS1"><p>The Langflow project includes a <a href="https://github.com/langflow-ai/langflow/blob/main/.env.example" target="_blank" rel="noopener noreferrer"><code>.env.example</code></a> file to help you get started.
You can copy the contents of this file into your own <code>.env</code> file and replace the example values with your own preferred settings.</p></div></div>
</li>
<li>
<p>Save and close the file.</p>
</li>
<li>
<p>Start Langflow using the <code>--env-file</code> option to define the path to your <code>.env</code> file:</p>
<div class="tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Local</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Docker</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>python -m langflow run --env-file .env</span></div></div><br></code></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>docker run -it --rm \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -p 7860:7860 \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> --env-file .env \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> langflowai/langflow:latest</span></div></div><br></code></div></div></div></div></div>
</li>
</ol>
<p>On startup, Langflow imports the environment variables from your <code>.env</code> file, as well as any that you <a href="#configure-variables-terminal">set in your terminal</a>, and adopts their specified values.</p>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="precedence">Precedence<a href="#precedence" class="hash-link" aria-label="Direct link to Precedence" title="Direct link to Precedence">​</a></h2>
<p>Environment variables <a href="#configure-variables-env-file">defined in the .env file</a> take precedence over those <a href="#configure-variables-terminal">set in your terminal</a>.
That means, if you happen to set the same environment variable in both your terminal and your <code>.env</code> file, Langflow adopts the value from the the <code>.env</code> file.</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>CLI precedence</div><div class="admonitionContent_BuS1"><p><a href="/configuration-cli">Langflow CLI options</a> override the value of corresponding environment variables defined in the <code>.env</code> file as well as any environment variables set in your terminal.</p></div></div>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="supported-variables">Supported environment variables<a href="#supported-variables" class="hash-link" aria-label="Direct link to Supported environment variables" title="Direct link to Supported environment variables">​</a></h2>
<p>The following table lists the environment variables supported by Langflow.</p>
<table><thead><tr><th>Variable</th><th>Format / Values</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><a id="DO_NOT_TRACK"></a><code>DO_NOT_TRACK</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, Langflow will not track telemetry.</td></tr><tr><td><a id="LANGFLOW_AUTO_LOGIN"></a><code>LANGFLOW_AUTO_LOGIN</code></td><td>Boolean</td><td><code>true</code></td><td>Enable automatic login for Langflow. Set to <code>false</code> to disable automatic login and require the login form to log into the Langflow UI. Setting to <code>false</code> requires <a href="#LANGFLOW_SUPERUSER"><code>LANGFLOW_SUPERUSER</code></a> and <a href="/environment-variables#LANGFLOW_SUPERUSER_PASSWORD"><code>LANGFLOW_SUPERUSER_PASSWORD</code></a> to be set.</td></tr><tr><td><a id="LANGFLOW_AUTO_SAVING"></a><code>LANGFLOW_AUTO_SAVING</code></td><td>Boolean</td><td><code>true</code></td><td>Enable flow auto-saving.<br>See <a href="/configuration-cli#run-auto-saving"><code>--auto-saving</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_AUTO_SAVING_INTERVAL"></a><code>LANGFLOW_AUTO_SAVING_INTERVAL</code></td><td>Integer</td><td><code>1000</code></td><td>Set the interval for flow auto-saving in milliseconds.<br>See <a href="/configuration-cli#run-auto-saving-interval"><code>--auto-saving-interval</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_BACKEND_ONLY"></a><code>LANGFLOW_BACKEND_ONLY</code></td><td>Boolean</td><td><code>false</code></td><td>Only run Langflow&#x27;s backend server (no frontend).<br>See <a href="/configuration-cli#run-backend-only"><code>--backend-only</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_CACHE_TYPE"></a><code>LANGFLOW_CACHE_TYPE</code></td><td><code>async</code><br><code>redis</code><br><code>memory</code><br><code>disk</code><br><code>critical</code></td><td><code>async</code></td><td>Set the cache type for Langflow.<br>If you set the type to <code>redis</code>, then you must also set the following environment variables: <a href="#LANGFLOW_REDIS_HOST"><code>LANGFLOW_REDIS_HOST</code></a>, <a href="#LANGFLOW_REDIS_PORT"><code>LANGFLOW_REDIS_PORT</code></a>, <a href="#LANGFLOW_REDIS_DB"><code>LANGFLOW_REDIS_DB</code></a>, and <a href="#LANGFLOW_REDIS_CACHE_EXPIRE"><code>LANGFLOW_REDIS_CACHE_EXPIRE</code></a>.</td></tr><tr><td><a id="LANGFLOW_COMPONENTS_PATH"></a><code>LANGFLOW_COMPONENTS_PATH</code></td><td>String</td><td><code>langflow/components</code></td><td>Path to the directory containing custom components.<br>See <a href="/configuration-cli#run-components-path"><code>--components-path</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_CONFIG_DIR"></a><code>LANGFLOW_CONFIG_DIR</code></td><td>String</td><td><strong>Linux/WSL</strong>: <code>~/.cache/langflow/</code><br><strong>macOS</strong>: <code>/Users/&lt;username&gt;/Library/Caches/langflow/</code><br><strong>Windows</strong>: <code>%LOCALAPPDATA%\langflow\langflow\Cache</code></td><td>Set the Langflow configuration directory where files, logs, and the Langflow database are stored.</td></tr><tr><td><a id="LANGFLOW_DATABASE_URL"></a><code>LANGFLOW_DATABASE_URL</code></td><td>String</td><td>Not set</td><td>Set the database URL for Langflow. If not provided, Langflow will use a SQLite database.</td></tr><tr><td><a id="LANGFLOW_DATABASE_CONNECTION_RETRY"></a><code>LANGFLOW_DATABASE_CONNECTION_RETRY</code></td><td>Boolean</td><td><code>false</code></td><td>If True, Langflow will retry to connect to the database if it fails.</td></tr><tr><td><a id="LANGFLOW_DB_POOL_SIZE"></a><code>LANGFLOW_DB_POOL_SIZE</code></td><td>Integer</td><td><code>10</code></td><td><strong>DEPRECATED:</strong> Use <code>LANGFLOW_DB_CONNECTION_SETTINGS</code> instead. The number of connections to keep open in the connection pool.</td></tr><tr><td><a id="LANGFLOW_DB_MAX_OVERFLOW"></a><code>LANGFLOW_DB_MAX_OVERFLOW</code></td><td>Integer</td><td><code>20</code></td><td><strong>DEPRECATED:</strong> Use <code>LANGFLOW_DB_CONNECTION_SETTINGS</code> instead. The number of connections to allow that can be opened beyond the pool size.</td></tr><tr><td><a id="LANGFLOW_DB_CONNECT_TIMEOUT"></a><code>LANGFLOW_DB_CONNECT_TIMEOUT</code></td><td>Integer</td><td><code>20</code></td><td>The number of seconds to wait before giving up on a lock to be released or establishing a connection to the database.</td></tr><tr><td><a id="LANGFLOW_DB_CONNECTION_SETTINGS"></a><code>LANGFLOW_DB_CONNECTION_SETTINGS</code></td><td>JSON</td><td>Not set</td><td>A JSON dictionary to centralize database connection parameters. Example: <code>{&quot;pool_size&quot;: 10, &quot;max_overflow&quot;: 20}</code></td></tr><tr><td><a id="LANGFLOW_DEV"></a><code>LANGFLOW_DEV</code></td><td>Boolean</td><td><code>false</code></td><td>Run Langflow in development mode (may contain bugs).<br>See <a href="/configuration-cli#run-dev"><code>--dev</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_FALLBACK_TO_ENV_VAR"></a><code>LANGFLOW_FALLBACK_TO_ENV_VAR</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, <a href="/configuration-global-variables">global variables</a> set in the Langflow UI fall back to an environment variable with the same name when Langflow fails to retrieve the variable value.</td></tr><tr><td><a id="LANGFLOW_FRONTEND_PATH"></a><code>LANGFLOW_FRONTEND_PATH</code></td><td>String</td><td><code>./frontend</code></td><td>Path to the frontend directory containing build files. This is for development purposes only.<br>See <a href="/configuration-cli#run-frontend-path"><code>--frontend-path</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_HEALTH_CHECK_MAX_RETRIES"></a><code>LANGFLOW_HEALTH_CHECK_MAX_RETRIES</code></td><td>Integer</td><td><code>5</code></td><td>Set the maximum number of retries for the health check.<br>See <a href="/configuration-cli#run-health-check-max-retries"><code>--health-check-max-retries</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_HOST"></a><code>LANGFLOW_HOST</code></td><td>String</td><td><code>127.0.0.1</code></td><td>The host on which the Langflow server will run.<br>See <a href="/configuration-cli#run-host"><code>--host</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_LANGCHAIN_CACHE"></a><code>LANGFLOW_LANGCHAIN_CACHE</code></td><td><code>InMemoryCache</code><br><code>SQLiteCache</code></td><td><code>InMemoryCache</code></td><td>Type of cache to use.<br>See <a href="/configuration-cli#run-cache"><code>--cache</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_LOG_LEVEL"></a><code>LANGFLOW_LOG_LEVEL</code></td><td><code>DEBUG</code><br><code>INFO</code><br><code>WARNING</code><br><code>ERROR</code><br><code>CRITICAL</code></td><td><code>INFO</code></td><td>Set the logging level for Langflow.</td></tr><tr><td><a id="LANGFLOW_LOG_FILE"></a><code>LANGFLOW_LOG_FILE</code></td><td>String</td><td>Not set</td><td>Path to the log file. If not set, logs will be written to stdout.</td></tr><tr><td><a id="LANGFLOW_MAX_FILE_SIZE_UPLOAD"></a><code>LANGFLOW_MAX_FILE_SIZE_UPLOAD</code></td><td>Integer</td><td><code>100</code></td><td>Set the maximum file size for the upload in megabytes.<br>See <a href="/configuration-cli#run-max-file-size-upload"><code>--max-file-size-upload</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_MCP_SERVER_ENABLED"></a><code>LANGFLOW_MCP_SERVER_ENABLED</code></td><td>Boolean</td><td><code>true</code></td><td>If set to False, Langflow will not enable the MCP server.</td></tr><tr><td><a id="LANGFLOW_MCP_SERVER_ENABLE_PROGRESS_NOTIFICATIONS"></a><code>LANGFLOW_MCP_SERVER_ENABLE_PROGRESS_NOTIFICATIONS</code></td><td>Boolean</td><td><code>false</code></td><td>If set to True, Langflow will send progress notifications in the MCP server.</td></tr><tr><td><a id="LANGFLOW_NEW_USER_IS_ACTIVE"></a><code>LANGFLOW_NEW_USER_IS_ACTIVE</code></td><td>Boolean</td><td><code>false</code></td><td>When enabled, new users are automatically activated and can log in without requiring explicit activation by the superuser.</td></tr><tr><td><a id="LANGFLOW_OPEN_BROWSER"></a><code>LANGFLOW_OPEN_BROWSER</code></td><td>Boolean</td><td><code>false</code></td><td>Open the system web browser on startup.<br>See <a href="/configuration-cli#run-open-browser"><code>--open-browser</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_PORT"></a><code>LANGFLOW_PORT</code></td><td>Integer</td><td><code>7860</code></td><td>The port on which the Langflow server will run. The server automatically selects a free port if the specified port is in use.<br>See <a href="/configuration-cli#run-port"><code>--port</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_PROMETHEUS_ENABLED"></a><code>LANGFLOW_PROMETHEUS_ENABLED</code></td><td>Boolean</td><td><code>false</code></td><td>Expose Prometheus metrics.</td></tr><tr><td><a id="LANGFLOW_PROMETHEUS_PORT"></a><code>LANGFLOW_PROMETHEUS_PORT</code></td><td>Integer</td><td><code>9090</code></td><td>Set the port on which Langflow exposes Prometheus metrics.</td></tr><tr><td><a id="LANGFLOW_REDIS_CACHE_EXPIRE"></a><code>LANGFLOW_REDIS_CACHE_EXPIRE</code></td><td>Integer</td><td><code>3600</code></td><td>See <a href="#LANGFLOW_CACHE_TYPE"><code>LANGFLOW_CACHE_TYPE</code></a>.</td></tr><tr><td><a id="LANGFLOW_REDIS_DB"></a><code>LANGFLOW_REDIS_DB</code></td><td>Integer</td><td><code>0</code></td><td>See <a href="#LANGFLOW_CACHE_TYPE"><code>LANGFLOW_CACHE_TYPE</code></a>.</td></tr><tr><td><a id="LANGFLOW_REDIS_HOST"></a><code>LANGFLOW_REDIS_HOST</code></td><td>String</td><td><code>localhost</code></td><td>See <a href="#LANGFLOW_CACHE_TYPE"><code>LANGFLOW_CACHE_TYPE</code></a>.</td></tr><tr><td><a id="LANGFLOW_REDIS_PORT"></a><code>LANGFLOW_REDIS_PORT</code></td><td>String</td><td><code>6379</code></td><td>See <a href="#LANGFLOW_CACHE_TYPE"><code>LANGFLOW_CACHE_TYPE</code></a>.</td></tr><tr><td><a id="LANGFLOW_REMOVE_API_KEYS"></a><code>LANGFLOW_REMOVE_API_KEYS</code></td><td>Boolean</td><td><code>false</code></td><td>Remove API keys from the projects saved in the database.<br>See <a href="/configuration-cli#run-remove-api-keys"><code>--remove-api-keys</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_SAVE_DB_IN_CONFIG_DIR"></a><code>LANGFLOW_SAVE_DB_IN_CONFIG_DIR</code></td><td>Boolean</td><td><code>false</code></td><td>Save the Langflow database in <a href="#LANGFLOW_CONFIG_DIR"><code>LANGFLOW_CONFIG_DIR</code></a> instead of in the Langflow package directory. Note, when this variable is set to default (<code>false</code>), the database isn&#x27;t shared between different virtual environments and the database is deleted when you uninstall Langflow.</td></tr><tr><td><a id="LANGFLOW_SECRET_KEY"></a><code>LANGFLOW_SECRET_KEY</code></td><td>String</td><td>Auto-generated</td><td>Key used for encrypting sensitive data like API keys. If not provided, a secure key will be auto-generated. For production environments with multiple instances, you should explicitly set this to ensure consistent encryption across instances.</td></tr><tr><td><a id="LANGFLOW_STORE"></a><code>LANGFLOW_STORE</code></td><td>Boolean</td><td><code>true</code></td><td>Enable the Langflow Store.<br>See <a href="/configuration-cli#run-store"><code>--store</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_STORE_ENVIRONMENT_VARIABLES"></a><code>LANGFLOW_STORE_ENVIRONMENT_VARIABLES</code></td><td>Boolean</td><td><code>true</code></td><td>Store environment variables as <a href="/configuration-global-variables">global variables</a> in the database.</td></tr><tr><td><a id="LANGFLOW_SUPERUSER"></a><code>LANGFLOW_SUPERUSER</code></td><td>String</td><td><code>langflow</code></td><td>Set the name for the superuser. Required if <a href="#LANGFLOW_AUTO_LOGIN"><code>LANGFLOW_AUTO_LOGIN</code></a> is set to <code>false</code>.<br>See <a href="/configuration-cli#superuser-username"><code>superuser --username</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_SUPERUSER_PASSWORD"></a><code>LANGFLOW_SUPERUSER_PASSWORD</code></td><td>String</td><td><code>langflow</code></td><td>Set the password for the superuser. Required if <a href="#LANGFLOW_AUTO_LOGIN"><code>LANGFLOW_AUTO_LOGIN</code></a> is set to <code>false</code>.<br>See <a href="/configuration-cli#superuser-password"><code>superuser --password</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT"></a><code>LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT</code></td><td>String</td><td>Not set</td><td>Comma-separated list of environment variables to get from the environment and store as <a href="/configuration-global-variables">global variables</a>.</td></tr><tr><td><a id="LANGFLOW_LOAD_FLOWS_PATH"></a><code>LANGFLOW_LOAD_FLOWS_PATH</code></td><td>String</td><td>Not set</td><td>Path to a directory containing flow JSON files to be loaded on startup. Note that this feature only works if <code>LANGFLOW_AUTO_LOGIN</code> is enabled.</td></tr><tr><td><a id="LANGFLOW_WORKER_TIMEOUT"></a><code>LANGFLOW_WORKER_TIMEOUT</code></td><td>Integer</td><td><code>300</code></td><td>Worker timeout in seconds.<br>See <a href="/configuration-cli#run-worker-timeout"><code>--worker-timeout</code> option</a>.</td></tr><tr><td><a id="LANGFLOW_WORKERS"></a><code>LANGFLOW_WORKERS</code></td><td>Integer</td><td><code>1</code></td><td>Number of worker processes.<br>See <a href="/configuration-cli#run-workers"><code>--workers</code> option</a>.</td></tr></tbody></table></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/configuration-global-variables"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Global variables</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/configuration-security-best-practices"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Security best practices</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="#configure-variables-terminal" class="table-of-contents__link toc-highlight">Set environment variables in your terminal</a></li><li><a href="#configure-variables-env-file" class="table-of-contents__link toc-highlight">Import environment variables from a .env file</a></li></ul></li><li><a href="#precedence" class="table-of-contents__link toc-highlight">Precedence</a></li><li><a href="#supported-variables" class="table-of-contents__link toc-highlight">Supported environment variables</a></li></ul></div></div></div></div></main></div></div></div><div style="position:fixed;right:20px;bottom:20px;z-index:100;display:flex;align-items:center;gap:10px;cursor:pointer"><div style="background-color:#f6f6f6;border-radius:50%;width:48px;height:48px;display:flex;align-items:center;justify-content:center;box-shadow:0 2px 4px rgba(0,0,0,0.1)"><img src="/img/langflow-icon-black-transparent.svg" style="width:40px" alt="Search"></div></div></div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink