nautobot 2.3.3__py3-none-any.whl → 2.3.5__py3-none-any.whl

nautobot/project-static/docs/user-guide/administration/configuration/index.html

@@ -14,11 +14,11 @@
         <link rel="prev" href="../migration/migrating-from-postgresql.html">
       
       
-        <link rel="next" href="required-settings.html">
+        <link rel="next" href="settings.html">
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.34">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.35">
     
     
       
@@ -790,7 +790,7 @@
             
   
   <span class="md-ellipsis">
-    Installation Extras
+    Upgrading
   </span>
   
 
@@ -799,115 +799,6 @@
         
         <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_2_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_2_1_2">
-            <span class="md-nav__icon md-icon"></span>
-            Installation Extras
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../installation-extras/docker.html" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Nautobot Docker Images
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../installation-extras/health-checks.html" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Health Checks
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../installation-extras/selinux-troubleshooting.html" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    SELinux Troubleshooting
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_2_1_3" id="__nav_2_1_3_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    Upgrading
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_3">
             <span class="md-nav__icon md-icon"></span>
             Upgrading
           </label>
@@ -972,7 +863,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_3_3" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3" >
         
           
           
@@ -988,14 +879,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_3_3" id="__nav_2_1_3_3_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_2_3" id="__nav_2_1_2_3_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_3_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_3_3">
+        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_2_3_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_2_3">
             <span class="md-nav__icon md-icon"></span>
             Upgrading Nautobot from v1.X to v2.0
           </label>
@@ -1039,7 +930,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_3_3_2" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3_2" >
         
           
           
@@ -1055,14 +946,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_3_3_2" id="__nav_2_1_3_3_2_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_2_3_2" id="__nav_2_1_2_3_2_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_3_3_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_3_3_2">
+        <nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_2_3_2_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_2_3_2">
             <span class="md-nav__icon md-icon"></span>
             IPAM Migration Guide
           </label>
@@ -1193,10 +1084,10 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_3" >
         
           
-          <label class="md-nav__link" for="__nav_2_1_4" id="__nav_2_1_4_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2_1_3" id="__nav_2_1_3_label" tabindex="0">
             
   
   <span class="md-ellipsis">
@@ -1207,8 +1098,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_4">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_3_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_3">
             <span class="md-nav__icon md-icon"></span>
             Migration
           </label>
@@ -1283,7 +1174,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4" checked>
         
           
           
@@ -1299,14 +1190,14 @@
             </a>
             
               
-              <label class="md-nav__link md-nav__link--active" for="__nav_2_1_5" id="__nav_2_1_5_label" tabindex="0">
+              <label class="md-nav__link md-nav__link--active" for="__nav_2_1_4" id="__nav_2_1_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_2_1_5">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_2_1_4">
             <span class="md-nav__icon md-icon"></span>
             Configuration
           </label>
@@ -1319,11 +1210,11 @@
   
   
     <li class="md-nav__item">
-      <a href="required-settings.html" class="md-nav__link">
+      <a href="settings.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Required Settings
+    Settings
   </span>
   
 
@@ -1340,11 +1231,11 @@
   
   
     <li class="md-nav__item">
-      <a href="optional-settings.html" class="md-nav__link">
+      <a href="redis.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Optional Settings
+    Redis
   </span>
   
 
@@ -1392,10 +1283,10 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_5_4" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4_4" >
         
           
-          <label class="md-nav__link" for="__nav_2_1_5_4" id="__nav_2_1_5_4_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2_1_4_4" id="__nav_2_1_4_4_label" tabindex="0">
             
   
   <span class="md-ellipsis">
@@ -1406,8 +1297,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
         
-        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_5_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_5_4">
+        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_4_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_4_4">
             <span class="md-nav__icon md-icon"></span>
             External Authentication
           </label>
@@ -1509,10 +1400,10 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_6" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_5" >
         
           
-          <label class="md-nav__link" for="__nav_2_1_6" id="__nav_2_1_6_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2_1_5" id="__nav_2_1_5_label" tabindex="0">
             
   
   <span class="md-ellipsis">
