nautobot 1.6.21__py3-none-any.whl → 1.6.23__py3-none-any.whl

nautobot/project-static/docs/configuration/optional-settings.html

@@ -5460,7 +5460,11 @@ can specify additional apps with ease.  Similarly, additional <code>MIDDLEWARE</
 <h2 id="banner_top">BANNER_TOP<a class="headerlink" href="#banner_top" title="Permanent link">&para;</a></h2>
 <h2 id="banner_bottom">BANNER_BOTTOM<a class="headerlink" href="#banner_bottom" title="Permanent link">&para;</a></h2>
 <p>Default: <code>""</code> (Empty string)</p>
-<p>Setting these variables will display custom content in a banner at the top and/or bottom of the page, respectively. HTML is allowed. To replicate the content of the top banner in the bottom banner, set:</p>
+<p>Environment Variable: <code>NAUTOBOT_BANNER_TOP</code>
+Environment Variable: <code>NAUTOBOT_BANNER_BOTTOM</code></p>
+<p>Setting these variables will display custom content in a banner at the top and/or bottom of the page, respectively.</p>
+<p>Markdown formatting is supported within these messages, as well as <a href="../additional-features/template-filters.html#render_markdown">a limited subset of HTML</a>.</p>
+<p>To replicate the content of the top banner in the bottom banner, set:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="n">BANNER_TOP</span> <span class="o">=</span> <span class="s1">&#39;Your banner text&#39;</span>
 <a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="n">BANNER_BOTTOM</span> <span class="o">=</span> <span class="n">BANNER_TOP</span>
 </code></pre></div>
@@ -5471,7 +5475,9 @@ can specify additional apps with ease.  Similarly, additional <code>MIDDLEWARE</
 <hr />
 <h2 id="banner_login">BANNER_LOGIN<a class="headerlink" href="#banner_login" title="Permanent link">&para;</a></h2>
 <p>Default: <code>""</code> (Empty string)</p>
-<p>This defines custom content to be displayed on the login page above the login form. HTML is allowed.</p>
+<p>Environment Variable: <code>NAUTOBOT_BANNER_LOGIN</code></p>
+<p>This defines custom content to be displayed on the login page above the login form.</p>
+<p>Markdown formatting is supported within this message, as well as <a href="../additional-features/template-filters.html#render_markdown">a limited subset of HTML</a>.</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>
@@ -5487,9 +5493,11 @@ 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;css&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_CSS&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>  <span class="c1"># custom global CSS file</span>
+<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a>    <span class="s2">&quot;javascript&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_JAVASCRIPT&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>  <span class="c1"># custom global Javascript file</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>A set of filepaths relative to the <a href="#media_root"><code>MEDIA_ROOT</code></a> which locate assets used for custom branding of your Nautobot instance. With the exception of <code>css</code> and <code>javascript</code>, which provide the option to add an <em>additional</em> file to Nautobot page content, each of the other 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>
 <ul>
 <li><code>NAUTOBOT_BRANDING_FILEPATHS_LOGO</code></li>
@@ -5499,8 +5507,14 @@ can specify additional apps with ease.  Similarly, additional <code>MIDDLEWARE</
 <li><code>NAUTOBOT_BRANDING_FILEPATHS_ICON_180</code></li>
 <li><code>NAUTOBOT_BRANDING_FILEPATHS_ICON_192</code></li>
 <li><code>NAUTOBOT_BRANDING_FILEPATHS_ICON_MASK</code></li>
+<li><code>NAUTOBOT_BRANDING_FILEPATHS_CSS</code></li>
+<li><code>NAUTOBOT_BRANDING_FILEPATHS_JAVASCRIPT</code></li>
 </ul>
-<p>If a custom image asset is not provided for any of the above options, the stock Nautobot asset is used.</p>
+<p>If a custom asset is not provided for any of the above options, the stock Nautobot asset is used.</p>
+<div class="admonition version-added">
+<p class="admonition-title">Added in version 1.6.22</p>
+<p>The <code>css</code> and <code>javascript</code> assets were added as options.</p>
+</div>
 <hr />
 <h2 id="branding_prepended_filename">BRANDING_PREPENDED_FILENAME<a class="headerlink" href="#branding_prepended_filename" title="Permanent link">&para;</a></h2>
 <div class="admonition version-added">