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

nautobot/project-static/docs/user-guide/administration/installation/nautobot.html

@@ -1006,7 +1006,7 @@
             
   
   <span class="md-ellipsis">
-    Installation Extras
+    Upgrading
   </span>
   
 
@@ -1015,115 +1015,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>
@@ -1188,7 +1079,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" >
         
           
           
@@ -1204,14 +1095,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>
@@ -1255,7 +1146,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" >
         
           
           
@@ -1271,14 +1162,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>
@@ -1409,10 +1300,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">
@@ -1423,8 +1314,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>
@@ -1497,7 +1388,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4" >
         
           
           
@@ -1513,14 +1404,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_5" id="__nav_2_1_5_label" tabindex="0">
+              <label class="md-nav__link " 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="false">
-          <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="false">
+          <label class="md-nav__title" for="__nav_2_1_4">
             <span class="md-nav__icon md-icon"></span>
             Configuration
           </label>
@@ -1533,11 +1424,11 @@
   
   
     <li class="md-nav__item">
-      <a href="../configuration/required-settings.html" class="md-nav__link">
+      <a href="../configuration/settings.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Required Settings
+    Settings
   </span>
   
 
@@ -1554,11 +1445,11 @@
   
   
     <li class="md-nav__item">
-      <a href="../configuration/optional-settings.html" class="md-nav__link">
+      <a href="../configuration/redis.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Optional Settings
+    Redis
   </span>
   
 
@@ -1606,10 +1497,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">
@@ -1620,8 +1511,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>
@@ -1723,10 +1614,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">
@@ -1737,8 +1628,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>
@@ -1811,10 +1702,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">
@@ -1825,8 +1716,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>
@@ -1839,11 +1730,32 @@
   
   
     <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>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../guides/selinux-troubleshooting.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    SELinux Troubleshooting
   </span>
   
 
@@ -1860,11 +1772,11 @@
   
   
     <li class="md-nav__item">
-      <a href="../guides/healthcheck.html" class="md-nav__link">
+      <a href="../guides/health-checks.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Health Check
+    Health Checks
   </span>
   
 
@@ -9233,28 +9145,31 @@
 </details>
 <details class="version-added">
 <summary>Added in version 1.6.0 — Installation metrics selection</summary>
-<p>The <code>nautobot-server init</code> command will now prompt you to set the initial value for the <a href="../configuration/optional-settings.html#installation_metrics_enabled"><code>INSTALLATION_METRICS_ENABLED</code></a> setting. See the <a href="../tools/nautobot-server.html#send_installation_metrics"><code>send_installation_metrics</code></a> command for more information about the feature that this setting toggles.</p>
+<p>The <code>nautobot-server init</code> command will now prompt you to set the initial value for the <a href="../configuration/settings.html#installation_metrics_enabled"><code>INSTALLATION_METRICS_ENABLED</code></a> setting. See the <a href="../tools/nautobot-server.html#send_installation_metrics"><code>send_installation_metrics</code></a> command for more information about the feature that this setting toggles.</p>
 </details>
 <h3 id="required-settings">Required Settings<a class="headerlink" href="#required-settings" title="Permanent link">&para;</a></h3>
-<p>Your <code>nautobot_config.py</code> provides sane defaults for all of the configuration settings. You will inevitably need to update the settings for your environment, most notably the <a href="../configuration/required-settings.html#databases"><code>DATABASES</code></a> setting. If you do not wish to modify the config, by default, many of these configuration settings can also be specified by environment variables. Please see <a href="../configuration/required-settings.html">Required Settings</a> for further details.</p>
-<p>Edit <code>$NAUTOBOT_ROOT/nautobot_config.py</code>, and head over to the documentation on <a href="../configuration/required-settings.html">Required Settings</a> to tweak your required settings. At a minimum, you'll need to update the following settings:</p>
+<p>Your <code>nautobot_config.py</code> provides sane defaults for most configuration settings, but in the longer term, you will inevitably need to update the settings for your environment. For a more complete guide to supported configuration settings in Nautobot, you can refer to <a href="../configuration/settings.html">Settings</a> later.</p>
+<div class="admonition tip">
+<p class="admonition-title">Environment variables</p>
+<p>If you do not wish to modify the config file directly, many of these configuration settings can also be specified by environment variables, such as <code>NAUTOBOT_ALLOWED_HOSTS</code>, <code>NAUTOBOT_DB_USER</code>, etc.</p>
+</div>
+<p>Edit <code>$NAUTOBOT_ROOT/nautobot_config.py</code>. At a minimum, you'll need to update the following settings:</p>
 <ul>