@@ -1523,8 +1414,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_6_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_6">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_5_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_5">
             <span class="md-nav__icon md-icon"></span>
             Tools
           </label>
@@ -1597,10 +1488,10 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_7" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_6" >
         
           
-          <label class="md-nav__link" for="__nav_2_1_7" id="__nav_2_1_7_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2_1_6" id="__nav_2_1_6_label" tabindex="0">
             
   
   <span class="md-ellipsis">
@@ -1611,8 +1502,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_7_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_7">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_6_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_6">
             <span class="md-nav__icon md-icon"></span>
             Guides
           </label>
@@ -1625,11 +1516,11 @@
   
   
     <li class="md-nav__item">
-      <a href="../guides/caching.html" class="md-nav__link">
+      <a href="../guides/docker.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Caching
+    Nautobot Docker Images
   </span>
   
 
@@ -1646,11 +1537,32 @@
   
   
     <li class="md-nav__item">
-      <a href="../guides/healthcheck.html" class="md-nav__link">
+      <a href="../guides/selinux-troubleshooting.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Health Check
+    SELinux Troubleshooting
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../guides/health-checks.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Health Checks
   </span>
   
 
@@ -8716,15 +8628,6 @@
     </span>
   </a>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#optional-authentication-configuration" class="md-nav__link">
-    <span class="md-ellipsis">
-      Optional Authentication Configuration
-    </span>
-  </a>
-  
 </li>
       
         <li class="md-nav__item">
@@ -8790,7 +8693,7 @@
 <h1 id="nautobot-configuration">Nautobot Configuration<a class="headerlink" href="#nautobot-configuration" title="Permanent link">&para;</a></h1>
 <p>This section describes how to get started with configuring Nautobot.</p>
 <h2 id="initializing-the-configuration">Initializing the Configuration<a class="headerlink" href="#initializing-the-configuration" title="Permanent link">&para;</a></h2>
