nautobot 2.0.4__py3-none-any.whl → 2.1.0b1__py3-none-any.whl

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

@@ -17,7 +17,7 @@
         <link rel="next" href="../tools/nautobot-server.html">
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.20">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.1.21">
     
     
       
@@ -2706,6 +2706,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../platform-functionality/externalintegration.html" class="md-nav__link">
+        External Integrations
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../platform-functionality/gitrepository.html" class="md-nav__link">
         Git Repositories
@@ -2726,7 +2740,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_8" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_9" >
       
       
       
@@ -2735,14 +2749,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../../platform-functionality/graphql.html">GraphQL</a>
           
-            <label for="__nav_2_4_8">
+            <label for="__nav_2_4_9">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_8_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_8">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_9_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_9">
           <span class="md-nav__icon md-icon"></span>
           GraphQL
         </label>
@@ -2794,7 +2808,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_10" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_11" >
       
       
       
@@ -2803,14 +2817,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../../platform-functionality/jobs/index.html">Jobs</a>
           
-            <label for="__nav_2_4_10">
+            <label for="__nav_2_4_11">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_10_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_10">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_11_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_11">
           <span class="md-nav__icon md-icon"></span>
           Jobs
         </label>
@@ -2932,7 +2946,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_14" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_15" >
       
       
       
@@ -2941,14 +2955,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../../platform-functionality/rest-api/overview.html">REST API</a>
           
-            <label for="__nav_2_4_14">
+            <label for="__nav_2_4_15">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_14_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_14">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_15_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_15">
           <span class="md-nav__icon md-icon"></span>
           REST API
         </label>
@@ -3084,17 +3098,17 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_20" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_21" >
       
       
       
-        <label class="md-nav__link" for="__nav_2_4_20" id="__nav_2_4_20_label" tabindex="0">
+        <label class="md-nav__link" for="__nav_2_4_21" id="__nav_2_4_21_label" tabindex="0">
           Users
           <span class="md-nav__icon md-icon"></span>
         </label>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_20_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_20">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_21_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_21">
           <span class="md-nav__icon md-icon"></span>
           Users
         </label>
@@ -4827,6 +4841,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../release-notes/version-2.1.html" class="md-nav__link">
+        Version 2.1
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../release-notes/version-2.0.html" class="md-nav__link">
         Version 2.0

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

@@ -17,7 +17,7 @@
         <link rel="next" href="authentication/ldap.html">
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.20">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.1.21">
     
     
       
@@ -1205,22 +1205,22 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#hide_restricted_ui" class="md-nav__link">
-    HIDE_RESTRICTED_UI
+  <a href="#http_proxies" class="md-nav__link">
+    HTTP_PROXIES
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#http_proxies" class="md-nav__link">
-    HTTP_PROXIES
+  <a href="#installation_metrics_enabled" class="md-nav__link">
+    INSTALLATION_METRICS_ENABLED
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#installation_metrics_enabled" class="md-nav__link">
-    INSTALLATION_METRICS_ENABLED
+  <a href="#job_file_io_storage" class="md-nav__link">
+    JOB_FILE_IO_STORAGE
   </a>
   
 </li>
@@ -3366,6 +3366,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../platform-functionality/externalintegration.html" class="md-nav__link">
+        External Integrations
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../platform-functionality/gitrepository.html" class="md-nav__link">
         Git Repositories
@@ -3386,7 +3400,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_8" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_9" >
       
       
       
@@ -3395,14 +3409,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../../platform-functionality/graphql.html">GraphQL</a>
           
-            <label for="__nav_2_4_8">
+            <label for="__nav_2_4_9">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_8_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_8">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_9_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_9">
           <span class="md-nav__icon md-icon"></span>
           GraphQL
         </label>
@@ -3454,7 +3468,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_10" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_11" >
       
       
       
@@ -3463,14 +3477,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../../platform-functionality/jobs/index.html">Jobs</a>
           
-            <label for="__nav_2_4_10">
+            <label for="__nav_2_4_11">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_10_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_10">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_11_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_11">
           <span class="md-nav__icon md-icon"></span>
           Jobs
         </label>
@@ -3592,7 +3606,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_14" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_15" >
       
       
       
