| --- | 
 | id: user-guide-introduction | 
 | title: Apache StreamPipes Documentation | 
 | sidebar_label: Overview | 
 | original_id: user-guide-introduction | 
 | --- | 
 |  | 
 | This is the documentation of Apache StreamPipes. | 
 |  | 
 | <img class="docs-image docs-image-small docs-image-no-shadow" style={{padding: '10px'}} src="/img/01_try-overview/01_streampipes-overview.png" alt="StreamPipes Overview"/> | 
 |  | 
 |  | 
 | <div class="container grid col-3"> | 
 |     <div class="column"> | 
 |         <div class="toc-box"> | 
 |             <div class="toc-header border-thin"> | 
 |                 🚀 Try | 
 |             </div> | 
 |             <div class="toc-content"> | 
 |                 <div class="toc-section-header"><b>Your first steps with Apache StreamPipes:</b></div> | 
 |                <a href="../try-installation/">Install StreamPipes 🔗</a> | 
 |             </div> | 
 |         </div> | 
 |     </div> | 
 |     <div class="column"> | 
 |         <div class="toc-box"> | 
 |             <div class="toc-header border-thin"> | 
 |                 💡 Concepts | 
 |             </div> | 
 |             <div class="toc-content"> | 
 |                 <div class="toc-section-header"><b>Learn about some general concepts of StreamPipes:</b></div> | 
 |                 <a href="../concepts-overview/">Overview 🔗</a> | 
 |             </div> | 
 |         </div> | 
 |     </div> | 
 |     <div class="column"> | 
 |         <div class="toc-box"> | 
 |             <div class="toc-header border-thin"> | 
 |                 🎓 Use | 
 |             </div> | 
 |             <div class="toc-content"> | 
 |                 <div class="toc-section-header"><b>Learn how to use the various modules of StreamPipes:</b></div> | 
 |                 <a href="../use-connect/">StreamPipes Connect 🔗</a>,  | 
 |                 <a href="../use-pipeline-editor/">Pipeline Editor 🔗</a>,  | 
 |                 <a href="../use-managing-pipelines/">Managing Pipelines 🔗</a>,  | 
 |                 <a href="../use-live-dashboard/">Live Dashboard 🔗</a>,  | 
 |                 <a href="../use-data-explorer/">Data Explorer 🔗</a>,  | 
 |                 <a href="../use-notifications/">Notifications 🔗</a> | 
 |             </div> | 
 |         </div> | 
 |     </div> | 
 |     <div class="column"> | 
 |         <div class="toc-box"> | 
 |             <div class="toc-header border-thin"> | 
 |                 📚 Pipeline Elements | 
 |             </div> | 
 |             <div class="toc-content"> | 
 |                 <div class="toc-section-header"><b>Available pipeline elements in StreamPipes:</b></div> | 
 |                 <a href="../pe/org.apache.streampipes.connect.iiot.protocol.stream.kafka/">Adapters 🔗</a>,  | 
 |                 <a href="../pe/org.apache.streampipes.processors.transformation.jvm.booloperator.counter/">Data Processors 🔗</a>,  | 
 |                 <a href="../pe/org.apache.streampipes.sinks.databases.jvm.couchdb/">Data Sinks 🔗</a>  | 
 |             </div> | 
 |         </div> | 
 |     </div> | 
 |     <div class="column"> | 
 |         <div class="toc-box"> | 
 |             <div class="toc-header border-thin"> | 
 |                 âš¡ Deploy  | 
 |             </div> | 
 |             <div class="toc-content"> | 
 |                 <div class="toc-section-header"><b>How to set up StreamPipes in test and production environments:</b></div> | 
 |                 <a href="../deploy-docker/">Docker 🔗</a>,  | 
 |                 <a href="../deploy-kubernetes/">Kubernetes 🔗</a>,  | 
 |                 <a href="../deploy-use-ssl/">Use SSL 🔗</a> | 
 |             </div> | 
 |         </div> | 
 |     </div> | 
 |     <div class="column"> | 
 |         <div class="toc-box"> | 
 |             <div class="toc-header border-thin"> | 
 |                 💻 Extend | 
 |             </div> | 
 |             <div class="toc-content"> | 
 |                 <div class="toc-section-header"><b>Write your own pipeline elements for StreamPipes:</b></div> | 
 |                 <a href="../extend-setup/">Development Setup 🔗</a>, <a href="../extend-cli/">CLI 🔗</a>, <a href="../extend-archetypes/">Maven Archetypes 🔗</a>, | 
 |                 <a href="../extend-tutorial-data-sources/">Tutorial Data Sources 🔗</a>,  | 
 |                 <a href="../extend-tutorial-data-processors">Tutorial Data Processors 🔗</a>,  | 
 |                 <a href="../extend-tutorial-data-sinks/">Tutorial Data Sinks 🔗</a>, | 
 |                 <a href="../extend-sdk-event-model/">Event Model 🔗</a>,  | 
 |                 <a href="../extend-sdk-stream-requirements/">Stream Requirements 🔗</a>,  | 
 |                 <a href="../extend-sdk-static-properties/">Static Properties 🔗</a>, | 
 |                 <a href="../extend-sdk-output-strategies/">Output Strategies 🔗</a> | 
 |             </div> | 
 |         </div> | 
 |     </div> | 
 |     <div class="column"> | 
 |         <div class="toc-box"> | 
 |             <div class="toc-header border-thin"> | 
 |                 🔧 Technicals | 
 |             </div> | 
 |             <div class="toc-content"> | 
 |                 <div class="toc-section-header"><b>Learn about technical concepts behind the curtain:</b></div> | 
 |                 <a href="../technicals-architecture/">Architecture 🔗</a>,  | 
 |                 <a href="../technicals-user-guidance/">User Guidance 🔗 </a>,  | 
 |                 <a href="../technicals-runtime-wrappers/">Runtime Wrappers 🔗</a>, | 
 |                 <a href="../technicals-messaging/">Messaging 🔗</a>,  | 
 |                 <a href="../technicals-configuration/">Configuration 🔗</a> | 
 |             </div> | 
 |         </div> | 
 |     </div> | 
 |     <div class="column"> | 
 |         <div class="toc-box"> | 
 |             <div class="toc-header border-thin"> | 
 |                 👪 Community | 
 |             </div> | 
 |             <div class="toc-content"> | 
 |                 <div class="toc-section-header"><b>Get support and learn how to contribute to StreamPipes:</b></div> | 
 |                 <a href="../community-get-help/">Get Help 🔗</a>,  | 
 |                 <a href="../community-contribute/">Contribute 🔗</a> | 
 |             </div> | 
 |         </div> | 
 |     </div> | 
 | </div> | 
 |  | 
 |  |