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

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

@@ -18,7 +18,7 @@
       
       
       <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 " 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="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>
   
 
@@ -1394,10 +1285,10 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_5_4" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4_4" checked>
         
           
-          <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">
@@ -1408,8 +1299,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="true">
-          <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="true">
+          <label class="md-nav__title" for="__nav_2_1_4_4">
             <span class="md-nav__icon md-icon"></span>
             External Authentication
           </label>
@@ -1812,10 +1703,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">
@@ -1826,8 +1717,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>
@@ -1900,10 +1791,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">
@@ -1914,8 +1805,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>
@@ -1928,11 +1819,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>
   
 
@@ -1949,11 +1861,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>
   
 
@@ -9355,7 +9267,7 @@ To accomplish this, Nautobot comes preinstalled with the <a href="https://python
 <p>By default, once authenticated, if the user has never logged in before a new user account will be created for the user.
 This new user will not be a member of any group or have any permissions assigned. If you would like to create users with
 a default set of permissions there are some additional variables to configure the permissions.</p>
-<p>Please see the documentation on <a href="../optional-settings.html#external_auth_default_groups"><code>EXTERNAL_AUTH_DEFAULT_GROUPS</code></a> and <a href="../optional-settings.html#external_auth_default_permissions"><code>EXTERNAL_AUTH_DEFAULT_PERMISSIONS</code></a> for more information.</p>
+<p>Please see the documentation on <a href="../settings.html#external_auth_default_groups"><code>EXTERNAL_AUTH_DEFAULT_GROUPS</code></a> and <a href="../settings.html#external_auth_default_permissions"><code>EXTERNAL_AUTH_DEFAULT_PERMISSIONS</code></a> for more information.</p>
 <hr />
 <h2 id="configuration-guides">Configuration Guides<a class="headerlink" href="#configuration-guides" title="Permanent link">&para;</a></h2>
 <p>The following guides are provided for some of the most common authentication methods.</p>
@@ -9682,7 +9594,7 @@ a default set of permissions there are some additional variables to configure th
 <p>Note the provider entry we configured in <code>SOCIAL_AUTH_SAML_ENABLED_IDPS</code> as <code>google</code>. This will be used to login and will be referenced in the query parameter using <code>idp=google</code>. For example <code>/login/saml/?idp=google</code>.</p>
 <p>This should be the URL that is mapped to the "Log in" button on the top right of the index page when you navigate to Nautobot in your browser. Clicking this link should automatically redirect you to Google, ask you to "Choose an account", log you in and redirect you back to the Nautobot home page. Your email address will also be your username.</p>
 <hr />
-<p>Be sure to configure <a href="../optional-settings.html#external_auth_default_groups"><code>EXTERNAL_AUTH_DEFAULT_GROUPS</code></a> and <a href="../optional-settings.html#external_auth_default_permissions"><code>EXTERNAL_AUTH_DEFAULT_PERMISSIONS</code></a> next.</p>
+<p>Be sure to configure <a href="../settings.html#external_auth_default_groups"><code>EXTERNAL_AUTH_DEFAULT_GROUPS</code></a> and <a href="../settings.html#external_auth_default_permissions"><code>EXTERNAL_AUTH_DEFAULT_PERMISSIONS</code></a> next.</p>
 <hr />
 <h4 id="saml-metadata">SAML Metadata<a class="headerlink" href="#saml-metadata" title="Permanent link">&para;</a></h4>
 <p>If you need to collect SAML metadata from your Nautobot host to provide to the IDP, you can add a simple view to gather and display metadata.</p>
@@ -9917,7 +9829,7 @@ a default set of permissions there are some additional variables to configure th
     </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>