@@ -3601,14 +3615,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../../platform-functionality/rest-api/overview.html">REST API</a>
           
-            <label for="__nav_2_4_14">
+            <label for="__nav_2_4_15">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_14_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_14">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_15_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_15">
           <span class="md-nav__icon md-icon"></span>
           REST API
         </label>
@@ -3744,17 +3758,17 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_20" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_21" >
       
       
       
-        <label class="md-nav__link" for="__nav_2_4_20" id="__nav_2_4_20_label" tabindex="0">
+        <label class="md-nav__link" for="__nav_2_4_21" id="__nav_2_4_21_label" tabindex="0">
           Users
           <span class="md-nav__icon md-icon"></span>
         </label>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_20_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_20">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_21_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_21">
           <span class="md-nav__icon md-icon"></span>
           Users
         </label>
@@ -5487,6 +5501,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../release-notes/version-2.1.html" class="md-nav__link">
+        Version 2.1
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../release-notes/version-2.0.html" class="md-nav__link">
         Version 2.0
@@ -6129,22 +6157,22 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#hide_restricted_ui" class="md-nav__link">
-    HIDE_RESTRICTED_UI
+  <a href="#http_proxies" class="md-nav__link">
+    HTTP_PROXIES
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#http_proxies" class="md-nav__link">
-    HTTP_PROXIES
+  <a href="#installation_metrics_enabled" class="md-nav__link">
+    INSTALLATION_METRICS_ENABLED
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#installation_metrics_enabled" class="md-nav__link">
-    INSTALLATION_METRICS_ENABLED
+  <a href="#job_file_io_storage" class="md-nav__link">
+    JOB_FILE_IO_STORAGE
   </a>
   
 </li>
@@ -6556,7 +6584,6 @@
 <li><a href="#device_name_as_natural_key">DEVICE_NAME_AS_NATURAL_KEY</a></li>
 <li><a href="#dynamic_groups_member_cache_timeout">DYNAMIC_GROUPS_MEMBER_CACHE_TIMEOUT</a></li>
 <li><a href="#feedback_button_enabled">FEEDBACK_BUTTON_ENABLED</a></li>
-<li><a href="#hide_restricted_ui">HIDE_RESTRICTED_UI</a></li>
 <li><a href="#location_name_as_natural_key">LOCATION_NAME_AS_NATURAL_KEY</a></li>
 <li><a href="#max_page_size">MAX_PAGE_SIZE</a></li>
 <li><a href="#network_drivers">NETWORK_DRIVERS</a></li>
@@ -6606,6 +6633,9 @@ can specify additional apps with ease.  Similarly, additional <code>MIDDLEWARE</
 </div>
 <hr />
 <h2 id="branding_filepaths">BRANDING_FILEPATHS<a class="headerlink" href="#branding_filepaths" title="Permanent link">&para;</a></h2>
+<div class="admonition version-added">
+<p class="admonition-title">Added in version 1.2.0</p>
+</div>
 <p>Default:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="p">{</span>
 <a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>    <span class="s2">&quot;logo&quot;</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;NAUTOBOT_BRANDING_FILEPATHS_LOGO&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>  <span class="c1"># Navbar logo</span>
@@ -6615,7 +6645,9 @@ can specify additional apps with ease.  Similarly, additional <code>MIDDLEWARE</
 <a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a>    <span class="s2">&quot;icon_180&quot;</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;NAUTOBOT_BRANDING_FILEPATHS_ICON_180&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>  <span class="c1"># 180x180px icon - used for the apple-touch-icon header</span>
 <a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a>    <span class="s2">&quot;icon_192&quot;</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;NAUTOBOT_BRANDING_FILEPATHS_ICON_192&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>  <span class="c1"># 192x192px icon</span>
 <a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a>    <span class="s2">&quot;icon_mask&quot;</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;NAUTOBOT_BRANDING_FILEPATHS_ICON_MASK&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>  <span class="c1"># mono-chrome icon used for the mask-icon header</span>
-<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="p">}</span>
+<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a>    <span class="s2">&quot;header_bullet&quot;</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;NAUTOBOT_BRANDING_FILEPATHS_HEADER_BULLET&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>  <span class="c1"># bullet image used for various view headers</span>
+<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a>    <span class="s2">&quot;nav_bullet&quot;</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;NAUTOBOT_BRANDING_FILEPATHS_NAV_BULLET&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>   <span class="c1"># bullet image used for nav menu headers</span>
+<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="p">}</span>
 </code></pre></div>
 <p>A set of filepaths relative to the <a href="#media_root"><code>MEDIA_ROOT</code></a> which locate image assets used for custom branding. Each of these assets takes the place of the corresponding stock Nautobot asset. This allows for instance, providing your own navbar logo and favicon.</p>
 <p>These environment variables may be used to specify the values:</p>