-<li><a href="../configuration/required-settings.html#allowed_hosts"><code>ALLOWED_HOSTS</code></a>: You must set this value. This can be set to <code>["*"]</code> for a quick start, but this value is not suitable for production deployment.</li>
-<li><a href="../configuration/required-settings.html#databases"><code>DATABASES</code></a>: Database connection parameters, see below.</li>
-<li><a href="../configuration/required-settings.html#redis-settings">Redis settings</a>: Redis configuration requires multiple settings, if different from the defaults. If you installed Redis on the same system as Nautobot, you most likely do not need to change these settings.</li>
+<li><a href="../configuration/settings.html#allowed_hosts"><code>ALLOWED_HOSTS</code></a>: You must set this value. This can be set to <code>["*"]</code> for a quick start, but this value is not suitable for production deployment.</li>
+<li><a href="../configuration/settings.html#databases"><code>DATABASES</code></a>: Database connection parameters, see below.</li>
 </ul>
 <div class="tabbed-set tabbed-alternate" data-tabs="3:2"><input checked="checked" id="__tabbed_3_1" name="__tabbed_3" type="radio" /><input id="__tabbed_3_2" name="__tabbed_3" type="radio" /><div class="tabbed-labels"><label for="__tabbed_3_1">PostgreSQL</label><label for="__tabbed_3_2">MySQL</label></div>
 <div class="tabbed-content">
 <div class="tabbed-block">
 <ul>
-<li>At a minimum, you'll need to update the <code>"USER"</code> and <code>"PASSWORD"</code> fields under <code>DATABASES</code>. Depending on your security posture, you may wish to set these via environment variables (<code>NAUTOBOT_DB_USER</code> and <code>NAUTOBOT_DB_PASSWORD</code>) rather than writing them directly into your <code>nautobot_config.py</code>. Most Nautobot configuration settings can be set by environment variables if preferred.</li>
+<li>At a minimum, you'll need to update the <code>"USER"</code> and <code>"PASSWORD"</code> fields under <code>DATABASES</code>. Depending on your security posture, you may wish to set these via environment variables (<code>NAUTOBOT_DB_USER</code> and <code>NAUTOBOT_DB_PASSWORD</code>) rather than writing them directly into your <code>nautobot_config.py</code>.</li>
 </ul>
 </div>
 <div class="tabbed-block">
 <ul>
-<li>At a minimum, you'll need to update the <code>"USER"</code> and <code>"PASSWORD"</code> fields under <code>DATABASES</code>. Depending on your security posture, you may wish to set these via environment variables (<code>NAUTOBOT_DB_USER</code> and <code>NAUTOBOT_DB_PASSWORD</code>) rather than writing them directly into your <code>nautobot_config.py</code>. Most Nautobot configuration settings can be set by environment variables if preferred.</li>
+<li>At a minimum, you'll need to update the <code>"USER"</code> and <code>"PASSWORD"</code> fields under <code>DATABASES</code>. Depending on your security posture, you may wish to set these via environment variables (<code>NAUTOBOT_DB_USER</code> and <code>NAUTOBOT_DB_PASSWORD</code>) rather than writing them directly into your <code>nautobot_config.py</code>.</li>
 <li>Additionally, since Nautobot's configuration defaults to assuming PostgreSQL, you must change the <code>"ENGINE"</code> setting from <code>django.db.backends.postgresql</code> to <code>django.db.backends.mysql</code>.</li>
-<li>If you want to enable support for Unicode text, including emojis, please make sure to include <code>"OPTIONS": {"charset": "utf8mb4"}</code>. Refer to the <a href="../configuration/required-settings.html#databases">configuration guide on MySQL Unicode settings</a> for more information.</li>
+<li>If you want to enable support for Unicode text, including emojis, please make sure to include <code>"OPTIONS": {"charset": "utf8mb4"}</code>. Refer to the <a href="../configuration/settings.html#databases">configuration guide on MySQL Unicode settings</a> for more information.</li>
 </ul>
 </div>
 </div>
@@ -9272,12 +9187,12 @@
 <summary>Examples of <code>local_requirements.txt</code></summary>
 <p>We will cover two examples of common optional settings below.</p>
 <p><a name="napalm"><h4>NAPALM</h4></a></p>
