docs/dev-guide/building_hono/index.html - gerrit/www.eclipse.org/hono - Git at Google

 <!DOCTYPE html>
 <html lang="stable" class="js csstransforms3d">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="Hugo 0.81.0" />
     <meta name="description" content="A set of micro-services for connecting millions of devices.">
 <meta name="author" content="The Eclipse Hono Project">

     <link rel="apple-touch-icon" sizes="180x180" href="/hono/docs/favicon/apple-touch-icon.png">
 <link rel="icon" type="image/png" sizes="48x48" href="/hono/docs/favicon/favicon-48x48.png">
 <link rel="icon" type="image/png" sizes="32x32" href="/hono/docs/favicon/favicon-32x32.png">
 <link rel="icon" type="image/png" sizes="16x16" href="/hono/docs/favicon/favicon-16x16.png">
 <link rel="manifest" href="/hono/docs/favicon/site.webmanifest">
 <link rel="mask-icon" href="/hono/docs/favicon/safari-pinned-tab.svg" color="#5bbad5">
 <link rel="shortcut icon" href="/hono/docs/favicon/favicon.ico">
 <meta name="msapplication-TileColor" content="#da532c">
 <meta name="msapplication-config" content="/hono/docs/favicon/browserconfig.xml">
 <meta name="theme-color" content="#ffffff">

     <title>Building from Source :: Eclipse Hono&trade;</title>


     <link href="/hono/docs/css/nucleus.css?1623460254" rel="stylesheet">
     <link href="/hono/docs/css/fontawesome-all.min.css?1623460254" rel="stylesheet">
     <link href="/hono/docs/css/hybrid.css?1623460254" rel="stylesheet">
     <link href="/hono/docs/css/featherlight.min.css?1623460254" rel="stylesheet">
     <link href="/hono/docs/css/perfect-scrollbar.min.css?1623460254" rel="stylesheet">
     <link href="/hono/docs/css/auto-complete.css?1623460254" rel="stylesheet">
     <link href="/hono/docs/css/atom-one-dark-reasonable.css?1623460254" rel="stylesheet">
     <link href="/hono/docs/css/theme.css?1623460254" rel="stylesheet">
     <link href="/hono/docs/css/hugo-theme.css?1623460254" rel="stylesheet">

     <link href="/hono/docs/css/theme-hono.css?1623460254" rel="stylesheet">

     <link href="/hono/docs/css/hono.css?1623460254" rel="stylesheet">

     <script src="/hono/docs/js/jquery-3.3.1.min.js?1623460254"></script>

     <style>
       :root #header + #content > #left > #rlblock_left{
           display:none !important;
       }

         :not(pre) > code + span.copy-to-clipboard {
             display: none;
         }

     </style>

 <link rel="stylesheet" href="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css">


 <meta name="twitter:card" content="summary_large_image">
 <meta name="twitter:site" content="@EclipseHono">
 <meta name="twitter:title" content="Building from Source :: Eclipse Hono&amp;trade;">
 <meta name="twitter:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png">
 <meta name="twitter:description" content="A set of micro-services for connecting millions of devices.">


 <meta property="og:title" content="Building from Source :: Eclipse Hono&amp;trade;" />
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://www.eclipse.org/hono/docs/dev-guide/building_hono//" />
 <meta property="og:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png" />

   </head>
   <body class="" data-url="/hono/docs/dev-guide/building_hono/">
     <nav id="sidebar" class="">


   <div id="header-wrapper">
     <div id="header">
       <a href="https://www.eclipse.org/hono/">
     <img src="/hono/docs/images/HONO-Logo_Bild-Wort_quer-w-310x120px.svg" alt="Hono logo" class="logo-img">
 </a>

     </div>

         <div class="searchbox">
     <label for="search-by"><i class="fas fa-search"></i></label>
     <input data-search-input id="search-by" type="search" placeholder="Search...">
     <span data-search-clear=""><i class="fas fa-times"></i></span>
 </div>

 <script type="text/javascript" src="/hono/docs/js/lunr.min.js?1623460254"></script>
 <script type="text/javascript" src="/hono/docs/js/auto-complete.js?1623460254"></script>
 <script type="text/javascript">

         var baseurl = "https:\/\/www.eclipse.org\/hono\/docs\/";

 </script>
 <script type="text/javascript" src="/hono/docs/js/search.js?1623460254"></script>


   </div>

     <div class="highlightable">
     <ul class="topics">


     <li data-nav-id="/hono/docs/concepts/" title="Concepts" class="dd-item


         ">
       <a href="/hono/docs/concepts/">
           <i class="far fa-lightbulb"></i> Concepts

       </a>


         <ul>


       <li data-nav-id="/hono/docs/concepts/device-identity/" title="Device Identity" class="dd-item ">
         <a href="/hono/docs/concepts/device-identity/">
         Device Identity

         </a>
     </li>


       <li data-nav-id="/hono/docs/concepts/tenancy/" title="Multi-Tenancy" class="dd-item ">
         <a href="/hono/docs/concepts/tenancy/">
         Multi-Tenancy

         </a>
     </li>


       <li data-nav-id="/hono/docs/concepts/device-provisioning/" title="Device Provisioning" class="dd-item ">
         <a href="/hono/docs/concepts/device-provisioning/">
         Device Provisioning

         </a>
     </li>


       <li data-nav-id="/hono/docs/concepts/connecting-devices/" title="Connecting Devices" class="dd-item ">
         <a href="/hono/docs/concepts/connecting-devices/">
         Connecting Devices

         </a>
     </li>


       <li data-nav-id="/hono/docs/concepts/device-notifications/" title="Device Notifications" class="dd-item ">
         <a href="/hono/docs/concepts/device-notifications/">
         Device Notifications

         </a>
     </li>


       <li data-nav-id="/hono/docs/concepts/command-and-control/" title="Command &amp; Control" class="dd-item ">
         <a href="/hono/docs/concepts/command-and-control/">
         Command &amp; Control

         </a>
     </li>


       <li data-nav-id="/hono/docs/concepts/resource-limits/" title="Resource limits" class="dd-item ">
         <a href="/hono/docs/concepts/resource-limits/">
         Resource limits

         </a>
     </li>


       <li data-nav-id="/hono/docs/concepts/connection-events/" title="Connection Events" class="dd-item ">
         <a href="/hono/docs/concepts/connection-events/">
         Connection Events

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/user-guide/" title="User Guide" class="dd-item


         ">
       <a href="/hono/docs/user-guide/">
           <i class="fas fa-book-reader"></i> User Guide

       </a>


         <ul>


       <li data-nav-id="/hono/docs/user-guide/mongodb-based-device-registry/" title="MongoDB Based Device Registry" class="dd-item ">
         <a href="/hono/docs/user-guide/mongodb-based-device-registry/">
         MongoDB Based Device Registry

         </a>
     </li>


       <li data-nav-id="/hono/docs/user-guide/jdbc-based-device-registry/" title="JDBC Based Device Registry" class="dd-item ">
         <a href="/hono/docs/user-guide/jdbc-based-device-registry/">
         JDBC Based Device Registry

         </a>
     </li>


       <li data-nav-id="/hono/docs/user-guide/file-based-device-registry/" title="File Based Device Registry" class="dd-item ">
         <a href="/hono/docs/user-guide/file-based-device-registry/">
         File Based Device Registry

         </a>
     </li>


       <li data-nav-id="/hono/docs/user-guide/http-adapter/" title="HTTP Adapter" class="dd-item ">
         <a href="/hono/docs/user-guide/http-adapter/">
         HTTP Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/user-guide/mqtt-adapter/" title="MQTT Adapter" class="dd-item ">
         <a href="/hono/docs/user-guide/mqtt-adapter/">
         MQTT Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/user-guide/amqp-adapter/" title="AMQP Adapter" class="dd-item ">
         <a href="/hono/docs/user-guide/amqp-adapter/">
         AMQP Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/user-guide/coap-adapter/" title="CoAP Adapter" class="dd-item ">
         <a href="/hono/docs/user-guide/coap-adapter/">
         CoAP Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/user-guide/kura-adapter/" title="Kura Adapter" class="dd-item ">
         <a href="/hono/docs/user-guide/kura-adapter/">
         Kura Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/user-guide/sigfox-adapter/" title="Sigfox Adapter" class="dd-item ">
         <a href="/hono/docs/user-guide/sigfox-adapter/">
         Sigfox Adapter

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/admin-guide/" title="Admin Guide" class="dd-item


         ">
       <a href="/hono/docs/admin-guide/">
           <i class="fas fa-sliders-h"></i> Admin Guide

       </a>


         <ul>


       <li data-nav-id="/hono/docs/admin-guide/common-config/" title="Common Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/common-config/">
         Common Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/auth-server-config/" title="Auth Server Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/auth-server-config/">
         Auth Server Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/mongodb-device-registry-config/" title="MongoDB Based Device Registry Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/mongodb-device-registry-config/">
         MongoDB Based Device Registry Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/jdbc-device-registry-config/" title="JDBC Based Device Registry Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/jdbc-device-registry-config/">
         JDBC Based Device Registry Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/file-based-device-registry-config/" title="File Based Device Registry Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/file-based-device-registry-config/">
         File Based Device Registry Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/command-router-config/" title="Configuring the Command Router Service" class="dd-item ">
         <a href="/hono/docs/admin-guide/command-router-config/">
         Command Router Service Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/device-connection-config/" title="Configuring the Device Connection Service" class="dd-item ">
         <a href="/hono/docs/admin-guide/device-connection-config/">
         Device Connection Service Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/http-adapter-config/" title="HTTP Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/http-adapter-config/">
         HTTP Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/mqtt-adapter-config/" title="MQTT Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/mqtt-adapter-config/">
         MQTT Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/amqp-adapter-config/" title="AMQP Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/amqp-adapter-config/">
         AMQP Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/coap-adapter-config/" title="CoAP Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/coap-adapter-config/">
         CoAP Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/kura-adapter-config/" title="Kura Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/kura-adapter-config/">
         Kura Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/hono-client-configuration/" title="Hono Client Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/hono-client-configuration/">
         Hono Client Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/hono-kafka-client-configuration/" title="Hono Kafka Client Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/hono-kafka-client-configuration/">
         Hono Kafka Client Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/amqp-network-config/" title="AMQP 1.0 Messaging Network Configuration" class="dd-item ">
         <a href="/hono/docs/admin-guide/amqp-network-config/">
         AMQP 1.0 Messaging Network Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/secure_communication/" title="Secure Communication" class="dd-item ">
         <a href="/hono/docs/admin-guide/secure_communication/">
         Secure Communication

         </a>
     </li>


       <li data-nav-id="/hono/docs/admin-guide/monitoring-tracing-config/" title="Monitoring &amp; Tracing" class="dd-item ">
         <a href="/hono/docs/admin-guide/monitoring-tracing-config/">
         Monitoring &amp; Tracing

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/dev-guide/" title="Developer Guide" class="dd-item
         parent


         ">
       <a href="/hono/docs/dev-guide/">
           <i class="fas fa-tools"></i> Developer Guide

       </a>


         <ul>


       <li data-nav-id="/hono/docs/dev-guide/building_hono/" title="Building from Source" class="dd-item active">
         <a href="/hono/docs/dev-guide/building_hono/">
         Building from Source

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev-guide/amqp_adapter_client/" title="AMQP Adapter Client for Java" class="dd-item ">
         <a href="/hono/docs/dev-guide/amqp_adapter_client/">
         AMQP Adapter Client for Java

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev-guide/java_client_consumer/" title="Consuming Messages from Java" class="dd-item ">
         <a href="/hono/docs/dev-guide/java_client_consumer/">
         Consuming Messages from Java

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev-guide/custom_http_adapter/" title="Implement a Custom Hono HTTP Protocol Adapter" class="dd-item ">
         <a href="/hono/docs/dev-guide/custom_http_adapter/">
         Implement a Custom Hono HTTP Protocol Adapter

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/api/" title="API" class="dd-item


         ">
       <a href="/hono/docs/api/">
           &nbsp;<i class='fas fa-plug'></i>&nbsp;API

       </a>


         <ul>


       <li data-nav-id="/hono/docs/api/telemetry/" title="Telemetry API Specification" class="dd-item ">
         <a href="/hono/docs/api/telemetry/">
         Telemetry API

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/event/" title="Event API Specification" class="dd-item ">
         <a href="/hono/docs/api/event/">
         Event API

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/command-and-control/" title="Command &amp; Control API Specification" class="dd-item ">
         <a href="/hono/docs/api/command-and-control/">
         Command &amp; Control API

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/kafka-api/" title="Kafka-based APIs" class="dd-item ">
         <a href="/hono/docs/api/kafka-api/">
         Kafka-based APIs

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/telemetry-kafka/" title="Telemetry API for Kafka Specification" class="dd-item ">
         <a href="/hono/docs/api/telemetry-kafka/">
         Telemetry API for Kafka

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/event-kafka/" title="Event API for Kafka Specification" class="dd-item ">
         <a href="/hono/docs/api/event-kafka/">
         Event API for Kafka

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/command-and-control-kafka/" title="Command &amp; Control API for Kafka Specification" class="dd-item ">
         <a href="/hono/docs/api/command-and-control-kafka/">
         Command &amp; Control API for Kafka

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/tenant/" title="Tenant API Specification" class="dd-item ">
         <a href="/hono/docs/api/tenant/">
         Tenant API

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/command-router/" title="Command Router API Specification" class="dd-item ">
         <a href="/hono/docs/api/command-router/">
         Command Router API

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/device-connection/" title="Device Connection API Specification" class="dd-item ">
         <a href="/hono/docs/api/device-connection/">
         Device Connection API

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/device-registration/" title="Device Registration API Specification" class="dd-item ">
         <a href="/hono/docs/api/device-registration/">
         Device Registration API

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/credentials/" title="Credentials API Specification" class="dd-item ">
         <a href="/hono/docs/api/credentials/">
         Credentials API

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/authentication/" title="Authentication API Specification" class="dd-item ">
         <a href="/hono/docs/api/authentication/">
         Authentication API

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/management/" title="Device Registry Management API Specification" class="dd-item ">
         <a href="/hono/docs/api/management/">
         Device Registry Management API

         </a>
     </li>


       <li data-nav-id="/hono/docs/api/metrics/" title="Metrics" class="dd-item ">
         <a href="/hono/docs/api/metrics/">
         Metrics

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/deployment/" title="Deployment" class="dd-item


         ">
       <a href="/hono/docs/deployment/">
           <i class="fas fa-shipping-fast"></i> Deployment

       </a>


         <ul>


       <li data-nav-id="/hono/docs/deployment/helm-based-deployment/" title="Helm based Deployment" class="dd-item ">
         <a href="/hono/docs/deployment/helm-based-deployment/">
         Helm based Deployment

         </a>
     </li>


       <li data-nav-id="/hono/docs/deployment/openshift/" title="OpenShift / OKD" class="dd-item ">
         <a href="/hono/docs/deployment/openshift/">
         OpenShift / OKD

         </a>
     </li>


       <li data-nav-id="/hono/docs/deployment/create-kubernetes-cluster/" title="Setting up a Kubernetes Cluster" class="dd-item ">
         <a href="/hono/docs/deployment/create-kubernetes-cluster/">
         Setting up a Kubernetes Cluster

         </a>
     </li>


       <li data-nav-id="/hono/docs/deployment/resource-limitation/" title="Limiting Resource Usage" class="dd-item ">
         <a href="/hono/docs/deployment/resource-limitation/">
         Limiting Resource Usage

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/architecture/" title="Architecture" class="dd-item


         ">
       <a href="/hono/docs/architecture/">
           <i class="fas fa-landmark"></i> Architecture

       </a>


         <ul>


       <li data-nav-id="/hono/docs/architecture/component-view/" title="Component View" class="dd-item ">
         <a href="/hono/docs/architecture/component-view/">
         Component View

         </a>
     </li>


       <li data-nav-id="/hono/docs/architecture/auth/" title="Authentication/Authorization" class="dd-item ">
         <a href="/hono/docs/architecture/auth/">
         Authentication/Authorization

         </a>
     </li>


         </ul>

     </li>


     </ul>


       <section id="shortcuts">
         <h3></h3>
         <ul>

               <li>
                   <a class="padding" href="https://www.eclipse.org/hono/" title="Hono&#39;s Homepage"><i class='fas fa-home'></i> Hono Home</a>
               </li>

               <li>
                   <a class="padding" href="https://www.eclipse.org/hono/getting-started/" title="Getting started with Eclipse Hono"><i class='fas fa-plane-departure'></i> Getting Started</a>
               </li>

         </ul>
       </section>


     <section id="prefooter">
       <hr/>
       <ul>

         <li>
           <div id="select-box-wrapper">
           <div id="select-box">
           <a class="padding">
             Version:&nbsp;
           <div class="select-style">
             <select id="select-language" onchange="location = this.value;">


                       <option id="stable" value="https://www.eclipse.org/hono/docs/dev-guide/building_hono/" selected>stable (1.8)</option>


                       <option id="1.8" value="https://www.eclipse.org/hono/docs/1.8/dev-guide/building_hono/">1.8</option>


                       <option id="1.7" value="https://www.eclipse.org/hono/docs/1.7/dev-guide/building_hono/">1.7</option>


                       <option id="1.6" value="https://www.eclipse.org/hono/docs/1.6/dev-guide/building_hono/">1.6</option>


                       <option id="1.5" value="https://www.eclipse.org/hono/docs/1.5/dev-guide/building_hono/">1.5</option>


                       <option id="1.4" value="https://www.eclipse.org/hono/docs/1.4/dev-guide/building_hono/">1.4</option>


                       <option id="1.3" value="https://www.eclipse.org/hono/docs/1.3/dev-guide/building_hono/">1.3</option>


                       <option id="1.2" value="https://www.eclipse.org/hono/docs/1.2/dev-guide/building_hono/">1.2</option>


                       <option id="1.1" value="https://www.eclipse.org/hono/docs/1.1/dev-guide/building_hono/">1.1</option>


                       <option id="1.0" value="https://www.eclipse.org/hono/docs/1.0/dev-guide/building_hono/">1.0</option>


                       <option id="dev" value="https://www.eclipse.org/hono/docs/dev/dev-guide/building_hono/">dev</option>


         </select>
         <svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
           width="255px" height="255px" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255;" xml:space="preserve">
           <g>
             <g id="arrow-drop-down">
               <polygon points="0,63.75 127.5,191.25 255,63.75 		" />
             </g>
           </g>
         </svg>
         </div>
         </a>
         </div>
         </div>
         </li>


       </ul>
     </section>

     <section id="footer">


 <p>&copy; 2021 <a href="https://www.eclipse.org/hono/">The Eclipse Hono Project</a></p>

 <p>
     Documentation built with
     <a href="https://gohugo.io/" target="_blank">Hugo</a>
     using the
     <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">Learn</a> theme.
 </p>

 <div class="eclipse-logo">
     <a href="https://www.eclipse.org" target="_blank">
         <img src="https://www.eclipse.org/hono/docs/images/eclipse_foundation_logo.svg"/>
     </a>
 </div>

     </section>
   </div>
 </nav>


         <section id="body">
         <div id="overlay"></div>


         <div class="padding highlightable">

               <div>
                 <div id="top-bar">


                   <div id="top-github-link">
                     <a class="github-link" title='Edit this page' href="https://github.com/eclipse/hono/edit/master/site/documentation/content/dev-guide/building_hono.md" target="blank">
                       <i class="fas fa-code-branch"></i>
                       <span id="top-github-link-text">Edit this page</span>
                     </a>
                   </div>


                 <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
                     <span id="sidebar-toggle-span">
                         <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
                           <i class="fas fa-bars"></i>
                         </a>
                     </span>

                   <span id="toc-menu"><i class="fas fa-list-alt"></i></span>

                   <span class="links">


             <a href='/hono/docs/'>Documentation</a> > <a href='/hono/docs/dev-guide/'>Developer Guide</a> > Building from Source


                   </span>
                 </div>

                     <div class="progress">
     <div class="wrapper">
 <nav id="TableOfContents">
   <ul>
     <li><a href="#prerequisites-for-building-hono">Prerequisites for building Hono</a>
       <ul>
         <li></li>
       </ul>
     </li>
     <li><a href="#getting-the-hono-source-code">Getting the Hono Source Code</a></li>
     <li><a href="#starting-the-hono-build-process">Starting the Hono Build Process</a>
       <ul>
         <li></li>
       </ul>
     </li>
     <li><a href="#running-the-integration-tests">Running the Integration Tests</a></li>
   </ul>
 </nav>
     </div>
 </div>


               </div>
             </div>

         <div id="head-tags">

         </div>

         <div id="body-inner">

             <h1>

               Building from Source
             </h1>


 <p>Hono can be deployed using the pre-built Docker images available from our <a href="https://hub.docker.com/u/eclipse/">Docker Hub repositories</a>. However, customizing and/or extending Hono&rsquo;s functionality requires building the images from source code.</p>
 <p>This page provides step by step instructions for getting the source code and building the Hono&rsquo;s Docker images from it.</p>
 <h2 id="prerequisites-for-building-hono">Prerequisites for building Hono</h2>
 <h4 id="docker">Docker</h4>
 <p>Creating Hono&rsquo;s container images using the Hono build process requires a <a href="https://www.docker.com/">Docker</a> daemon
 running either locally or on another host you have access to.
 Please follow the instructions on the <a href="https://www.docker.com/">Docker web site</a> to install Docker on your platform.</p>
 <p>In case the docker daemon is not running locally, the following environment variable needs to be set in order for
 the examples in the remainder of this page to run successfully:</p>
 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh">export DOCKER_HOST<span style="color:#f92672">=</span>tcp://<span style="color:#e6db74">${</span>host<span style="color:#e6db74">}</span>:<span style="color:#e6db74">${</span>port<span style="color:#e6db74">}</span>
 </code></pre></div><p>with <code>${host}</code> and <code>${port}</code> reflecting the name/IP address and port of the host where Docker is running on.</p>
 <h4 id="java">Java</h4>
 <p>Hono is written in Java and therefore requires a Java Development Kit (JDK) version 11 or higher installed on your computer. Please follow the JDK vendor&rsquo;s instructions for installing Java on your operating system.</p>
 <h4 id="maven">Maven</h4>
 <p>Hono&rsquo;s build process is based on <a href="https://maven.apache.org">Apache Maven</a>. You need at least Maven 3.5 in order to build Hono.
 Please follow the <a href="https://maven.apache.org/">installation instructions on the Maven home page</a>.</p>
 <h4 id="git">Git</h4>
 <p>A Git client is required if you want to contribute changes/improvements to the Hono project. It is not necessary for simply building Hono locally.
 Please refer to the <a href="https://git-scm.com/downloads">Git Downloads page</a> for installation instructions.</p>
 <h2 id="getting-the-hono-source-code">Getting the Hono Source Code</h2>
 <p>Either</p>
 <ul>
 <li>download the latest <a href="https://github.com/eclipse/hono/releases">release archive</a> and extract the archive to a local folder or</li>
 <li>clone the Hono source code repository from GitHub:
 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh">git clone https://github.com/eclipse/hono.git
 </code></pre></div><p>This will create a <code>hono</code> folder in the current working directory and clone the whole repository into that folder.</p>
 </li>
 </ul>
 <h2 id="starting-the-hono-build-process">Starting the Hono Build Process</h2>
 <p>Run the following from the source folder:</p>
 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh">export DOCKER_HOST
 <span style="color:#75715e"># in the &#34;hono&#34; folder containing the source code</span>
 mvn clean install -Pbuild-docker-image,metrics-prometheus,jaeger
 </code></pre></div><p>This will build all libraries, Docker images and example code.</p>
 <div class="alert alert-notice">
     <h4 class="alert-heading"><i class="fas fa-info-circle"></i> Be patient</h4>
     <div>The first build might take several minutes because Docker will need to download all the base images that Hono is relying on.
 However, most of these will be cached by Docker so that subsequent builds will be running much faster.</div>
 </div>
 <h4 id="gathering-code-coverage-information-for-unit-tests">Gathering Code Coverage Information for Unit Tests</h4>
 <p>Hono&rsquo;s unit tests can be configured to gather code coverage information during execution using the JaCoCo Maven plugin.
 The plugin is disabled by default and can be enabled by setting the <em>jacoco.skip</em> maven property to <code>false</code>:</p>
 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh"><span style="color:#75715e"># in the &#34;hono&#34; folder containing the source code</span>
 mvn clean install -Djacoco.skip<span style="color:#f92672">=</span>false -Pbuild-docker-image,metrics-prometheus,jaeger
 </code></pre></div><p>The plugin will produce a <code>target/jacoco.exec</code> file in each module which contains the (binary) coverage data.
 It will also produce XML data files under <code>target/site/jacoco</code> in each module.
 Tools like <a href="https://docs.sonarqube.org/latest/analysis/coverage/">SonarQube</a> can be used to collect and properly format
 this data.</p>
 <h4 id="using-custom-image-names">Using custom Image Names</h4>
 <p>The container images being created will have names based on the following pattern:
 <code>${docker.registry-name}/${docker.image.org-name}/${project.artifactId}:${project.version}</code>.</p>
 <p>The variables in the name are standard Maven properties. The default value for the <em>docker.registry-name</em> property is <code>index.docker.io</code>.
 The default value for <em>docker.image.org-name</em> is <code>eclipse</code>. The following build command creates Hono&rsquo;s images using the <code>quay.io</code> registry
 and the <code>custom</code> repository name:</p>
 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh">mvn clean install -Pbuild-docker-image,metrics-prometheus,jaeger -Ddocker.registry-name<span style="color:#f92672">=</span>quay.io -Ddocker.image.org-name<span style="color:#f92672">=</span>custom
 </code></pre></div><h4 id="building-native-images">Building native Images</h4>
 <p>The build process supports building <em>native</em> Docker images using the GraalVM for some of Hono&rsquo;s components.
 In order to do so, the <code>build-native-image</code> Maven profile needs to be activated:</p>
 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh"><span style="color:#75715e"># in the &#34;hono&#34; folder containing the source code</span>
 mvn clean install -Pbuild-native-image,metrics-prometheus,jaeger
 </code></pre></div><div class="alert alert-notice">
     <h4 class="alert-heading"><i class="fas fa-info-circle"></i> Experimental</h4>
     <div>Support for <em>native</em> images is an experimental feature. The <code>build-native-image</code> and the <code>build-docker-image</code> profiles are mutually exclusive.
 However, they can be built one after the other.</div>
 </div>
 <h4 id="pushing-images">Pushing Images</h4>
 <p>The container images that are created as part of the build process can be automatically pushed to a container registry using the <code>docker-push-image</code> Maven profile:</p>
 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh">mvn clean install -Pbuild-docker-image,metrics-prometheus,jaeger,docker-push-image
 </code></pre></div><p>Note that the container registry might require authentication in order to push images. The build uses the Docker Maven Plugin for creating and pushing images.
 Please refer to the <a href="http://dmp.fabric8.io/#authentication">plugin documentation</a> for details regarding how to configure credentials for the registry.</p>
 <h2 id="running-the-integration-tests">Running the Integration Tests</h2>
 <p>The source code for Hono comes with a test suite for integration testing. To trigger these tests, change to the <code>tests</code> folder and execute:</p>
 <pre><code># in the &quot;hono/tests&quot; folder containing the test suite
 mvn verify -Prun-tests
 </code></pre><p>The tests are executed against the Docker images of the Hono components. Because of that, it is necessary to build the respective images as
 described above before the execution of the tests. The respective <code>Readme.md</code> file in the folder <code>hono/tests</code> contains more information regarding the test suite.</p>


 <footer class="footline">

 </footer>


         </div>


       </div>

     <div id="navigation">


     </div>

     </section>

     <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
       <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
     </div>
     <script src="/hono/docs/js/clipboard.min.js?1623460255"></script>
     <script src="/hono/docs/js/perfect-scrollbar.min.js?1623460255"></script>
     <script src="/hono/docs/js/perfect-scrollbar.jquery.min.js?1623460255"></script>
     <script src="/hono/docs/js/jquery.sticky.js?1623460255"></script>
     <script src="/hono/docs/js/featherlight.min.js?1623460255"></script>
     <script src="/hono/docs/js/highlight.pack.js?1623460255"></script>
     <script>hljs.initHighlightingOnLoad();</script>
     <script src="/hono/docs/js/modernizr.custom-3.6.0.js?1623460255"></script>
     <script src="/hono/docs/js/learn.js?1623460255"></script>
     <script src="/hono/docs/js/hugo-learn.js?1623460255"></script>

     <link href="/hono/docs/mermaid/mermaid.css?1623460255" rel="stylesheet" />
     <script src="/hono/docs/mermaid/mermaid.js?1623460255"></script>
     <script>
         mermaid.initialize({ startOnLoad: true });
     </script>


 <script>
     (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
             new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
         j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
         'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
     })(window,document,'script','dataLayer','GTM-5WLCZXC');
 </script>


 <script src="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script>

   </body>
 </html>