@@ -6628,6 +6660,13 @@ can specify additional apps with ease.  Similarly, additional <code>MIDDLEWARE</
 <li><code>NAUTOBOT_BRANDING_FILEPATHS_ICON_192</code></li>
 <li><code>NAUTOBOT_BRANDING_FILEPATHS_ICON_MASK</code></li>
 </ul>
+<div class="admonition version-added">
+<p class="admonition-title">Added in version 2.1.0</p>
+<p><!-- markdownlint-disable MD037 -->
+* <code>NAUTOBOT_BRANDING_FILEPATHS_HEADER_BULLET</code>
+* <code>NAUTOBOT_BRANDING_FILEPATHS_NAV_BULLET</code>
+<!-- markdownlint-enable MD037 --></p>
+</div>
 <p>If a custom image asset is not provided for any of the above options, the stock Nautobot asset is used.</p>
 <hr />
 <h2 id="branding_prepended_filename">BRANDING_PREPENDED_FILENAME<a class="headerlink" href="#branding_prepended_filename" title="Permanent link">&para;</a></h2>
@@ -6639,11 +6678,17 @@ can specify additional apps with ease.  Similarly, additional <code>MIDDLEWARE</
 <p>Defines the prefix of the filename when exporting to CSV/YAML or export templates.</p>
 <hr />
 <h2 id="branding_title">BRANDING_TITLE<a class="headerlink" href="#branding_title" title="Permanent link">&para;</a></h2>
+<div class="admonition version-added">
+<p class="admonition-title">Added in version 1.2.0</p>
+</div>
 <p>Default: <code>"Nautobot"</code></p>
 <p>Environment Variable: <code>NAUTOBOT_BRANDING_TITLE</code></p>
 <p>The defines the custom branding title that should be used in place of "Nautobot" within user facing areas of the application like the HTML title of web pages.</p>
 <hr />
 <h2 id="branding_urls">BRANDING_URLS<a class="headerlink" href="#branding_urls" title="Permanent link">&para;</a></h2>