-<p>An initial configuration can be created by executing <code>nautobot-server init</code>. This will generate a new configuration with all of the default settings provided for you, and will also generate a unique <a href="required-settings.html#secret_key"><code>SECRET_KEY</code></a>.</p>
+<p>An initial configuration can be created by executing <code>nautobot-server init</code>. This will generate a new configuration with all of the default settings provided for you, and will also generate a unique <a href="settings.html#secret_key"><code>SECRET_KEY</code></a>.</p>
 <p>By default (if you haven't set <a href="#nautobot-root-directory"><code>NAUTOBOT_ROOT</code></a> to some other value), the file will be created at <code>$HOME/.nautobot/nautobot_config.py</code>:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>nautobot-server init
 </code></pre></div>
@@ -8837,20 +8740,19 @@
 <p>Do not override <code>NAUTOBOT_ROOT</code> in your <code>nautobot_config.py</code>. It will not work as expected. If you need to customize this setting, please always set the <code>NAUTOBOT_ROOT</code> environment variable.</p>
 </div>
 <h2 id="file-storage">File Storage<a class="headerlink" href="#file-storage" title="Permanent link">&para;</a></h2>
-<p>Nautobot is capable of storing various types of files. This includes <a href="../../platform-functionality/jobs/index.html">Jobs</a>, <a href="../../platform-functionality/gitrepository.html">Git repositories</a>, <a href="../../platform-functionality/imageattachment.html">image attachments</a>, and <a href="optional-settings.html#static_root">static files</a> (CSS, JavaScript, etc.).</p>
+<p>Nautobot is capable of storing various types of files. This includes <a href="../../platform-functionality/jobs/index.html">Jobs</a>, <a href="../../platform-functionality/gitrepository.html">Git repositories</a>, <a href="../../platform-functionality/imageattachment.html">image attachments</a>, and <a href="settings.html#static_root">static files</a> (CSS, JavaScript, etc.).</p>
 <p>Each of the features requiring use of file storage default to being stored in <code>NAUTOBOT_ROOT</code>. If desired, you may customize each one individually. Please see each feature's respective documentation linked above for how to do that.</p>
 <h2 id="configuration-parameters">Configuration Parameters<a class="headerlink" href="#configuration-parameters" title="Permanent link">&para;</a></h2>
 <p>While Nautobot has many configuration settings, only a few of them must be defined at the time of installation. These configuration parameters may be set in <code>nautobot_config.py</code> or by default many of them may also be set by environment variables. Please see the following links for more information:</p>
 <ul>
-<li><a href="required-settings.html">Required settings</a></li>
-<li><a href="optional-settings.html">Optional settings</a></li>
-</ul>
-<h2 id="optional-authentication-configuration">Optional Authentication Configuration<a class="headerlink" href="#optional-authentication-configuration" title="Permanent link">&para;</a></h2>
-<ul>
+<li><a href="settings.html">Settings</a></li>
+<li>Optional Authentication Configuration:<ul>
 <li><a href="authentication/ldap.html">LDAP Authentication</a></li>
 <li><a href="authentication/remote.html">Remote User Authentication</a></li>
 <li><a href="authentication/sso.html">SSO Authentication</a></li>
 </ul>
+</li>
+</ul>
 <h2 id="changing-the-configuration">Changing the Configuration<a class="headerlink" href="#changing-the-configuration" title="Permanent link">&para;</a></h2>
 <p>Configuration settings may be changed at any time. However, the WSGI service (e.g. uWSGI) must be restarted before the changes will take effect. For example, if you're running Nautobot using <code>systemd:</code></p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>sudo systemctl restart nautobot nautobot-worker
@@ -8887,7 +8789,7 @@
 <h3 id="adding-your-own-dependencies">Adding your own dependencies<a class="headerlink" href="#adding-your-own-dependencies" title="Permanent link">&para;</a></h3>
 <div class="admonition warning">
 <p class="admonition-title">Warning</p>
-<p>Be cautious not to confuse extra applications with Nautobot Apps which are installed using the <a href="optional-settings.html#plugins"><code>PLUGINS</code></a> setting. They are similar, but distinctly different!</p>
+<p>Be cautious not to confuse extra applications with Nautobot Apps which are installed using the <a href="settings.html#plugins"><code>PLUGINS</code></a> setting. They are similar, but distinctly different!</p>
 </div>
 <p>Nautobot, being a Django application, allows for installation of additional dependencies utilizing the <a href="https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-INSTALLED_APPS"><code>INSTALLED_APPS</code></a> settings. Due to the highly specialized nature of Nautobot, <em>you cannot safely do this</em>.</p>
 <p>For example, let's assume that you want to install the popular <a href="https://django-health-check.readthedocs.io/en/latest/"><code>django-health-check</code></a> application to your Nautobot deployment which requires you to add one or more <code>health_check</code> entries to your <code>INSTALLED_APPS</code>.</p>
@@ -8915,7 +8817,7 @@
 <a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a>    <span class="o">...</span>
 <a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a><span class="p">]</span>
 </code></pre></div>
-<p>For more information on installing extra applications, please see the documentation on <a href="optional-settings.html#extra-applications">Extra Applications</a>.</p>
+<p>For more information on installing extra applications, please see the documentation on <a href="settings.html#extra-applications">Extra Applications</a>.</p>
 <p>For more information on installing or developing Nautobot Apps, please see the <a href="../../../apps/index.html">documentation on Apps</a>.</p>
 
 
@@ -8965,13 +8867,13 @@
         
         
           
-          <a href="required-settings.html" class="md-footer__link md-footer__link--next" aria-label="Next: Required Settings">
+          <a href="settings.html" class="md-footer__link md-footer__link--next" aria-label="Next: Settings">
             <div class="md-footer__title">
               <span class="md-footer__direction">
                 Next
               </span>
               <div class="md-ellipsis">
-                Required Settings
+                Settings
               </div>
             </div>
             <div class="md-footer__button md-icon">
@@ -9060,7 +8962,7 @@
     </div>
     
     
-    <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.07f07601.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
+    <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
       <script src="../../../assets/javascripts/bundle.56dfad97.min.js"></script>