-<p>Nautobot provides built-in support for the <a href="https://github.com/napalm-automation/napalm/">NAPALM automation</a> library, which allows Nautobot to fetch live data from devices and return it to a requester via its REST API. The <a href="../configuration/optional-settings.html#napalm_username"><code>NAPALM_USERNAME</code></a> and <a href="../configuration/optional-settings.html#napalm_password"><code>NAPALM_PASSWORD</code></a> configuration parameters define the credentials to be used when connecting to a device.</p>
+<p>Nautobot provides built-in support for the <a href="https://github.com/napalm-automation/napalm/">NAPALM automation</a> library, which allows Nautobot to fetch live data from devices and return it to a requester via its REST API. The <a href="../configuration/settings.html#napalm_username"><code>NAPALM_USERNAME</code></a> and <a href="../configuration/settings.html#napalm_password"><code>NAPALM_PASSWORD</code></a> configuration parameters define the credentials to be used when connecting to a device.</p>
 <p>To use NAPALM, add <code>nautobot[napalm]</code> to your <code>local_requirements.txt</code> so that it can be installed and kept up to date:</p>
 <div class="highlight"><span class="filename">Add napalm to the local_requirements.txt file</span><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a>echo &quot;nautobot[napalm]&quot; &gt;&gt; $NAUTOBOT_ROOT/local_requirements.txt
 </code></pre></div>
 <p><a name="remote-file-storage"><h4>Remote File Storage</h4></a></p>
-<p>By default, Nautobot will use the local filesystem to store uploaded files. To use a remote filesystem, install the <a href="https://django-storages.readthedocs.io/en/stable/"><code>django-storages</code></a> library and configure your <a href="../configuration/optional-settings.html#storage_backend">desired storage backend</a> in <code>nautobot_config.py</code>.</p>
+<p>By default, Nautobot will use the local filesystem to store uploaded files. To use a remote filesystem, install the <a href="https://django-storages.readthedocs.io/en/stable/"><code>django-storages</code></a> library and configure your <a href="../configuration/settings.html#storage_backend">desired storage backend</a> in <code>nautobot_config.py</code>.</p>
 <p>To use remote file storage, add <code>nautobot[remote_storage]</code> to your <code>local_requirements.txt</code> so that it can be installed and kept up to date:</p>
 <div class="highlight"><span class="filename">Add remote storage to local_requirements.txt</span><pre><span></span><code><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a>echo &quot;nautobot[remote_storage]&quot; &gt;&gt; $NAUTOBOT_ROOT/local_requirements.txt
 </code></pre></div>
@@ -9305,8 +9220,8 @@
 <ul>
 <li><code>git</code> - For storing <a href="../../platform-functionality/gitrepository.html">Git repositories</a></li>
 <li><code>jobs</code> - For storing <a href="../../platform-functionality/jobs/index.html">custom Jobs</a></li>
-<li><code>media</code> - For storing <a href="../configuration/optional-settings.html#media_root">uploaded images and attachments</a> (such as device type images)</li>
-<li><code>static</code> - The home for <a href="../configuration/optional-settings.html#static_root">CSS, JavaScript, and images</a> used to serve the web interface</li>
+<li><code>media</code> - For storing <a href="../configuration/settings.html#media_root">uploaded images and attachments</a> (such as device type images)</li>
+<li><code>static</code> - The home for <a href="../configuration/settings.html#static_root">CSS, JavaScript, and images</a> used to serve the web interface</li>
 </ul>
 <p>Each of these have their own corresponding setting that defined in <code>nautobot_config.py</code>, but by default they will all be placed in <code>NAUTOBOT_ROOT</code> unless you tell Nautobot otherwise by customizing their unique variable.</p>
 <p>The <code>collectstatic</code> command will create these directories if they do not exist, and in the case of the <code>static</code> files directory, it will also copy the appropriate files:</p>

nautobot/project-static/docs/user-guide/administration/installation/selinux-troubleshooting.html

@@ -4,10 +4,10 @@
 <head>
     <meta charset="utf-8">
     <title>Redirecting...</title>
-    <link rel="canonical" href="../installation-extras/selinux-troubleshooting.html">
+    <link rel="canonical" href="../guides/selinux-troubleshooting.html">
     <meta name="robots" content="noindex">
-    <script>var anchor=window.location.hash.substr(1);location.href="../installation-extras/selinux-troubleshooting.html"+(anchor?"#"+anchor:"")</script>
-    <meta http-equiv="refresh" content="0; url=../installation-extras/selinux-troubleshooting.html">
+    <script>var anchor=window.location.hash.substr(1);location.href="../guides/selinux-troubleshooting.html"+(anchor?"#"+anchor:"")</script>
+    <meta http-equiv="refresh" content="0; url=../guides/selinux-troubleshooting.html">
 </head>
 <body>
 Redirecting...