+<div class="admonition version-added">
+<p class="admonition-title">Added in version 1.2.0</p>
+</div>
 <p>Default:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="p">{</span>
 <a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>    <span class="s2">&quot;code&quot;</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;NAUTOBOT_BRANDING_URLS_CODE&quot;</span><span class="p">,</span> <span class="s2">&quot;https://github.com/nautobot/nautobot&quot;</span><span class="p">),</span>  <span class="c1"># Code link in the footer</span>
@@ -6905,18 +6950,6 @@ case. Set this to an empty list to disable it.</p>
 <p>Default: <code>"rel"</code></p>
 <p>By default, all relationship associations in GraphQL will be prefixed with <code>rel</code>. A relationship named <code>my_relationship</code> will appear in GraphQL as <code>rel_my_relationship</code> by default. It's possible to change or remove the prefix by setting the value of <code>GRAPHQL_RELATIONSHIP_PREFIX</code>.</p>
 <hr />
-<h2 id="hide_restricted_ui">HIDE_RESTRICTED_UI<a class="headerlink" href="#hide_restricted_ui" title="Permanent link">&para;</a></h2>
-<p>Default: <code>False</code></p>
-<p>When set to <code>True</code>, users with limited permissions will only be able to see items in the UI they have access to.</p>
-<div class="admonition version-added">
-<p class="admonition-title">Added in version 1.2.0</p>
-<p>If you do not set a value for this setting in your <code>nautobot_config.py</code>, it can be configured dynamically by an admin user via the Nautobot Admin UI. If you do have a value for this setting in <code>nautobot_config.py</code>, it will override any dynamically configured value.</p>
-</div>
-<div class="admonition version-added">
-<p class="admonition-title">Added in version 1.3.10</p>
-<p>When this setting is set to <code>True</code>, logged out users will be redirected to the login page when navigating to the Nautobot home page.</p>
-</div>
-<hr />
 <h2 id="http_proxies">HTTP_PROXIES<a class="headerlink" href="#http_proxies" title="Permanent link">&para;</a></h2>
 <p>Default: <code>None</code> (Disabled)</p>
 <p>A dictionary of HTTP proxies to use for outbound requests originating from Nautobot (e.g. when sending webhook requests). Proxies should be specified by schema (HTTP and HTTPS) as per the <a href="https://2.python-requests.org/en/master/user/advanced/">Python requests library documentation</a>. For example:</p>
@@ -6940,6 +6973,33 @@ case. Set this to an empty list to disable it.</p>
 <p>Default: <code>True</code> for existing Nautobot deployments, user-specified when running <code>nautobot-server init</code> for a new deployment.</p>
 <p>Environment Variable: <code>NAUTOBOT_INSTALLATION_METRICS_ENABLED</code></p>
 <p>When set to <code>True</code>, Nautobot will send anonymized installation metrics to the Nautobot maintainers when running the <a href="../tools/nautobot-server.html#post_upgrade"><code>post_upgrade</code></a> or <a href="../tools/nautobot-server.html#send_installation_metrics"><code>send_installation_metrics</code></a> management commands. See the documentation for the <a href="../tools/nautobot-server.html#send_installation_metrics"><code>send_installation_metrics</code></a> management command for more details.</p>
+<hr />
+<h2 id="job_file_io_storage">JOB_FILE_IO_STORAGE<a class="headerlink" href="#job_file_io_storage" title="Permanent link">&para;</a></h2>
+<div class="admonition version-added">
+<p class="admonition-title">Added in version 2.1.0</p>
+</div>
+<p>Default: <code>"db_file_storage.storage.DatabaseFileStorage"</code></p>
+<p>Environment Variable: <code>NAUTOBOT_JOB_FILE_IO_STORAGE</code></p>
+<p>The backend storage engine for handling files provided as input to Jobs and files generated as output by Jobs.</p>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>For backwards compatibility with storage of Job inputs in prior versions of Nautobot, this currently defaults to using <code>DatabaseFileStorage</code> to store such files directly in Nautobot's database, however this is not typically the best option (see below) and may change in a future major release.</p>
+</div>
+<p>If your Nautobot server instance(s) and your Celery worker instance(s) share a common <a href="#media_root"><code>MEDIA_ROOT</code></a> filesystem (as would typically be the case in a single-server installation of Nautobot) then we recommend changing this to <code>"django.core.files.storage.FileSystemStorage"</code> to store Job files on the filesystem (which will place them into a <code>files/</code> subdirectory under <a href="#media_root"><code>MEDIA_ROOT</code></a>) instead of in the database.</p>
+<p>If your Nautobot server instance(s) and Celery worker instance(s) do <em>not</em> share a common filesystem, we recommend using one of the <a href="https://django-storages.readthedocs.io/en/stable/"><code>django-storages</code></a> options such as S3 to provide a storage backend that can be accessed by the server(s) and worker(s) alike.</p>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>For an example of using <code>django-storages</code> with AWS S3 buckets, visit the <a href="../guides/s3-django-storage.html">django-storages with S3</a> user-guide.</p>
+</div>
+<p>If you have neither a common <code>MEDIA_ROOT</code> filesystem nor an appropriate remote storage option, then it's permissible to leave this at its default, but know that storing files in the database is provided here as a "least-worst" option only.</p>
+<div class="admonition caution">
+<p class="admonition-title">Caution</p>
+<p>It's typically safe to change this setting when initially updating to Nautobot 2.1.0 or later, as there should be no pre-existing Job output files, although any existing scheduled Jobs that have file <em>inputs</em> may need to be deleted and recreated after doing so. However, once you've run any Jobs that output to a file, changing storage backends will of course break any existing links to Job output files in the previous storage backend. Migrating Job stored files from one backend to another is out of scope for this document.</p>
+</div>
+<blockquote>
+<p>See also: <a href="#storage_backend"><code>STORAGE_BACKEND</code></a></p>
+</blockquote>
+<hr />
 <h2 id="jobs_root">JOBS_ROOT<a class="headerlink" href="#jobs_root" title="Permanent link">&para;</a></h2>
 <p>Default: <code>os.path.join(NAUTOBOT_ROOT, "jobs")</code></p>
 <p>Environment Variable: <code>NAUTOBOT_JOBS_ROOT</code></p>
@@ -7153,8 +7213,14 @@ case. Set this to an empty list to disable it.</p>
 <h2 id="storage_backend">STORAGE_BACKEND<a class="headerlink" href="#storage_backend" title="Permanent link">&para;</a></h2>
 <p>Default: <code>None</code> (local storage)</p>
 <p>The backend storage engine for handling uploaded files (e.g. image attachments). Nautobot supports integration with the <a href="https://django-storages.readthedocs.io/en/stable/"><code>django-storages</code></a> package, which provides backends for several popular file storage services. If not configured, local filesystem storage will be used.</p>
-<p>An example of using django-storages with AWS S3 buckets, visit the <a href="../guides/s3-django-storage.html">django-storages with S3</a> user-guide.</p>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>For an example of using <code>django-storages</code> with AWS S3 buckets, visit the <a href="../guides/s3-django-storage.html">django-storages with S3</a> user-guide.</p>
+</div>
 <p>The configuration parameters for the specified storage backend are defined under the <a href="#storage_config"><code>STORAGE_CONFIG</code></a> setting.</p>
+<blockquote>
+<p>See also: <a href="#job_file_io_storage"><code>JOB_FILE_IO_STORAGE</code></a></p>
+</blockquote>
 <hr />
 <h2 id="storage_config">STORAGE_CONFIG<a class="headerlink" href="#storage_config" title="Permanent link">&para;</a></h2>
 <p>Default: <code>{}</code> (Empty dictionary)</p>

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

@@ -17,7 +17,7 @@
         <link rel="next" href="optional-settings.html">
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.20">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.1.21">
     
     
       
@@ -2807,6 +2807,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../platform-functionality/externalintegration.html" class="md-nav__link">
+        External Integrations
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../platform-functionality/gitrepository.html" class="md-nav__link">
         Git Repositories
@@ -2827,7 +2841,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_8" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_9" >
       
       
       
@@ -2836,14 +2850,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../../platform-functionality/graphql.html">GraphQL</a>
           
-            <label for="__nav_2_4_8">
+            <label for="__nav_2_4_9">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_8_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_8">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_9_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_9">
           <span class="md-nav__icon md-icon"></span>
           GraphQL
         </label>
@@ -2895,7 +2909,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_10" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_11" >
       
       
       
@@ -2904,14 +2918,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../../platform-functionality/jobs/index.html">Jobs</a>
           
-            <label for="__nav_2_4_10">
+            <label for="__nav_2_4_11">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_10_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_10">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_11_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_11">
           <span class="md-nav__icon md-icon"></span>
           Jobs
         </label>
@@ -3033,7 +3047,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_14" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_15" >
       
       
       
@@ -3042,14 +3056,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../../platform-functionality/rest-api/overview.html">REST API</a>
           
-            <label for="__nav_2_4_14">
+            <label for="__nav_2_4_15">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_14_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_14">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_15_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_15">
           <span class="md-nav__icon md-icon"></span>
           REST API
         </label>
@@ -3185,17 +3199,17 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_20" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_21" >
       
       
       
-        <label class="md-nav__link" for="__nav_2_4_20" id="__nav_2_4_20_label" tabindex="0">
+        <label class="md-nav__link" for="__nav_2_4_21" id="__nav_2_4_21_label" tabindex="0">
           Users
           <span class="md-nav__icon md-icon"></span>
         </label>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_20_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_20">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_21_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_21">
           <span class="md-nav__icon md-icon"></span>
           Users
         </label>
@@ -4928,6 +4942,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../release-notes/version-2.1.html" class="md-nav__link">
+        Version 2.1
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../release-notes/version-2.0.html" class="md-nav__link">
         Version 2.0