mirror of
https://github.com/datahub-project/datahub.git
synced 2025-08-04 07:18:02 +00:00
113 lines
59 KiB
HTML
113 lines
59 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-docs/deploy/environment-vars" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.3">
|
||
<title data-rh="true">Deployment Environment Variables | DataHub</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.datahub.com/docs/deploy/environment-vars"><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="Deployment Environment Variables | DataHub"><meta data-rh="true" name="description" content="The following is a summary of a few important environment variables which expose various levers which control how"><meta data-rh="true" property="og:description" content="The following is a summary of a few important environment variables which expose various levers which control how"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/deploy/environment-vars"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/deploy/environment-vars" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/deploy/environment-vars" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://RK0UG797F3-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/learn/rss.xml" title="DataHub RSS Feed">
|
||
<link rel="alternate" type="application/atom+xml" href="/learn/atom.xml" title="DataHub Atom Feed">
|
||
|
||
<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-PKGVLETT4C"></script>
|
||
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-PKGVLETT4C",{})</script>
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script>window.dataLayer=window.dataLayer||[]</script>
|
||
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-5M8T9HNN",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script>
|
||
|
||
|
||
<link rel="search" type="application/opensearchdescription+xml" title="DataHub" href="/opensearch.xml">
|
||
|
||
|
||
|
||
|
||
<meta httpequiv="Content-Security-Policy" content="frame-ancestors 'self' https://*.acryl.io https://acryldata.io http://localhost:*">
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Manrope:wght@400;500;700&display=swap">
|
||
<script src="https://tools.luckyorange.com/core/lo.js?site-id=28ea8a38" async defer="defer"></script>
|
||
<script src="/scripts/rb2b.js" async defer="defer"></script>
|
||
<script src="https://app.revenuehero.io/scheduler.min.js"></script>
|
||
<script src="https://tag.clearbitscripts.com/v1/pk_2e321cabe30432a5c44c0424781aa35f/tags.js" referrerpolicy="strict-origin-when-cross-origin"></script>
|
||
<script src="/scripts/reo.js"></script>
|
||
<script id="runllm-widget-script" type="module" src="https://widget.runllm.com" crossorigin="true" runllm-name="DataHub" runllm-assistant-id="81" runllm-position="BOTTOM_RIGHT" runllm-keyboard-shortcut="Mod+j" runllm-preset="docusaurus" runllm-theme-color="#1890FF" runllm-brand-logo="https://docs.datahub.com/img/datahub-logo-color-mark.svg" runllm-community-url="https://datahub.com/slack" runllm-community-type="slack" runllm-disable-ask-a-person="true" async></script><link rel="stylesheet" href="/assets/css/styles.d8fe2eb8.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.8ae4198a.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.9d79f7e2.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5M8T9HNN" 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(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</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><div class="announcementBar_mb4j" style="background-color:transparent;color:#ffffff" role="banner"><div class="content_knG7 announcementBarContent_xLdY"><div class="shimmer-banner"><p>DataHub Secures $35 Million Series B</p><a href="https://datahub.com/news/series-b-announcement/" target="_blank" class="button"><div>Read the announcement<span> →</span></div></a></div></div></div><nav aria-label="Main" class="navbar navbar--fixed-top"><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 href="https://datahub.com" target="_blank" rel="noopener noreferrer" class="navbar__brand"><div class="navbar__logo"><img src="/img/datahub-logo-color-light-horizontal.svg" alt="DataHub Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/datahub-logo-color-dark-horizontal.svg" alt="DataHub Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link versionNavItem_cbn8">Next</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/deploy/environment-vars">Next</a></li><li><a class="dropdown__link" href="/docs/1.1.0/deploy/environment-vars">1.1.0</a></li><li><hr class="dropdown-separator" style="margin: 0.4rem;"></li><li><div class="dropdown__link"><b>Archived versions</b></div></li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/features">1.0.0
|
||
<svg width="12" height="12" aria-hidden="true" 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"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/0.15.0/features">0.15.0
|
||
<svg width="12" height="12" aria-hidden="true" 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"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-8jkm4uler-acryldata.vercel.app/docs/0.14.1/features">0.14.1
|
||
<svg width="12" height="12" aria-hidden="true" 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"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-eue2qafvn-acryldata.vercel.app/docs/features">0.14.0
|
||
<svg width="12" height="12" aria-hidden="true" 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"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-psat3nzgi-acryldata.vercel.app/docs/features">0.13.1
|
||
<svg width="12" height="12" aria-hidden="true" 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"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-lzxh86531-acryldata.vercel.app/docs/features">0.13.0
|
||
<svg width="12" height="12" aria-hidden="true" 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"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-2uuxmgza2-acryldata.vercel.app/docs/features">0.12.1
|
||
<svg width="12" height="12" aria-hidden="true" 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"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-irpoe2osc-acryldata.vercel.app/docs/features">0.11.0
|
||
<svg width="12" height="12" aria-hidden="true" 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"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-1gv2yzn9d-acryldata.vercel.app/docs/features">0.10.5
|
||
<svg width="12" height="12" aria-hidden="true" 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"></path></svg>
|
||
</a>
|
||
</li></ul></div></div><div class="navbar__items navbar__items--right"><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs">Docs</a><a class="navbar__item navbar__link" href="/integrations">Integrations</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Learn</a><ul class="dropdown__menu dropdown__menu_Z8FC"><div class="wrapper_kp81"><div><a href="https://datahub.com/weekly-demo" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-join-slack.png" alt="Weekly Demo"></div><div class="title_c7DP">Weekly Demo</div></a></div><div><a href="https://datahub.com/use-cases" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-forum.png" alt="Use Cases"></div><div class="title_c7DP">Use Cases</div></a></div><div><a href="httpps://datahub.com/adoption-stories" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-events.png" alt="Adoption Stories"></div><div class="title_c7DP">Adoption Stories</div></a></div><div><a href="https://medium.com/datahub-project" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-champions.png" alt="Blog"></div><div class="title_c7DP">Blog</div></a></div><div><a href="https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-share-your-journey.png" alt="Youtube"></div><div class="title_c7DP">Youtube</div></a></div></div></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu dropdown__menu_Z8FC"><div class="wrapper_kp81"><div><a href="https://datahub.com/slack/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-join-slack.png" alt="Join Slack"></div><div class="title_c7DP">Join Slack</div></a></div><div><a href="https://datahub.com/events" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-events.png" alt="Events"></div><div class="title_c7DP">Events</div></a></div><div><a href="https://datahub.com/champions/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-champions.png" alt="Champions"></div><div class="title_c7DP">Champions</div></a></div><div><a href="https://datahub.com/share-your-journey/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-share-your-journey.png" alt="Share Your Journey"></div><div class="title_c7DP">Share Your Journey</div></a></div></div></ul></div><a href="https://datahub.com/products/why-datahub-cloud/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.cloud-cta {
|
||
color: var(--ifm-menu-color-active);
|
||
font-weight: 600;
|
||
background: linear-gradient(40deg, var(--ifm-menu-color-active), var(--ifm-menu-color-active));
|
||
background-size: 200% 100%;
|
||
-webkit-background-clip: text;
|
||
background-clip: text;
|
||
transition: background-image 0.3s ease;
|
||
}
|
||
.cloud-cta:hover {
|
||
color: transparent;
|
||
background: linear-gradient(40deg, var(--ifm-menu-color-active), #ff1493);
|
||
background-size: 200% 100%;
|
||
-webkit-background-clip: text;
|
||
background-clip: text;
|
||
animation: gradientShift 3s ease infinite;
|
||
}
|
||
@keyframes gradientShift {
|
||
0%, 100% { background-position: 0% 50%; }
|
||
50% { background-position: 100% 50%; }
|
||
}
|
||
</style>
|
||
<div class="cloud-cta">Get Cloud</div>
|
||
</a><a href="https://datahub.com/slack?utm_source=docs&utm_medium=header&utm_campaign=docs_header" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.slack-logo:hover {
|
||
opacity: 0.8;
|
||
}
|
||
</style>
|
||
<img class="slack-logo" src="https://upload.wikimedia.org/wikipedia/commons/d/d5/Slack_icon_2019.svg" , alt="slack" , height="20px" style="margin: 10px 0 0 0;">
|
||
</a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><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 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Getting Started</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" aria-expanded="false" href="/docs/features">What Is DataHub?</a><button aria-label="Toggle the collapsible sidebar category 'What Is DataHub?'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" href="/docs/category/features">Features</a><button aria-label="Toggle the collapsible sidebar category 'Features'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>DataHub Cloud</div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/managed-datahub-overview">DataHub Cloud Overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/welcome-acryl">Getting Started with DataHub Cloud</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/upgrade_core_to_cloud">Upgrading from DataHub Core to Cloud</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" aria-expanded="false" href="/docs/authentication/guides/sso/initialize-oidc">Configure Single Sign-On</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" aria-expanded="false" href="/docs/managed-datahub/remote-executor/about">Remote Executor</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" aria-expanded="false" href="/docs/managed-datahub/datahub-api/entity-events-api">DataHub API</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" aria-expanded="false" href="/docs/managed-datahub/slack/saas-slack-app">Slack</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" aria-expanded="false" href="/docs/managed-datahub/operator-guide/setting-up-events-api-on-aws-eventbridge">Operator Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item saasOnly"><a class="menu__link" href="/docs/managed-datahub/approval-workflows">Change Proposals & Approval Workflows</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/chrome-extension">Cloud Chrome Extension</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item saasOnly"><a class="menu__link" href="/docs/managed-datahub/subscription-and-notification">Subscriptions & Notifications</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" aria-expanded="false" href="/docs/managed-datahub/release-notes/v_0_3_12">DataHub Cloud Release History</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Integrations</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" aria-expanded="false" href="/docs/metadata-ingestion">Overview</a><button aria-label="Toggle the collapsible sidebar category 'Overview'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" href="/docs/metadata-ingestion/cli-ingestion">Quickstart Guides</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" aria-expanded="false" href="/docs/metadata-ingestion/source_overview">Sources</a><button aria-label="Toggle the collapsible sidebar category 'Sources'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" href="/docs/metadata-ingestion/schedule_docs/intro">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>API & SDKs</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" aria-expanded="false" href="/docs/metadata-modeling/metadata-model">DataHub's Open Metadata Standard</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="/docs/what-is-datahub/datahub-concepts">Concepts</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" aria-expanded="false" href="/docs/metadata-standards">Metadata Standards</a><button aria-label="Toggle the collapsible sidebar category 'Metadata Standards'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api/datahub-apis">APIs and SDKs Overview</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" aria-expanded="false" href="/docs/api/graphql/overview">API</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" aria-expanded="false" href="/docs/metadata-ingestion/as-a-library">Python SDK</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="/docs/metadata-integration/java/as-a-library">Java SDK</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" aria-expanded="false" href="/docs/cli">DataHub CLI</a><button aria-label="Toggle the collapsible sidebar category 'DataHub CLI'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" href="/docs/act-on-metadata">DataHub Actions</a><button aria-label="Toggle the collapsible sidebar category 'DataHub Actions'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" href="/docs/api/tutorials/datasets">Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Admin</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" aria-expanded="false" href="/docs/authentication">Authentication</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" aria-expanded="false" href="/docs/authorization">Authorization</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" aria-expanded="false" href="/docs/how/delete-metadata">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Deployment</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" aria-expanded="false" href="/docs/category/deployment-guides">Deployment Guides</a><button aria-label="Toggle the collapsible sidebar category 'Deployment Guides'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="true" href="/docs/deploy/confluent-cloud">Advanced Guides</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="/docs/deploy/confluent-cloud">Integrating with Confluent Cloud</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="/docs/deploy/environment-vars">Deployment 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="/docs/how/extract-container-logs">How to Extract Logs from DataHub Containers</a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Developers</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" aria-expanded="false" href="/docs/architecture/architecture">Architecture</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" aria-expanded="false" href="/docs/developers">Developing on DataHub</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" aria-expanded="false" href="/docs/advanced/mcp-mcl">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Community</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" aria-expanded="false" href="/docs/category/community">Community</a><button aria-label="Toggle the collapsible sidebar category 'Community'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" href="/docs/releases">Release History</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><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">Advanced Guides</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">Deployment Environment Variables</span><meta itemprop="position" content="2"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: Next</span><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"><h1>Environment Variables</h1><p>The following is a summary of a few important environment variables which expose various levers which control how
|
||
DataHub works.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="feature-flags">Feature Flags<a href="#feature-flags" class="hash-link" aria-label="Direct link to Feature Flags" title="Direct link to Feature Flags"></a></h2><table><thead><tr><th>Variable</th><th>Default</th><th>Unit/Type</th><th>Components</th><th>Description</th></tr></thead><tbody><tr><td><code>UI_INGESTION_ENABLED</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>, <code>MCE Consumer</code>]</td><td>Enable UI based ingestion.</td></tr><tr><td><code>DATAHUB_ANALYTICS_ENABLED</code></td><td><code>true</code></td><td>boolean</td><td>[<code>Frontend</code>, <code>GMS</code>]</td><td>Collect DataHub usage to populate the analytics dashboard.</td></tr><tr><td><code>BOOTSTRAP_SYSTEM_UPDATE_WAIT_FOR_SYSTEM_UPDATE</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>, <code>MCE Consumer</code>, <code>MAE Consumer</code>]</td><td>Do not wait for the <code>system-update</code> to complete before starting. This should typically only be disabled during development.</td></tr><tr><td><code>ER_MODEL_RELATIONSHIP_FEATURE_ENABLED</code></td><td><code>false</code></td><td>boolean</td><td>[<code>Frontend</code>, <code>GMS</code>]</td><td>Enable ER Model Relation Feature that shows Relationships Tab within a Dataset UI.</td></tr><tr><td><code>STRICT_URN_VALIDATION_ENABLED</code></td><td><code>false</code></td><td>boolean</td><td>[<code>GMS</code>, <code>MCE Consumer</code>, <code>MAE Consumer</code>]</td><td>Enable stricter URN validation logic</td></tr><tr><td><code>SHOW_MANAGE_STRUCTURED_PROPERTIES</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Controls whether the Structured Properties page is visible and accessible via the UI.</td></tr><tr><td><code>SCHEMA_FIELD_CLL_ENABLED</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Controls whether the Column-level lineage focus view is accessible via the lineage Graph.</td></tr><tr><td><code>SCHEMA_FIELD_LINEAGE_IGNORE_STATUS</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Controls whether lineage ignores the schema field status aspect, reading the parent's status aspect instead.</td></tr><tr><td><code>HIDE_DBT_SOURCE_IN_LINEAGE</code></td><td><code>false</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Hides dbt source entities from lineage graphs when used with specific dbt ingestion settings.</td></tr><tr><td><code>SHOW_NAV_BAR_REDESIGN</code></td><td><code>false</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Enables the new navigation bar redesign.</td></tr><tr><td><code>SHOW_MANAGE_TAGS</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Enables the manage tags page.</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="ingestion">Ingestion<a href="#ingestion" class="hash-link" aria-label="Direct link to Ingestion" title="Direct link to Ingestion"></a></h2><table><thead><tr><th>Variable</th><th>Default</th><th>Unit/Type</th><th>Components</th><th>Description</th><th></th></tr></thead><tbody><tr><td><code>ASYNC_INGEST_DEFAULT</code></td><td><code>false</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Asynchronously process ingestProposals by writing the ingestion MCP to Kafka. Typically enabled with standalone consumers.</td><td></td></tr><tr><td><code>MCP_CONSUMER_ENABLED</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>, <code>MCE Consumer</code>]</td><td>When running in standalone mode, disabled on <code>GMS</code> and enabled on separate <code>MCE Consumer</code>.</td><td></td></tr><tr><td><code>MCL_CONSUMER_ENABLED</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>, <code>MAE Consumer</code>]</td><td>When running in standalone mode, disabled on <code>GMS</code> and enabled on separate <code>MAE Consumer</code>.</td><td></td></tr><tr><td><code>PE_CONSUMER_ENABLED</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>, <code>MAE Consumer</code>]</td><td>When running in standalone mode, disabled on <code>GMS</code> and enabled on separate <code>MAE Consumer</code>.</td><td></td></tr><tr><td><code>ES_BULK_REQUESTS_LIMIT</code></td><td>1000</td><td>docs</td><td>[<code>GMS</code>, <code>MAE Consumer</code>]</td><td>Number of bulk documents to index. <code>MAE Consumer</code> if standalone.</td><td></td></tr><tr><td><code>ES_BULK_FLUSH_PERIOD</code></td><td>1</td><td>seconds</td><td>[<code>GMS</code>, <code>MAE Consumer</code>]</td><td>How frequently indexed documents are made available for query.</td><td></td></tr><tr><td><code>ALWAYS_EMIT_CHANGE_LOG</code></td><td><code>false</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Enables always emitting a MCL even when no changes are detected. Used for Time Based Lineage when no changes occur.</td><td></td></tr><tr><td><code>GRAPH_SERVICE_DIFF_MODE_ENABLED</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Enables diff mode for graph writes, uses a different code path that produces a diff from previous to next to write relationships instead of wholesale deleting edges and reading.</td><td></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="caching">Caching<a href="#caching" class="hash-link" aria-label="Direct link to Caching" title="Direct link to Caching"></a></h2><table><thead><tr><th>Variable</th><th>Default</th><th>Unit/Type</th><th>Components</th><th>Description</th></tr></thead><tbody><tr><td><code>SEARCH_SERVICE_ENABLE_CACHE</code></td><td><code>false</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Enable caching of search results.</td></tr><tr><td><code>SEARCH_SERVICE_CACHE_IMPLEMENTATION</code></td><td>caffeine</td><td>string</td><td>[<code>GMS</code>]</td><td>Set to <code>hazelcast</code> if the number of GMS replicas > 1 for enabling distributed cache.</td></tr><tr><td><code>CACHE_TTL_SECONDS</code></td><td>600</td><td>seconds</td><td>[<code>GMS</code>]</td><td>Default cache time to live.</td></tr><tr><td><code>CACHE_MAX_SIZE</code></td><td>10000</td><td>objects</td><td>[<code>GMS</code>]</td><td>Maximum number of items to cache.</td></tr><tr><td><code>LINEAGE_SEARCH_CACHE_ENABLED</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Enables in-memory cache for searchAcrossLineage query.</td></tr><tr><td><code>CACHE_ENTITY_COUNTS_TTL_SECONDS</code></td><td>600</td><td>seconds</td><td>[<code>GMS</code>]</td><td>Homepage entity count time to live.</td></tr><tr><td><code>CACHE_SEARCH_LINEAGE_TTL_SECONDS</code></td><td>86400</td><td>seconds</td><td>[<code>GMS</code>]</td><td>Search lineage cache time to live.</td></tr><tr><td><code>CACHE_SEARCH_LINEAGE_LIGHTNING_THRESHOLD</code></td><td>300</td><td>objects</td><td>[<code>GMS</code>]</td><td>Lineage graphs exceeding this limit will use a local cache.</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="search">Search<a href="#search" class="hash-link" aria-label="Direct link to Search" title="Direct link to Search"></a></h2><table><thead><tr><th>Variable</th><th>Default</th><th>Unit/Type</th><th>Components</th><th>Description</th></tr></thead><tbody><tr><td><code>INDEX_PREFIX</code></td><td>``</td><td>string</td><td>[<code>GMS</code>, <code>MAE Consumer</code>, <code>Elasticsearch Setup</code>, <code>System Update</code>]</td><td>Prefix Elasticsearch indices with the given string.</td></tr><tr><td><code>ELASTICSEARCH_NUM_SHARDS_PER_INDEX</code></td><td>1</td><td>integer</td><td>[<code>System Update</code>]</td><td>Default number of shards per Elasticsearch index.</td></tr><tr><td><code>ELASTICSEARCH_NUM_REPLICAS_PER_INDEX</code></td><td>1</td><td>integer</td><td>[<code>System Update</code>]</td><td>Default number of replica per Elasticsearch index.</td></tr><tr><td><code>ELASTICSEARCH_BUILD_INDICES_RETENTION_VALUE</code></td><td>60</td><td>integer</td><td>[<code>System Update</code>]</td><td>Number of units for the retention of Elasticsearch clone/backup indices.</td></tr><tr><td><code>ELASTICSEARCH_BUILD_INDICES_RETENTION_UNIT</code></td><td>DAYS</td><td>string</td><td>[<code>System Update</code>]</td><td>Unit for the retention of Elasticsearch clone/backup indices.</td></tr><tr><td><code>ELASTICSEARCH_QUERY_EXACT_MATCH_EXCLUSIVE</code></td><td><code>false</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Only return exact matches when using quotes.</td></tr><tr><td><code>ELASTICSEARCH_QUERY_EXACT_MATCH_WITH_PREFIX</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Include prefix match in exact match results.</td></tr><tr><td><code>ELASTICSEARCH_QUERY_EXACT_MATCH_FACTOR</code></td><td>10.0</td><td>float</td><td>[<code>GMS</code>]</td><td>Multiply by this number on true exact match.</td></tr><tr><td><code>ELASTICSEARCH_QUERY_EXACT_MATCH_PREFIX_FACTOR</code></td><td>1.6</td><td>float</td><td>[<code>GMS</code>]</td><td>Multiply by this number when prefix match.</td></tr><tr><td><code>ELASTICSEARCH_QUERY_EXACT_MATCH_CASE_FACTOR</code></td><td>0.7</td><td>float</td><td>[<code>GMS</code>]</td><td>Multiply by this number when case insensitive match.</td></tr><tr><td><code>ELASTICSEARCH_QUERY_EXACT_MATCH_ENABLE_STRUCTURED</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>When using structured query, also include exact matches.</td></tr><tr><td><code>ELASTICSEARCH_QUERY_PARTIAL_URN_FACTOR</code></td><td>0.5</td><td>float</td><td>[<code>GMS</code>]</td><td>Multiply by this number when partial token match on URN)</td></tr><tr><td><code>ELASTICSEARCH_QUERY_PARTIAL_FACTOR</code></td><td>0.4</td><td>float</td><td>[<code>GMS</code>]</td><td>Multiply by this number when partial token match on non-URN field.</td></tr><tr><td><code>ELASTICSEARCH_QUERY_CUSTOM_CONFIG_ENABLED</code></td><td><code>true</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Enable search query and ranking customization configuration.</td></tr><tr><td><code>ELASTICSEARCH_QUERY_CUSTOM_CONFIG_FILE</code></td><td><code>search_config.yml</code></td><td>string</td><td>[<code>GMS</code>]</td><td>The location of the search customization configuration.</td></tr><tr><td><code>ELASTICSEARCH_INDEX_BUILDER_MAPPINGS_REINDEX</code></td><td><code>false</code></td><td>boolean</td><td>[<code>System Update</code>]</td><td>Enable reindexing on Elasticsearch schema changes.</td></tr><tr><td><code>ENABLE_STRUCTURED_PROPERTIES_SYSTEM_UPDATE</code></td><td><code>false</code></td><td>boolean</td><td>[<code>System Update</code>]</td><td>Enable reindexing to remove hard deleted structured properties.</td></tr><tr><td><code>ELASTICSEARCH_LIMIT_RESULTS_MAX</code></td><td>2000</td><td>integer</td><td>[<code>GMS</code>]</td><td>Maximum search results per page.</td></tr><tr><td><code>ELASTICSEARCH_LIMIT_RESULTS_STRICT</code></td><td><code>false</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>If <code>false</code>, reduce the page size to the maximum rathen then throw an exception is the request exceeds the maximum value.</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="entities-and-versions">Entities and Versions<a href="#entities-and-versions" class="hash-link" aria-label="Direct link to Entities and Versions" title="Direct link to Entities and Versions"></a></h2><table><thead><tr><th>Variable</th><th>Default</th><th>Unit/Type</th><th>Components</th><th>Description</th></tr></thead><tbody><tr><td><code>ENTITY_VERSIONING_ENABLED</code></td><td><code>false</code></td><td>boolean</td><td>[<code>GMS</code>, <code>MCE Consumer</code>, <code>MAE Consumer</code>]</td><td>Enables entity versioning related resolvers, validators, side effects, etc. to support versioned entities.</td></tr><tr><td><code>ALTERNATE_MCP_VALIDATION</code></td><td><code>false</code></td><td>boolean</td><td>[<code>GMS</code>]</td><td>Enables an alternate MCP validation pathway for MCPs that should be validated only after applying a mutation hook.</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="kafka">Kafka<a href="#kafka" class="hash-link" aria-label="Direct link to Kafka" title="Direct link to Kafka"></a></h2><p>In general, there are <strong>lots</strong> of Kafka configuration environment variables for both the producer and consumers defined in the official Spring Kafka documentation <a href="https://docs.spring.io/spring-boot/docs/2.7.10/reference/html/application-properties.html#appendix.application-properties.integration" target="_blank" rel="noopener noreferrer">here</a>.
|
||
These environment variables follow the standard Spring representation of properties as environment variables.
|
||
Simply replace the dot, <code>.</code>, with an underscore, <code>_</code>, and convert to uppercase.</p><table><thead><tr><th>Variable</th><th>Default</th><th>Unit/Type</th><th>Components</th><th>Description</th></tr></thead><tbody><tr><td><code>KAFKA_LISTENER_CONCURRENCY</code></td><td>1</td><td>integer</td><td>[<code>GMS</code>, <code>MCE Consumer</code>, <code>MAE Consumer</code>]</td><td>Number of Kafka consumer threads. Optimize throughput by matching to topic partitions.</td></tr><tr><td><code>SPRING_KAFKA_PRODUCER_PROPERTIES_MAX_REQUEST_SIZE</code></td><td>1048576</td><td>bytes</td><td>[<code>GMS</code>, <code>MCE Consumer</code>, <code>MAE Consumer</code>]</td><td>Max produced message size. Note that the topic configuration is not controlled by this variable.</td></tr><tr><td><code>SCHEMA_REGISTRY_TYPE</code></td><td><code>INTERNAL</code></td><td>string</td><td>[<code>GMS</code>, <code>MCE Consumer</code>, <code>MAE Consumer</code>]</td><td>Schema registry implementation. One of <code>INTERNAL</code> or <code>KAFKA</code> or <code>AWS_GLUE</code></td></tr><tr><td><code>KAFKA_SCHEMAREGISTRY_URL</code></td><td><code>http://localhost:8080/schema-registry/api/</code></td><td>string</td><td>[<code>GMS</code>, <code>MCE Consumer</code>, <code>MAE Consumer</code>]</td><td>Schema registry url. Used for <code>INTERNAL</code> and <code>KAFKA</code>. The default value is for the <code>GMS</code> component. The <code>MCE Consumer</code> and <code>MAE Consumer</code> should be the <code>GMS</code> hostname and port.</td></tr><tr><td><code>AWS_GLUE_SCHEMA_REGISTRY_REGION</code></td><td><code>us-east-1</code></td><td>string</td><td>[<code>GMS</code>, <code>MCE Consumer</code>, <code>MAE Consumer</code>]</td><td>If using <code>AWS_GLUE</code> in the <code>SCHEMA_REGISTRY_TYPE</code> variable for the schema registry implementation.</td></tr><tr><td><code>AWS_GLUE_SCHEMA_REGISTRY_NAME</code></td><td>``</td><td>string</td><td>[<code>GMS</code>, <code>MCE Consumer</code>, <code>MAE Consumer</code>]</td><td>If using <code>AWS_GLUE</code> in the <code>SCHEMA_REGISTRY_TYPE</code> variable for the schema registry.</td></tr><tr><td><code>USE_CONFLUENT_SCHEMA_REGISTRY</code></td><td><code>true</code></td><td>boolean</td><td>[<code>kafka-setup</code>]</td><td>Enable Confluent schema registry configuration.</td></tr><tr><td><code>KAFKA_PRODUCER_MAX_REQUEST_SIZE</code></td><td><code>5242880</code></td><td>integer</td><td>[<code>Frontend</code>, <code>GMS</code>, <code>MCE Consumer</code>, <code>MAE Consumer</code>]</td><td>Max produced message size. Note that the topic configuration is not controlled by this variable.</td></tr><tr><td><code>KAFKA_CONSUMER_MAX_PARTITION_FETCH_BYTES</code></td><td><code>5242880</code></td><td>integer</td><td>[<code>GMS</code>, <code>MCE Consumer</code>, <code>MAE Consumer</code>]</td><td>The maximum amount of data per-partition the server will return. Records are fetched in batches by the consumer. If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress.</td></tr><tr><td><code>MAX_MESSAGE_BYTES</code></td><td><code>5242880</code></td><td>integer</td><td>[<code>kafka-setup</code>]</td><td>Sets the max message size on the kakfa topics.</td></tr><tr><td><code>KAFKA_PRODUCER_COMPRESSION_TYPE</code></td><td><code>snappy</code></td><td>string</td><td>[<code>Frontend</code>, <code>GMS</code>, <code>MCE Consumer</code>, <code>MAE Consumer</code>]</td><td>The compression used by the producer.</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="backend">Backend<a href="#backend" class="hash-link" aria-label="Direct link to Backend" title="Direct link to Backend"></a></h2><table><thead><tr><th>Variable</th><th>Default</th><th>Unit/Type</th><th>Components</th><th>Description</th></tr></thead><tbody><tr><td><code>ENTITY_CLIENT_RESTLI_GET_BATCH_CONCURRENCY</code></td><td><code>2</code></td><td>integer</td><td>[<code>GMS</code>]</td><td>Number of concurrent rest.li calls when the number of urns in a getBatchV2 call exceeds the batch size of 50.</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="frontend">Frontend<a href="#frontend" class="hash-link" aria-label="Direct link to Frontend" title="Direct link to Frontend"></a></h2><table><thead><tr><th>Variable</th><th>Default</th><th>Unit/Type</th><th>Components</th><th>Description</th></tr></thead><tbody><tr><td><code>AUTH_VERBOSE_LOGGING</code></td><td><code>false</code></td><td>boolean</td><td>[<code>Frontend</code>]</td><td>Enable verbose authentication logging. Enabling this will leak sensisitve information in the logs. Disable when finished debugging.</td></tr><tr><td><code>AUTH_OIDC_GROUPS_CLAIM</code></td><td><code>groups</code></td><td>string</td><td>[<code>Frontend</code>]</td><td>Claim to use as the user's group.</td></tr><tr><td><code>AUTH_OIDC_EXTRACT_GROUPS_ENABLED</code></td><td><code>false</code></td><td>boolean</td><td>[<code>Frontend</code>]</td><td>Auto-provision the group from the user's group claim.</td></tr><tr><td><code>AUTH_SESSION_TTL_HOURS</code></td><td><code>24</code></td><td>string</td><td>[<code>Frontend</code>]</td><td>The number of hours a user session is valid. After this many hours the actor cookie will be expired by the browser and the user will be prompted to login again.</td></tr><tr><td><code>MAX_SESSION_TOKEN_AGE</code></td><td><code>24h</code></td><td>string</td><td>[<code>Frontend</code>]</td><td>The maximum age of the session token. <a href="https://www.playframework.com/documentation/2.8.x/SettingsSession#Session-Timeout-/-Expiration" target="_blank" rel="noopener noreferrer">User session tokens are stateless and will become invalid after this time</a> requiring a user to login again.</td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="slackUtm_uoBr"><div class="slackUtm_uoBr"><hr>Need more help? Join the conversation in <a href="https://datahub.com/slack?utm_source=docs&utm_medium=footer&utm_campaign=docs_footer&utm_content=docs/deploy/environment-vars">Slack!</a></div></div><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/datahub-project/datahub/blob/master/docs/deploy/environment-vars.md" target="_blank" rel="noreferrer noopener" 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_VsjB"></div></div></footer><div class="feedbackWrapper_mUHF"><div class="feedbackWidget_PX4d"><div class="feedbackButtons_wn3V"><strong>Is this page helpful?</strong><div><button class="feedbackButton_UgQs"><span role="img" aria-label="like" class="anticon anticon-like"><svg viewBox="64 64 896 896" focusable="false" data-icon="like" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 533.7c16.8-22.2 26.1-49.4 26.1-77.7 0-44.9-25.1-87.4-65.5-111.1a67.67 67.67 0 00-34.3-9.3H572.4l6-122.9c1.4-29.7-9.1-57.9-29.5-79.4A106.62 106.62 0 00471 99.9c-52 0-98 35-111.8 85.1l-85.9 311H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h601.3c9.2 0 18.2-1.8 26.5-5.4 47.6-20.3 78.3-66.8 78.3-118.4 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7-.2-12.6-2-25.1-5.6-37.1zM184 852V568h81v284h-81zm636.4-353l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 22.4-13.2 42.6-33.6 51.8H329V564.8l99.5-360.5a44.1 44.1 0 0142.2-32.3c7.6 0 15.1 2.2 21.1 6.7 9.9 7.4 15.2 18.6 14.6 30.5l-9.6 198.4h314.4C829 418.5 840 436.9 840 456c0 16.5-7.2 32.1-19.6 43z"></path></svg></span></button><button class="feedbackButton_UgQs"><span role="img" aria-label="dislike" class="anticon anticon-dislike"><svg viewBox="64 64 896 896" focusable="false" data-icon="dislike" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 490.3c3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-51.6-30.7-98.1-78.3-118.4a66.1 66.1 0 00-26.5-5.4H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h129.3l85.8 310.8C372.9 889 418.9 924 470.9 924c29.7 0 57.4-11.8 77.9-33.4 20.5-21.5 31-49.7 29.5-79.4l-6-122.9h239.9c12.1 0 23.9-3.2 34.3-9.3 40.4-23.5 65.5-66.1 65.5-111 0-28.3-9.3-55.5-26.1-77.7zM184 456V172h81v284h-81zm627.2 160.4H496.8l9.6 198.4c.6 11.9-4.7 23.1-14.6 30.5-6.1 4.5-13.6 6.8-21.1 6.7a44.28 44.28 0 01-42.2-32.3L329 459.2V172h415.4a56.85 56.85 0 0133.6 51.8c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-14 25.5 21.9 19a56.76 56.76 0 0119.6 43c0 19.1-11 37.5-28.8 48.4z"></path></svg></span></button></div></div></div></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/deploy/confluent-cloud"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Integrating with Confluent Cloud</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/how/extract-container-logs"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">How to Extract Logs from DataHub Containers</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="#feature-flags" class="table-of-contents__link toc-highlight">Feature Flags</a></li><li><a href="#ingestion" class="table-of-contents__link toc-highlight">Ingestion</a></li><li><a href="#caching" class="table-of-contents__link toc-highlight">Caching</a></li><li><a href="#search" class="table-of-contents__link toc-highlight">Search</a></li><li><a href="#entities-and-versions" class="table-of-contents__link toc-highlight">Entities and Versions</a></li><li><a href="#kafka" class="table-of-contents__link toc-highlight">Kafka</a></li><li><a href="#backend" class="table-of-contents__link toc-highlight">Backend</a></li><li><a href="#frontend" class="table-of-contents__link toc-highlight">Frontend</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/quickstart">Quickstart</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://datahub.com/slack" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></svg></a></li><li class="footer__item"><a href="https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" target="_blank" rel="noopener noreferrer" class="footer__link-item">YouTube<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></svg></a></li><li class="footer__item"><a href="https://medium.com/datahub-project" target="_blank" rel="noopener noreferrer" class="footer__link-item">Blog<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/townhalls">Town Halls</a></li><li class="footer__item"><a href="https://datahub.com/adoption-stories/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Adoption<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://demo.datahub.com/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Demo</a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/roadmap" target="_blank" rel="noopener noreferrer" class="footer__link-item">Roadmap<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/datahub-project/datahub" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></svg></a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Feature Requests<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2015-2025 DataHub Project Authors.</div></div></div></footer></div>
|
||
<script src="/assets/js/runtime~main.8ae4198a.js"></script>
|
||
<script src="/assets/js/main.9d79f7e2.js"></script>
|
||
</body>
|
||
</html> |