| <!doctype html> |
| <html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-deploy-environment-variables"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="generator" content="Docusaurus v2.4.1"> |
| <title data-rh="true">Environment Variables | Apache StreamPipes</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:image" content="https://streampipes.apache.org/img/favicon.png"><meta data-rh="true" name="twitter:image" content="https://streampipes.apache.org/img/favicon.png"><meta data-rh="true" property="og:url" content="https://streampipes.apache.org/docs/next/deploy-environment-variables/"><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 | Apache StreamPipes"><meta data-rh="true" name="description" content="Introduction"><meta data-rh="true" property="og:description" content="Introduction"><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://streampipes.apache.org/docs/next/deploy-environment-variables/"><link data-rh="true" rel="alternate" href="https://streampipes.apache.org/docs/next/deploy-environment-variables/" hreflang="en"><link data-rh="true" rel="alternate" href="https://streampipes.apache.org/docs/next/deploy-environment-variables/" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache StreamPipes RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache StreamPipes Atom Feed"> |
| |
| |
| |
| <link rel="preconnect" href="//analytics.apache.org/"> |
| <script>var _paq=window._paq=window._paq||[];_paq.push(["disableCookies"]),_paq.push(["trackPageView"]),_paq.push(["enableLinkTracking"]),function(){var a="//analytics.apache.org/";_paq.push(["setTrackerUrl",a+"matomo.php"]),_paq.push(["setSiteId","35"]);var e=document,p=e.createElement("script"),t=e.getElementsByTagName("script")[0];p.type="text/javascript",p.async=!0,p.src=a+"matomo.js",t.parentNode.insertBefore(p,t)}()</script> |
| |
| |
| <link rel="stylesheet" href="/css/slick.min.css"> |
| <link rel="stylesheet" href="/css/slick-theme.min.css"> |
| <link rel="stylesheet" href="/css/fonts.css"> |
| <link rel="stylesheet" href="/css/admonition.css"> |
| <link rel="stylesheet" href="/css/custom.css"> |
| <link rel="stylesheet" href="/css/code-block-buttons.css"> |
| <link rel="stylesheet" href="/css/all.min.css"> |
| <link rel="stylesheet" href="/css/bootstrap.min.css"> |
| <link rel="stylesheet" href="/css/buttons.css"> |
| <link rel="stylesheet" href="/css/team.css"> |
| <link rel="stylesheet" href="/css/custom-website.css"> |
| <link rel="stylesheet" href="/css/page-banner.css"> |
| <link rel="stylesheet" href="/css/responsive.css"> |
| <script src="/js/jquery-3.3.1.min.js"></script> |
| <script src="/js/buttons.js"></script> |
| <script src="/js/slick.min.js"></script> |
| <script src="/js/custom.js"></script> |
| <script src="/js/clipboard.min.js"></script> |
| <script src="/js/code-block-buttons.js"></script><link rel="stylesheet" href="/assets/css/styles.a4107cef.css"> |
| <link rel="preload" href="/assets/js/runtime~main.d38cef4e.js" as="script"> |
| <link rel="preload" href="/assets/js/main.6ee83347.js" as="script"> |
| </head> |
| <body class="navigation-with-keyboard"> |
| <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:var(--color-accent);color:white" role="banner"><div class="content_knG7 announcementBarContent_xLdY">Apache StreamPipes 0.97.0 is available! ⭐️</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 class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/sp-logo-color.png" alt="Apache StreamPipes" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/sp-logo-color.png" alt="Apache StreamPipes" class="themedImage_ToTc themedImage--dark_i4oU"></div></a></div><div class="navbar__items navbar__items--right"><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/">Home</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Docs</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/user-guide-introduction/">Apache StreamPipes - User Guide</a></li><li><a href="https://streampipes.apache.org/docs/docs/python/latest/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Apache StreamPipes - Python</a></li><li><a class="dropdown__link" href="/docs/faq-common-problems/">FAQ</a></li></ul></div><a class="navbar__item navbar__link" href="/download/">Download</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Resources</a><ul class="dropdown__menu"><li><a href="https://github.com/apache/streampipes/issues" target="_blank" rel="noopener noreferrer" class="dropdown__link">Issue Tracker<svg width="12" height="12" 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><a href="https://github.com/apache/streampipes/discussions" target="_blank" rel="noopener noreferrer" class="dropdown__link">Github Discussions Support<svg width="12" height="12" 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><a href="http://cwiki.apache.org/confluence/display/STREAMPIPES" target="_blank" rel="noopener noreferrer" class="dropdown__link">Developer wiki<svg width="12" height="12" 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><a class="dropdown__link" href="/resources/slides-videos/">Slides & Videos</a></li></ul></div><a class="navbar__item navbar__link" href="/blog/">Blog</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/community/mailing-lists/">Mailing Lists</a></li><li><a class="dropdown__link" href="/community/team/">Team</a></li><li><a class="dropdown__link" href="/community/get-involved/">Get involved</a></li><li><a class="dropdown__link" href="/community/talks-events/">Talks & Events</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Apache</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Apache Software Foundation<svg width="12" height="12" 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><a href="https://www.apache.org/foundation/how-it-works.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">How Apache Works<svg width="12" height="12" 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><a href="https://www.apache.org/licenses" target="_blank" rel="noopener noreferrer" class="dropdown__link">License<svg width="12" height="12" 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><a href="https://www.apache.org/security" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security<svg width="12" height="12" 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><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsoring Apache<svg width="12" height="12" 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><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks<svg width="12" height="12" 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><a href="https://github.com/apache/streampipes" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-link h-github" aria-label="Apache StreamPipes Github"></a><a href="https://linkedin.com/company/apache-streampipes" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-link h-linkedin" aria-label="Apache StreamPipes LinkedIn"></a><a href="https://twitter.com/streampipes" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-link h-twitter" aria-label="Apache StreamPipes Twitter"></a><div class="searchBox_ZlJk"></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="scroll-custom thin-scrollbar"><div class="custom-sidebar-version"><div class="custom-sidebar-inner"><span style="display:inline-block">Version</span> <div class="navbar__item dropdown dropdown--hoverable"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/next/user-guide-introduction/">Next</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/next/deploy-environment-variables/">Next</a></li><li><a class="dropdown__link" href="/docs/deploy-environment-variables/">0.97.0</a></li><li><a class="dropdown__link" href="/docs/0.95.1/deploy-environment-variables/">0.95.1</a></li><li><a class="dropdown__link" href="/docs/0.95.0/deploy-environment-variables/">0.95.0</a></li><li><a class="dropdown__link" href="/docs/0.93.0/deploy-environment-variables/">0.93.0</a></li><li><a class="dropdown__link" href="/docs/0.92.0/deploy-environment-variables/">0.92.0</a></li><li><a class="dropdown__link" href="/docs/0.91.0/user-guide-introduction/">0.91.0</a></li></ul></div></div></div><div id="sidebarCssSelector"><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-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/next/user-guide-introduction/">🚀 Try StreamPipes</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/next/introduction/">💡 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" aria-expanded="false" href="/docs/next/use-connect/">🎓 Use StreamPipes</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/next/pe/org.apache.streampipes.connect.iiot.adapters.plc4x.generic.ab-eth/">📚 Extensions</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" aria-expanded="true" href="/docs/next/choosing-the-right-flavor/">⚡ Deploy StreamPipes</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/next/choosing-the-right-flavor/">Service selection options</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/next/deploy-docker/">Docker Deployment</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/next/deploy-kubernetes/">Kubernetes Deployment</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/next/deploy-use-ssl/">Use SSL</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/next/deploy-security/">Security</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/next/deploy-environment-variables/">Environment Variables</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/next/extend-setup/">💻 Customize StreamPipes</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/next/technicals-architecture/">🔧 Technicals</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/next/community-get-help/">👪 Community</a></div></li></ul></nav></div></div></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="theme-doc-version-banner alert alert--warning margin-bottom--md" role="alert"><div>This is unreleased documentation for <!-- -->Apache StreamPipes<!-- --> <b>Next</b> version.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/docs/deploy-environment-variables/">latest version</a></b> (<!-- -->0.97.0<!-- -->).</div></div><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">⚡ Deploy StreamPipes</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><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"><header><h1>Environment Variables</h1></header><h2 class="anchor anchorWithStickyNavbar_LWe7" id="introduction">Introduction<a href="#introduction" class="hash-link" aria-label="Direct link to Introduction" title="Direct link to Introduction"></a></h2><p>A StreamPipes installation can be configured in many ways by providing environment variables. |
| The following lists describe available environment variables along with a description.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="streampipes-core-service">StreamPipes Core Service<a href="#streampipes-core-service" class="hash-link" aria-label="Direct link to StreamPipes Core Service" title="Direct link to StreamPipes Core Service"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="internal">Internal<a href="#internal" class="hash-link" aria-label="Direct link to Internal" title="Direct link to Internal"></a></h3><table><thead><tr><th>Env Variable Name</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>SP_DEBUG</td><td>false</td><td>Should only be set for local development to reroute traffic to localhost</td></tr><tr><td>SP_INITIAL_ADMIN_EMAIL</td><td><a href="mailto:admin@streampipes.apache.org" target="_blank" rel="noopener noreferrer">admin@streampipes.apache.org</a></td><td>Installation-time variable for defining the default user name</td></tr><tr><td>SP_INITIAL_ADMIN_PASSWORD</td><td>admin</td><td>Installation-time variable for defining the default user password</td></tr><tr><td>SP_INITIAL_SERVICE_USER</td><td>sp-service-client</td><td>Installation-time variable for defining the initial service user (must be same to the configured user in the extension service)</td></tr><tr><td>SP_INITIAL_SERVICE_USER_SECRET</td><td>my-apache-streampipes-secret-key-change-me</td><td>Installation-time variable for defining the initial service secret (minimum 35 chars)</td></tr><tr><td>SP_JWT_SECRET</td><td>Empty for Docker, Auto-generated for K8s</td><td>JWT secret, base64-encoded, minimum 256 bits</td></tr><tr><td>SP_JWT_SIGNING_MODE</td><td>HMAC</td><td>HMAC or RSA, RSA can be used to authenticate Core-Extensions communication</td></tr><tr><td>SP_JWT_PRIVATE_KEY_LOC</td><td>Empty</td><td>Required id SP_JWT_SIGNING_MODE=RSA, path to the private key, can be generated in the UI (Settings->Security->Generate Key Pair)</td></tr><tr><td>SP_ENCRYPTION_PASSCODE</td><td>eGgemyGBoILAu3xckolp for Docker, Auto-generated for K8s</td><td>Encryption passcode for <code>SecretStaticProperties</code></td></tr><tr><td>SP_PRIORITIZED_PROTOCOL</td><td>kafka</td><td>Messaging layer for data exchange between extensions</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="third-party-services">Third-party services<a href="#third-party-services" class="hash-link" aria-label="Direct link to Third-party services" title="Direct link to Third-party services"></a></h3><table><thead><tr><th>Env Variable Name</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>SP_COUCHDB_HOST</td><td>couchdb</td><td>The hostname or IP of the CouchDB database</td></tr><tr><td>SP_COUCHDB_PROTOCOL</td><td>http</td><td>The protocol (http or https) of the CouchDB database</td></tr><tr><td>SP_COUCHDB_PORT</td><td>5984</td><td>The port of the CouchDB database</td></tr><tr><td>SP_COUCHDB_USER</td><td>admin</td><td>The user of the CouchDB database (must have permissions to add databases)</td></tr><tr><td>SP_COUCHDB_PASSWORD</td><td>admin</td><td>The password of the CouchDB user</td></tr><tr><td>SP_TS_STORAGE_HOST</td><td>influxdb</td><td>The hostname of the timeseries storage (currently InfluxDB)</td></tr><tr><td>SP_TS_STORAGE_PORT</td><td>8086</td><td>The port of the timeseries storage</td></tr><tr><td>SP_TS_STORAGE_PROTOCOL</td><td>http</td><td>The protocol of the timeseries storage (http or https)</td></tr><tr><td>SP_TS_STORAGE_BUCKET</td><td>sp</td><td>The InfluxDB storage bucket name</td></tr><tr><td>SP_TS_STORAGE_ORG</td><td>sp</td><td>The InfluxDB storage org</td></tr><tr><td>SP_TS_STORAGE_TOKEN</td><td>sp-admin</td><td>The InfluxDB storage token</td></tr></tbody></table><p>The InfluxDB itself can be configured by providing the variables <code>DOCKER_INFLUXDB_INIT_PASSWORD</code> and <code>DOCKER_INFLUXDB_INIT_ADMIN_TOKEN</code>. See the <code>docker-compose</code> file for details.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="streampipes-extensions-service">StreamPipes Extensions Service<a href="#streampipes-extensions-service" class="hash-link" aria-label="Direct link to StreamPipes Extensions Service" title="Direct link to StreamPipes Extensions Service"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="internal-1">Internal<a href="#internal-1" class="hash-link" aria-label="Direct link to Internal" title="Direct link to Internal"></a></h3><table><thead><tr><th>Env Variable Name</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>SP_CLIENT_USER</td><td>Empty</td><td>Service account for communication with Core</td></tr><tr><td>SP_CLIENT_SECRET</td><td>Empty</td><td>Service secret for communication with Core</td></tr><tr><td>SP_EXT_AUTH_MODE</td><td>sp-service-client</td><td>When set to AUTH: all interfaces are only accessible with authentication (requires SP_JET_PRIVATE_KEY_LOC in Core)</td></tr><tr><td>SP_JWT_PUBLIC_KEY_LOC</td><td>my-apache-streampipes-secret-key-change-me</td><td>Path to the public key of the corresponding SP_JWT_PRIVATE_KEY defined in Core</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="third-party-services-1">Third-party services<a href="#third-party-services-1" class="hash-link" aria-label="Direct link to Third-party services" title="Direct link to Third-party services"></a></h3><p>The following variables are only required for extensions which require access to the internal time-series storage (the <code>Data Lake Sink</code>).</p><table><thead><tr><th>Env Variable Name</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>SP_TS_STORAGE_HOST</td><td>influxdb</td><td>The hostname of the timeseries storage (currently InfluxDB)</td></tr><tr><td>SP_TS_STORAGE_PORT</td><td>8086</td><td>The port of the timeseries storage</td></tr><tr><td>SP_TS_STORAGE_PROTOCOL</td><td>http</td><td>The protocol of the timeseries storage (http or https)</td></tr><tr><td>SP_TS_STORAGE_BUCKET</td><td>sp</td><td>The InfluxDB storage bucket name</td></tr><tr><td>SP_TS_STORAGE_ORG</td><td>sp</td><td>The InfluxDB storage org</td></tr><tr><td>SP_TS_STORAGE_TOKEN</td><td>sp-admin</td><td>The InfluxDB storage token</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="recommended-variables">Recommended variables<a href="#recommended-variables" class="hash-link" aria-label="Direct link to Recommended variables" title="Direct link to Recommended variables"></a></h2><p>For a standard deployment, it is recommended to customize the following variables:</p><ul><li>Initiales Admin-Passwort (SP_INITIAL_ADMIN_PASSWORD, Core)</li><li>Initiales Client Secret (SP_INITIAL_SERVICE_USER_SECRET, Core)</li><li>Client Secret Extensions (SP_CLIENT_USER, Extensions)</li><li>Encryption Passcode (SP_ENCRYPTION_PASSCODE, Core)</li><li>CouchDB-Password (SP_COUCHDB_PASSWORD, Core + Extensions + CouchDB)</li><li>InfluxDB Storage Password (DOCKER_INFLUXDB_INIT_PASSWORD, InfluxDB)</li><li>InfluxDB Storage Token (SP_TS_STORAGE_TOKEN (Core, Extensions)</li><li>DOCKER_INFLUXDB_INIT_ADMIN_TOKEN (InfluxDB service)</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="auto-generation-of-variables-in-k8s-setups">Auto-generation of variables in K8s setups<a href="#auto-generation-of-variables-in-k8s-setups" class="hash-link" aria-label="Direct link to Auto-generation of variables in K8s setups" title="Direct link to Auto-generation of variables in K8s setups"></a></h2><p>See the <a href="/docs/next/deploy-kubernetes/">Kubernetes Guide</a> for an overview of auto-generated variables.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"></div><div class="col lastUpdated_vwxv"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2023-11-17T08:01:40.000Z">Nov 17, 2023</time></b> by <b>Dominik Riemer</b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/next/deploy-security/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Security</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/next/extend-setup/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Development Setup</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="#introduction" class="table-of-contents__link toc-highlight">Introduction</a></li><li><a href="#streampipes-core-service" class="table-of-contents__link toc-highlight">StreamPipes Core Service</a><ul><li><a href="#internal" class="table-of-contents__link toc-highlight">Internal</a></li><li><a href="#third-party-services" class="table-of-contents__link toc-highlight">Third-party services</a></li></ul></li><li><a href="#streampipes-extensions-service" class="table-of-contents__link toc-highlight">StreamPipes Extensions Service</a><ul><li><a href="#internal-1" class="table-of-contents__link toc-highlight">Internal</a></li><li><a href="#third-party-services-1" class="table-of-contents__link toc-highlight">Third-party services</a></li></ul></li><li><a href="#recommended-variables" class="table-of-contents__link toc-highlight">Recommended variables</a></li><li><a href="#auto-generation-of-variables-in-k8s-setups" class="table-of-contents__link toc-highlight">Auto-generation of variables in K8s setups</a></li></ul></div></div></div></div></main></div></div><footer class="container_yWIM"><div class="linksRow_XFIr"><div class="linksCol_rFJL"><div>ASF</div><ul><li class="footer__item"><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer"><span></span><span>Foundation</span></a></li><li class="footer__item"><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer"><span></span><span>License</span></a></li><li class="footer__item"><a href="https://www.apache.org/events/" target="_blank" rel="noopener noreferrer"><span></span><span>Events</span></a></li><li class="footer__item"><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer"><span></span><span>Security</span></a></li><li class="footer__item"><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer"><span></span><span>Sponsorship</span></a></li><li class="footer__item"><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer"><span></span><span>Thanks</span></a></li></ul></div><div class="linksCol_rFJL"><div>Community</div><ul><li class="footer__item"><a href="https://github.com/apache/streampipes/issues" target="_blank" rel="noopener noreferrer"><span></span><span>GitHub Issues</span></a></li><li class="footer__item"><a href="https://github.com/apache/streampipes/discussions" target="_blank" rel="noopener noreferrer"><span></span><span>Github Discussions</span></a></li><li class="footer__item"><a href="https://twitter.com/StreamPipes" target="_blank" rel="noopener noreferrer"><span></span><span>Twitter</span></a></li><li class="footer__item"><a href="https://www.linkedin.com/company/apache-streampipes" target="_blank" rel="noopener noreferrer"><span></span><span>LinkedIn</span></a></li></ul></div><div class="linksCol_rFJL"><div>More</div><ul><li class="footer__item"><a target="_parent" href="/blog/"><span></span><span>Blog</span></a></li><li class="footer__item"><a href="https://privacy.apache.org/policies/privacy-policy-public.html" target="_parent" rel="noopener noreferrer"><span></span><span>Privacy</span></a></li></ul></div></div><div class="copyright_AoBa"><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer"><span style="display:inline-block;width:231.25px;height:40px"></span></a><div>Copyright © 2019-2025 The Apache Software Foundation. Apache StreamPipes, Apache, the Apache feather logo, and the Apache StreamPipes project logo are either registered trademarks or trademarks of the Apache Software Foundation.</div></div></footer></div> |
| <script src="/assets/js/runtime~main.d38cef4e.js"></script> |
| <script src="/assets/js/main.6ee83347.js"></script> |
| </body> |
| </html> |
