docs/admin-guide/mongodb-device-registry-config/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>MongoDB Based Device Registry Configuration :: Eclipse Hono&trade;</title>


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

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

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

     <script src="/hono/docs/js/jquery-3.3.1.min.js?1626138712"></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="MongoDB Based Device Registry Configuration :: 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="MongoDB Based Device Registry Configuration :: Eclipse Hono&amp;trade;" />
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://www.eclipse.org/hono/docs/admin-guide/mongodb-device-registry-config//" />
 <meta property="og:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png" />

   </head>
   <body class="" data-url="/hono/docs/admin-guide/mongodb-device-registry-config/">
     <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?1626138712"></script>
 <script type="text/javascript" src="/hono/docs/js/auto-complete.js?1626138712"></script>
 <script type="text/javascript">

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

 </script>
 <script type="text/javascript" src="/hono/docs/js/search.js?1626138712"></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
         parent


         ">
       <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 active">
         <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


         ">
       <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 ">
         <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/admin-guide/mongodb-device-registry-config/" selected>stable (1.8)</option>


                       <option id="1.8" value="https://www.eclipse.org/hono/docs/1.8/admin-guide/mongodb-device-registry-config/">1.8</option>


                       <option id="1.7" value="https://www.eclipse.org/hono/docs/1.7/admin-guide/mongodb-device-registry-config/">1.7</option>


                       <option id="1.6" value="https://www.eclipse.org/hono/docs/1.6/admin-guide/mongodb-device-registry-config/">1.6</option>


                       <option id="1.5" value="https://www.eclipse.org/hono/docs/1.5/admin-guide/mongodb-device-registry-config/">1.5</option>


                       <option id="1.4" value="https://www.eclipse.org/hono/docs/1.4/admin-guide/mongodb-device-registry-config/">1.4</option>


                       <option id="1.3" value="https://www.eclipse.org/hono/docs/1.3/admin-guide/mongodb-device-registry-config/">1.3</option>


                       <option id="dev" value="https://www.eclipse.org/hono/docs/dev/admin-guide/mongodb-device-registry-config/">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/admin-guide/mongodb-device-registry-config.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/admin-guide/'>Admin Guide</a> > MongoDB Based Device Registry Configuration


                   </span>
                 </div>

                     <div class="progress">
     <div class="wrapper">
 <nav id="TableOfContents">
   <ul>
     <li><a href="#service-configuration">Service Configuration</a></li>
     <li><a href="#port-configuration">Port Configuration</a></li>
     <li><a href="#authentication-service-connection-configuration">Authentication Service Connection Configuration</a></li>
     <li><a href="#metrics-configuration">Metrics Configuration</a></li>
   </ul>
 </nav>
     </div>
 </div>


               </div>
             </div>

         <div id="head-tags">

         </div>

         <div id="body-inner">

             <h1>

               MongoDB Based Device Registry Configuration
             </h1>


 <p>The MongoDB based Device Registry component provides an implementation of Eclipse Hono™&rsquo;s <a href="/hono/docs/api/device-registration/">Device Registration</a>,
 <a href="/hono/docs/api/credentials/">Credentials</a> and <a href="/hono/docs/api/tenant/">Tenant</a> APIs. Protocol adapters use these APIs to determine a device&rsquo;s registration status, e.g. if it is enabled and if it is registered with a particular tenant, and to authenticate a device before accepting any data for processing from it. In addition to the above, this Device Registry also provides an implementation of <a href="/hono/docs/api/management/">Device Registry Management APIs</a> for managing tenants, registration information and credentials of devices.</p>
 <p>The Device Registry is implemented as a Spring Boot application, and the data is persisted in a MongoDB database. It can be run either directly from the command line or by means of starting the corresponding <a href="https://hub.docker.com/r/eclipse/hono-service-device-registry-mongodb/">Docker image</a> created from it.</p>
 <h2 id="service-configuration">Service Configuration</h2>
 <p>The following table provides an overview of the configuration variables and corresponding command line options for configuring the MongoDB based Device Registry. In addition to the following options, this component also supports the options described in <a href="/hono/docs/admin-guide/common-config/">Common Configuration</a>.</p>
 <table>
 <thead>
 <tr>
 <th style="text-align:left">Environment Variable<br>Command Line Option</th>
 <th style="text-align:center">Mandatory</th>
 <th style="text-align:left">Default</th>
 <th style="text-align:left">Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td style="text-align:left"><code>HONO_CREDENTIALS_SVC_CACHE_MAX_AGE</code><br><code>--hono.credentials.svc.cacheMaxAge</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>180</code></td>
 <td style="text-align:left">The maximum period of time (seconds) that information returned by the service&rsquo;s operations may be cached for.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_CREDENTIALS_SVC_COLLECTION_NAME</code><br><code>--hono.credentials.svc.collectionName</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>credentials</code></td>
 <td style="text-align:left">The name of the MongoDB collection where the server stores credentials of devices.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_CREDENTIALS_SVC_HASH_ALGORITHMS_WHITELIST</code><br><code>--hono.credentials.svc.hashAlgorithmsWhitelist</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>empty</code></td>
 <td style="text-align:left">An array of supported hashing algorithms to be used with the <code>hashed-password</code> type of credentials. When not set, all values will be accepted.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_CREDENTIALS_SVC_MAXBCRYPTCOSTFACTOR</code><br><code>--hono.credentials.svc.maxBcryptCostFactor</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>10</code></td>
 <td style="text-align:left">The maximum cost factor that is supported in password hashes using the BCrypt hash function. This limit is enforced by the device registry when adding or updating corresponding credentials. Increasing this number allows for potentially more secure password hashes to be used. However, the time required to compute the hash increases exponentially with the cost factor.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_CREDENTIALS_SVC_MAX_BCRYPT_ITERATIONS</code><br><code>--hono.credentials.svc.maxBcryptIterations</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>10</code></td>
 <td style="text-align:left">DEPRECATED Please use <code>HONO_CREDENTIALS_SVC_MAXBCRYPTCOSTFACTOR</code> instead.<br>The maximum cost factor that is supported in password hashes using the BCrypt hash function. This limit is enforced by the device registry when adding or updating corresponding credentials. Increasing this number allows for potentially more secure password hashes to be used. However, the time required to compute the hash increases exponentially with the cost factor.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_CREDENTIALS_SVC_MODIFICATION_ENABLED</code><br><code>--hono.credentials.svc.modificationEnabled</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>true</code></td>
 <td style="text-align:left">When set to <code>false</code> the credentials contained in the registry cannot be updated nor removed.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_CREDENTIALS_SVC_RECEIVER_LINK_CREDIT</code><br><code>--hono.credentials.svc.receiverLinkCredit</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>100</code></td>
 <td style="text-align:left">The number of credits to flow to a client connecting to the Credentials endpoint.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_MONGODB_CONNECTION_STRING</code><br><code>--hono.mongodb.connectionString</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The connection string used by the Device Registry application to connect to the MongoDB database. If <code>HONO_MONGODB_CONNECTION_STRING</code> is set, it overrides the other MongoDB connection settings.<br> See <a href="https://docs.mongodb.com/manual/reference/connection-string/">Connection String URI Format</a> for more information.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_MONGODB_CONNECTION_TIMEOUT_IN_MS</code><br><code>--hono.mongodb.connectionTimeoutInMs</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>10000</code></td>
 <td style="text-align:left">The time in milliseconds to attempt a connection before timing out.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_MONGODB_DB_NAME</code><br><code>--hono.mongodb.dbName</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The name of the MongoDB database that should be used by the Device Registry application.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_MONGODB_HOST</code><br><code>--hono.mongodb.host</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>localhost</code></td>
 <td style="text-align:left">The host name or IP address of the MongoDB instance.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_MONGODB_PORT</code><br><code>--hono.mongodb.port</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>27017</code></td>
 <td style="text-align:left">The port that the MongoDB instance is listening on.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_MONGODB_PASSWORD</code><br><code>--hono.mongodb.password</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The password to use for authenticating to the MongoDB instance.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_MONGODB_SERVER_SELECTION_TIMEOUT_IN_MS</code><br><code>--hono.mongodb.serverSelectionTimeoutInMs</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>1000</code></td>
 <td style="text-align:left">The time in milliseconds that the mongo driver will wait to select a server for an operation before raising an error.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_MONGODB_USERNAME</code><br><code>--hono.mongodb.username</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The user name to use for authenticating to the MongoDB instance.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_AMQP_BIND_ADDRESS</code><br><code>--hono.registry.amqp.bindAddress</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>127.0.0.1</code></td>
 <td style="text-align:left">The IP address of the network interface that the secure AMQP port should be bound to.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_AMQP_CERT_PATH</code><br><code>--hono.registry.amqp.certPath</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The absolute path to the PEM file containing the certificate that the server should use for authenticating to clients. This option must be used in conjunction with <code>HONO_REGISTRY_AMQP_KEY_PATH</code>.<br>Alternatively, the <code>HONO_REGISTRY_AMQP_KEY_STORE_PATH</code> option can be used to configure a key store containing both the key as well as the certificate.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_AMQP_INSECURE_PORT</code><br><code>--hono.registry.amqp.insecurePort</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The insecure port the server should listen on for AMQP 1.0 connections.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_AMQP_INSECURE_PORT_BIND_ADDRESS</code><br><code>--hono.registry.amqp.insecurePortBindAddress</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>127.0.0.1</code></td>
 <td style="text-align:left">The IP address of the network interface that the insecure AMQP port should be bound to.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_AMQP_INSECURE_PORT_ENABLED</code><br><code>--hono.registry.amqp.insecurePortEnabled</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>false</code></td>
 <td style="text-align:left">If set to <code>true</code> the server will open an insecure port (not secured by TLS) using either the port number set via <code>HONO_REGISTRY_AMQP_INSECURE_PORT</code> or the default AMQP port number (<code>5672</code>) if not set explicitly.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_AMQP_KEY_PATH</code><br><code>--hono.registry.amqp.keyPath</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The absolute path to the (PKCS8) PEM file containing the private key that the server should use for authenticating to clients. This option must be used in conjunction with <code>HONO_REGISTRY_AMQP_CERT_PATH</code>. Alternatively, the <code>HONO_REGISTRY_AMQP_KEY_STORE_PATH</code> option can be used to configure a key store containing both the key as well as the certificate.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_AMQP_KEY_STORE_PASSWORD</code><br><code>--hono.registry.amqp.keyStorePassword</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The password required to read the contents of the key store.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_AMQP_KEY_STORE_PATH</code><br><code>--hono.registry.amqp.keyStorePath</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The absolute path to the Java key store containing the private key and certificate that the server should use for authenticating to clients. Either this option or the <code>HONO_REGISTRY_AMQP_KEY_PATH</code> and <code>HONO_REGISTRY_AMQP_CERT_PATH</code> options need to be set in order to enable TLS secured connections with clients. The key store format can be either <code>JKS</code> or <code>PKCS12</code> indicated by a <code>.jks</code> or <code>.p12</code> file suffix respectively.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_AMQP_NATIVE_TLS_REQUIRED</code><br><code>--hono.registry.amqp.nativeTlsRequired</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>false</code></td>
 <td style="text-align:left">The server will probe for OpenSLL on startup if a secure port is configured. By default, the server will fall back to the JVM&rsquo;s default SSL engine if not available. However, if set to <code>true</code>, the server will fail to start at all in this case.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_AMQP_PORT</code><br><code>--hono.registry.amqp.port</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>5671</code></td>
 <td style="text-align:left">The secure port that the server should listen on for AMQP 1.0 connections.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_AMQP_SECUREPROTOCOLS</code><br><code>--hono.registry.amqp.secureProtocols</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>TLSv1.3,TLSv1.2</code></td>
 <td style="text-align:left">A (comma separated) list of secure protocols (in order of preference) that are supported when negotiating TLS sessions. Please refer to the <a href="https://vertx.io/docs/vertx-core/java/#ssl">vert.x documentation</a> for a list of supported protocol names.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_AMQP_SUPPORTEDCIPHERSUITES</code><br><code>--hono.registry.amqp.supportedCipherSuites</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">A (comma separated) list of names of cipher suites (in order of preference) that are supported when negotiating TLS sessions. Please refer to <a href="https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names">JSSE Cipher Suite Names</a> for a list of supported names.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_AUTHENTICATION_REQUIRED</code><br><code>--hono.registry.http.authenticationRequired</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>true</code></td>
 <td style="text-align:left">If set to <code>true</code> the HTTP endpoint of the Device Registry requires clients to authenticate when connecting to the Device Registry. The MongoDB based Device Registry currently supports basic authentication and the user credentials are to be stored in a MongoDB collection with name <code>user</code>. <br>For more information on how to manage users please refer to <a href="https://vertx.io/docs/vertx-auth-mongo/java/">Mongo Auth Provider</a>.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_BIND_ADDRESS</code><br><code>--hono.registry.http.bindAddress</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>127.0.0.1</code></td>
 <td style="text-align:left">The IP address of the network interface that the secure HTTP port should be bound to.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_CERT_PATH</code><br><code>--hono.registry.http.certPath</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The absolute path to the PEM file containing the certificate that the server should use for authenticating to clients. This option must be used in conjunction with <code>HONO_REGISTRY_HTTP_KEY_PATH</code>.<br>Alternatively, the <code>HONO_REGISTRY_HTTP_KEY_STORE_PATH</code> option can be used to configure a key store containing both the key as well as the certificate.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_DEVICE_ID_PATTERN</code><br><code>--hono.registry.http.deviceIdPattern</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>^[a-zA-Z0-9-_\.:]+$</code></td>
 <td style="text-align:left">The regular expression to use to validate device ID. Please refer to the <a href="https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html">java pattern documentation</a>.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_INSECURE_PORT</code><br><code>--hono.registry.http.insecurePort</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The insecure port the server should listen on for HTTP requests.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_INSECURE_PORT_BIND_ADDRESS</code><br><code>--hono.registry.http.insecurePortBindAddress</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>127.0.0.1</code></td>
 <td style="text-align:left">The IP address of the network interface that the insecure HTTP port should be bound to.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_INSECURE_PORT_ENABLED</code><br><code>--hono.registry.http.insecurePortEnabled</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>false</code></td>
 <td style="text-align:left">If set to <code>true</code> the server will open an insecure port (not secured by TLS) using either the port number set via <code>HONO_REGISTRY_HTTP_INSECURE_PORT</code> or the default AMQP port number (<code>5672</code>) if not set explicitly.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_KEY_PATH</code><br><code>--hono.registry.http.keyPath</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The absolute path to the (PKCS8) PEM file containing the private key that the server should use for authenticating to clients. This option must be used in conjunction with <code>HONO_REGISTRY_HTTP_CERT_PATH</code>. Alternatively, the <code>HONO_REGISTRY_HTTP_KEY_STORE_PATH</code> option can be used to configure a key store containing both the key as well as the certificate.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_KEY_STORE_PASSWORD</code><br><code>--hono.registry.http.keyStorePassword</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The password required to read the contents of the key store.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_KEY_STORE_PATH</code><br><code>--hono.registry.http.keyStorePath</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">The absolute path to the Java key store containing the private key and certificate that the server should use for authenticating to clients. Either this option or the <code>HONO_REGISTRY_HTTP_KEY_PATH</code> and <code>HONO_REGISTRY_HTTP_CERT_PATH</code> options need to be set in order to enable TLS secured connections with clients. The key store format can be either <code>JKS</code> or <code>PKCS12</code> indicated by a <code>.jks</code> or <code>.p12</code> file suffix respectively.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_MAXPAYLOADSIZE</code><br><code>--hono.registry.http.maxPayloadSize</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>16000</code></td>
 <td style="text-align:left">The maximum size of an HTTP request body in bytes that is accepted by the registry.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_PORT</code><br><code>--hono.registry.http.port</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>5671</code></td>
 <td style="text-align:left">The secure port that the server should listen on for HTTP requests.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_SECUREPROTOCOLS</code><br><code>--hono.registry.http.secureProtocols</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>TLSv1.3,TLSv1.2</code></td>
 <td style="text-align:left">A (comma separated) list of secure protocols (in order of preference) that are supported when negotiating TLS sessions. Please refer to the <a href="https://vertx.io/docs/vertx-core/java/#ssl">vert.x documentation</a> for a list of supported protocol names.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_SUPPORTEDCIPHERSUITES</code><br><code>--hono.registry.http.supportedCipherSuites</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left">-</td>
 <td style="text-align:left">A (comma separated) list of names of cipher suites (in order of preference) that are supported when negotiating TLS sessions. Please refer to <a href="https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names">JSSE Cipher Suite Names</a> for a list of supported names.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_HTTP_TENANT_ID_PATTERN</code><br><code>--hono.registry.http.tenantIdPattern</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>^[a-zA-Z0-9-_\.]+$</code></td>
 <td style="text-align:left">The regular expression to use to validate tenant ID. Please refer to the <a href="https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html">java pattern documentation</a>.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_SVC_CACHE_MAX_AGE</code><br><code>--hono.registry.svc.cacheMaxAge</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>180</code></td>
 <td style="text-align:left">The maximum period of time (seconds) that information returned by the service&rsquo;s operations may be cached for.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_SVC_COLLECTION_NAME</code><br><code>--hono.registry.svc.collectionName</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>devices</code></td>
 <td style="text-align:left">The name of the MongoDB collection where the server stores registered device information.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_SVC_MAX_DEVICES_PER_TENANT</code><br><code>--hono.registry.svc.maxDevicesPerTenant</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>-1</code></td>
 <td style="text-align:left">The number of devices that can be registered for each tenant. It is an error to set this property to a value &lt; -1. The value <code>-1</code> indicates that no limit is set.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_SVC_MODIFICATION_ENABLED</code><br><code>--hono.registry.svc.modificationEnabled</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>true</code></td>
 <td style="text-align:left">When set to <code>false</code> the device information contained in the registry cannot be updated nor removed from the registry.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_REGISTRY_SVC_RECEIVER_LINK_CREDIT</code><br><code>--hono.registry.svc.receiverLinkCredit</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>100</code></td>
 <td style="text-align:left">The number of credits to flow to a client connecting to the Device Registration endpoint.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_TENANT_SVC_CACHE_MAX_AGE</code><br><code>--hono.tenant.svc.cacheMaxAge</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>180</code></td>
 <td style="text-align:left">The maximum period of time (seconds) that information returned by the service&rsquo;s operations may be cached for.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_TENANT_SVC_COLLECTION_NAME</code><br><code>--hono.tenant.svc.collectionName</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>tenants</code></td>
 <td style="text-align:left">The name of the MongoDB collection where the server stores tenants information.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_TENANT_SVC_MODIFICATION_ENABLED</code><br><code>--hono.tenant.svc.modificationEnabled</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>true</code></td>
 <td style="text-align:left">When set to <code>false</code> the tenants contained in the registry cannot be updated nor removed.</td>
 </tr>
 <tr>
 <td style="text-align:left"><code>HONO_TENANT_SVC_RECEIVER_LINK_CREDIT</code><br><code>--hono.tenant.svc.receiverLinkCredit</code></td>
 <td style="text-align:center">no</td>
 <td style="text-align:left"><code>100</code></td>
 <td style="text-align:left">The number of credits to flow to a client connecting to the Tenant endpoint.</td>
 </tr>
 </tbody>
 </table>
 <p>The variables only need to be set if the default value does not match your environment.</p>
 <h2 id="port-configuration">Port Configuration</h2>
 <p>The Device Registry supports configuration of both, an AMQP based endpoint as well as an HTTP based endpoint proving RESTful resources for managing registration information and credentials. Both endpoints can be configured to listen for connections on</p>
 <ul>
 <li>a secure port only (default) or</li>
 <li>an insecure port only or</li>
 <li>both a secure and an insecure port (dual port configuration)</li>
 </ul>
 <p>See <a href="/hono/docs/admin-guide/file-based-device-registry-config/#port-configuration">Port Configuration</a> for more information.</p>
 <div class="alert alert-notice">
     <h4 class="alert-heading"><i class="fas fa-info-circle"></i> Note</h4>
     <div>The environment variables to use for configuring the REST endpoint are the same as the ones for the AMQP endpoint, substituting <code>_AMQP_</code> with <code>_HTTP_</code>.</div>
 </div>
 <h2 id="authentication-service-connection-configuration">Authentication Service Connection Configuration</h2>
 <p>See <a href="/hono/docs/admin-guide/file-based-device-registry-config/#authentication-service-connection-configuration">Authentication Service Connection Configuration</a> for more information.</p>
 <h2 id="metrics-configuration">Metrics Configuration</h2>
 <p>See <a href="/hono/docs/admin-guide/monitoring-tracing-config/">Monitoring &amp; Tracing Admin Guide</a> for details on how to configure the reporting of metrics.</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?1626138714"></script>
     <script src="/hono/docs/js/perfect-scrollbar.min.js?1626138714"></script>
     <script src="/hono/docs/js/perfect-scrollbar.jquery.min.js?1626138714"></script>
     <script src="/hono/docs/js/jquery.sticky.js?1626138714"></script>
     <script src="/hono/docs/js/featherlight.min.js?1626138714"></script>
     <script src="/hono/docs/js/highlight.pack.js?1626138714"></script>
     <script>hljs.initHighlightingOnLoad();</script>
     <script src="/hono/docs/js/modernizr.custom-3.6.0.js?1626138714"></script>
     <script src="/hono/docs/js/learn.js?1626138714"></script>
     <script src="/hono/docs/js/hugo-learn.js?1626138714"></script>

     <link href="/hono/docs/mermaid/mermaid.css?1626138714" rel="stylesheet" />
     <script src="/hono/docs/mermaid/mermaid.js?1626138714"></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>