nautobot 1.6.20__tar.gz → 1.6.22__tar.gz

{nautobot-1.6.20 → nautobot-1.6.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nautobot
-Version: 1.6.20
+Version: 1.6.22
 Summary: Source of truth and network automation platform.
 Home-page: https://nautobot.com
 License: Apache-2.0
@@ -24,10 +24,10 @@ Provides-Extra: remote-storage
 Provides-Extra: sso
 Requires-Dist: Django (>=3.2.25,<3.3.0)
 Requires-Dist: GitPython (>=3.1.41,<3.2.0)
-Requires-Dist: Jinja2 (>=3.1.3,<3.2.0)
+Requires-Dist: Jinja2 (>=3.1.4,<3.2.0)
 Requires-Dist: Markdown (>=3.3.7,<3.4.0)
 Requires-Dist: MarkupSafe (>=2.1.3,<2.2.0)
-Requires-Dist: Pillow (>=10.2.0,<10.3.0)
+Requires-Dist: Pillow (>=10.3.0,<10.4.0)
 Requires-Dist: PyYAML (>=6.0,<6.1)
 Requires-Dist: celery (>=5.3.1,<5.4.0)
 Requires-Dist: django-ajax-tables (>=1.1.1,<1.2.0)
@@ -68,7 +68,7 @@ Requires-Dist: packaging (>=23.0,<23.2)
 Requires-Dist: prometheus-client (>=0.14.1,<0.18)
 Requires-Dist: psycopg2-binary (>=2.9.6,<2.10.0)
 Requires-Dist: pyuwsgi (>=2.0.21,<2.1.0)
-Requires-Dist: social-auth-app-django (>=5.2.0,<5.3.0)
+Requires-Dist: social-auth-app-django (>=5.4.1,<5.5.0)
 Requires-Dist: social-auth-core[openidconnect,saml] (>=4.5.3,<4.6.0) ; extra == "all" or extra == "sso"
 Requires-Dist: svgwrite (>=1.4.2,<1.5.0)
 Requires-Dist: toml (>=0.10.2,<0.11.0)

{nautobot-1.6.20 → nautobot-1.6.22}/nautobot/core/settings.py

@@ -59,6 +59,14 @@ ALLOWED_URL_SCHEMES = (
     "xmpp",
 )
 
+# Banners to display to users. Markdown and limited HTML are allowed.
+if "NAUTOBOT_BANNER_BOTTOM" in os.environ and os.environ["NAUTOBOT_BANNER_BOTTOM"] != "":
+    BANNER_BOTTOM = os.environ["NAUTOBOT_BANNER_BOTTOM"]
+if "NAUTOBOT_BANNER_LOGIN" in os.environ and os.environ["NAUTOBOT_BANNER_LOGIN"] != "":
+    BANNER_LOGIN = os.environ["NAUTOBOT_BANNER_LOGIN"]
+if "NAUTOBOT_BANNER_TOP" in os.environ and os.environ["NAUTOBOT_BANNER_TOP"] != "":
+    BANNER_TOP = os.environ["NAUTOBOT_BANNER_TOP"]
+
 # Base directory wherein all created files (jobs, git repositories, file uploads, static files) will be stored)
 NAUTOBOT_ROOT = os.getenv("NAUTOBOT_ROOT", os.path.expanduser("~/.nautobot"))
 
@@ -586,15 +594,15 @@ CONSTANCE_CONFIG = {
     ],
     "BANNER_BOTTOM": [
         "",
-        "Custom HTML to display in a banner at the bottom of all pages.",
+        "Custom Markdown or limited HTML to display in a banner at the bottom of all pages.",
     ],
     "BANNER_LOGIN": [
         "",
-        "Custom HTML to display in a banner at the top of the login page.",
+        "Custom Markdown or limited HTML to display in a banner at the top of the login page.",
     ],
     "BANNER_TOP": [
         "",
-        "Custom HTML to display in a banner at the top of all pages.",
+        "Custom Markdown or limited HTML to display in a banner at the top of all pages.",
     ],
     "CHANGELOG_RETENTION": [
         90,
@@ -869,6 +877,8 @@ BRANDING_FILEPATHS = {
     "icon_mask": os.getenv(
         "NAUTOBOT_BRANDING_FILEPATHS_ICON_MASK", None
     ),  # mono-chrome icon used for the mask-icon header
+    "css": os.getenv("NAUTOBOT_BRANDING_FILEPATHS_CSS", None),  # Custom global CSS
+    "javascript": os.getenv("NAUTOBOT_BRANDING_FILEPATHS_JAVASCRIPT", None),  # Custom global JavaScript
 }
 
 # Title to use in place of "Nautobot"

{nautobot-1.6.20 → nautobot-1.6.22}/nautobot/core/templates/admin/base.html

@@ -32,6 +32,9 @@
     <link rel="stylesheet" id="base-theme"
           href="{% static 'css/base.css' %}?v{{ settings.VERSION }}"
           onerror="window.location='{% url 'media_failure' %}?filename=css/base.css'">
+    {% if settings.BRANDING_FILEPATHS.css %}
+    <link rel="stylesheet" id="custom-css" href="{% custom_branding_or_static 'css' None %}">
+    {% endif %}
     <link rel="apple-touch-icon" sizes="180x180" href="{% static 'img/nautobot_icon_180x180.png' %}">
     <link rel="icon" type="image/png" sizes="32x32" href="{% static 'img/nautobot_icon_32x32.png' %}">
     <link rel="icon" type="image/png" sizes="16x16" href="{% static 'img/nautobot_icon_16x16.png' %}">
@@ -101,7 +104,7 @@
 <div class="container-fluid wrapper" {% if is_popup %}style="padding-bottom: 0px;"{% endif %}>
     {% if "BANNER_TOP"|settings_or_config %}
         <div class="alert alert-info text-center" role="alert">
-            {{ "BANNER_TOP"|settings_or_config|safe }}
+            {{ "BANNER_TOP"|settings_or_config|render_markdown }}
         </div>
     {% endif %}
     {% if settings.MAINTENANCE_MODE %}
@@ -153,7 +156,7 @@
     <div class="push"></div>
     {% if "BANNER_BOTTOM"|settings_or_config %}
         <div class="alert alert-info text-center banner-bottom" role="alert">
-                {{ "BANNER_BOTTOM"|settings_or_config|safe }}
+                {{ "BANNER_BOTTOM"|settings_or_config|render_markdown }}
         </div>
     {% endif %}
 </div>
@@ -189,6 +192,9 @@
 {% endif %}
 {% include 'modals/modal_theme.html' with name='theme'%}
 <script src="{% static 'js/theme.js' %}"></script>
+{% if settings.BRANDING_FILEPATHS.javascript %}
+<script src="{% custom_branding_or_static 'javascript' None %}"></script>
+{% endif %}
 {% block javascript %}{% endblock %}
 </body>
 </html>

{nautobot-1.6.20 → nautobot-1.6.22}/nautobot/core/templates/base.html

@@ -15,7 +15,7 @@
         {% if request.user.is_authenticated or not "HIDE_RESTRICTED_UI"|settings_or_config %}
             {% if "BANNER_TOP"|settings_or_config %}
                 <div class="alert alert-info text-center" role="alert">
-                    {{ "BANNER_TOP"|settings_or_config|safe }}
+                    {{ "BANNER_TOP"|settings_or_config|render_markdown }}
                 </div>
             {% endif %}
         {% endif %}
@@ -40,7 +40,7 @@
         {% if request.user.is_authenticated or not "HIDE_RESTRICTED_UI"|settings_or_config %}
             {% if "BANNER_BOTTOM"|settings_or_config %}
                 <div class="alert alert-info text-center banner-bottom" role="alert">
-                    {{ "BANNER_BOTTOM"|settings_or_config|safe }}
+                    {{ "BANNER_BOTTOM"|settings_or_config|render_markdown }}
                 </div>
             {% endif %}
         {% endif %}

{nautobot-1.6.20 → nautobot-1.6.22}/nautobot/core/templates/graphene/graphiql.html

@@ -36,6 +36,9 @@ add "&raw" to the end of the URL within a browser.
   <link rel="stylesheet"
         href="{% static 'css/base.css' %}?v{{ settings.VERSION }}"
         onerror="window.location='{% url 'media_failure' %}?filename=css/base.css'">
+    {% if settings.BRANDING_FILEPATHS.css %}
+    <link rel="stylesheet" id="custom-css" href="{% custom_branding_or_static 'css' None %}">
+    {% endif %}
   <link rel="apple-touch-icon" sizes="180x180" href="{% custom_branding_or_static 'icon_180' 'img/nautobot_icon_180x180.png' %}">
   <link rel="icon" type="image/png" sizes="32x32" href="{% custom_branding_or_static 'icon_32' 'img/nautobot_icon_32x32.png' %}">
   <link rel="icon" type="image/png" sizes="16x16" href="{% custom_branding_or_static 'icon_16' 'img/nautobot_icon_16x16.png' %}">

{nautobot-1.6.20 → nautobot-1.6.22}/nautobot/core/templates/inc/javascript.html

@@ -52,3 +52,6 @@
             dropdown.removeClass('edge');
     })
 </script>
+{% if settings.BRANDING_FILEPATHS.javascript %}
+<script src="{% custom_branding_or_static 'javascript' None %}"></script>
+{% endif %}

{nautobot-1.6.20 → nautobot-1.6.22}/nautobot/core/templates/inc/media.html

@@ -26,6 +26,9 @@
     <link rel="stylesheet" id="base-theme"
           href="{% static 'css/base.css' %}?v{{ settings.VERSION }}"
           onerror="window.location='{% url 'media_failure' %}?filename=css/base.css'">
+    {% if settings.BRANDING_FILEPATHS.css %}
+    <link rel="stylesheet" id="custom-css" href="{% custom_branding_or_static 'css' None %}">
+    {% endif %}
     <link rel="apple-touch-icon" sizes="180x180" href="{% custom_branding_or_static 'icon_180' 'img/nautobot_icon_180x180.png' %}">
     <link rel="icon" type="image/png" sizes="32x32" href="{% custom_branding_or_static 'icon_32' 'img/nautobot_icon_32x32.png' %}">
     <link rel="icon" type="image/png" sizes="16x16" href="{% custom_branding_or_static 'icon_16' 'img/nautobot_icon_16x16.png' %}">

{nautobot-1.6.20 → nautobot-1.6.22}/nautobot/core/templates/login.html

@@ -53,8 +53,8 @@
 <div class="row" style="margin-top: {% if 'BANNER_LOGIN'|settings_or_config %}100{% else %}150{% endif %}px;">
     <div class="col-sm-4 col-sm-offset-4">
         {% if "BANNER_LOGIN"|settings_or_config %}
-            <div style="margin-bottom: 25px">
-                {{ "BANNER_LOGIN"|settings_or_config|safe }}
+            <div class="alert alert-info text-center" role="alert">
+                {{ "BANNER_LOGIN"|settings_or_config|render_markdown }}
             </div>
         {% endif %}
         {% if form.non_field_errors %}

{nautobot-1.6.20 → nautobot-1.6.22}/nautobot/core/templates/nautobot_config.py.j2

@@ -263,6 +263,8 @@ SECRET_KEY = os.getenv("NAUTOBOT_SECRET_KEY", "{{ secret_key }}")
 #     "icon_mask": os.getenv(
 #         "NAUTOBOT_BRANDING_FILEPATHS_ICON_MASK", None
 #     ),  # mono-chrome icon used for the mask-icon header
+#     "css": os.getenv("NAUTOBOT_BRANDING_FILEPATHS_CSS", None),  # Custom global CSS
+#     "javascript": os.getenv("NAUTOBOT_BRANDING_FILEPATHS_JAVASCRIPT", None),  # Custom global JavaScript
 # }
 
 # Prepended to CSV, YAML and export template filenames (i.e. `nautobot_device.yml`)

{nautobot-1.6.20 → nautobot-1.6.22}/nautobot/core/tests/test_views.py

@@ -99,6 +99,39 @@ class HomeViewTestCase(TestCase):
         response_content = response.content.decode(response.charset).replace("\n", "")
         self.assertNotRegex(response_content, footer_hostname_version_pattern)
 
+    def test_banners_markdown(self):
+        url = reverse("home")
+        with override_settings(
+            BANNER_TOP="# Hello world",
+            BANNER_BOTTOM="[info](https://nautobot.com)",
+        ):
+            response = self.client.get(url)
+        self.assertInHTML("<h1>Hello world</h1>", response.content.decode(response.charset))
+        self.assertInHTML(
+            '<a href="https://nautobot.com" rel="noopener noreferrer">info</a>',
+            response.content.decode(response.charset),
+        )
+
+        with override_settings(BANNER_LOGIN="_Welcome to Nautobot!_"):
+            self.client.logout()
+            response = self.client.get(reverse("login"))
+        self.assertInHTML("<em>Welcome to Nautobot!</em>", response.content.decode(response.charset))
+
+    def test_banners_no_xss(self):
+        url = reverse("home")
+        with override_settings(
+            BANNER_TOP='<script>alert("Hello from above!");</script>',
+            BANNER_BOTTOM='<script>alert("Hello from below!");</script>',
+        ):
+            response = self.client.get(url)
+        self.assertNotIn("Hello from above", response.content.decode(response.charset))
+        self.assertNotIn("Hello from below", response.content.decode(response.charset))
+
+        with override_settings(BANNER_LOGIN='<script>alert("Welcome to Nautobot!");</script>'):
+            self.client.logout()
+            response = self.client.get(reverse("login"))
+        self.assertNotIn("Welcome to Nautobot!", response.content.decode(response.charset))
+
 
 @override_settings(BRANDING_TITLE="Nautobot")
 class SearchFieldsTestCase(TestCase):

{nautobot-1.6.20 → nautobot-1.6.22}/nautobot/extras/tests/test_datasources.py

@@ -27,6 +27,7 @@ from nautobot.extras.models import (
     ConfigContextSchema,
     ExportTemplate,
     GitRepository,
+    Job,
     JobLogEntry,
     JobResult,
     Secret,
@@ -119,13 +120,13 @@ class GitTest(TransactionTestCase):
 
     def populate_repo(self, path, url, *args, **kwargs):
         os.makedirs(path)
-        # TODO(Glenn): populate Jobs as well?
         os.makedirs(os.path.join(path, "config_contexts"))
         os.makedirs(os.path.join(path, "config_contexts", "devices"))
         os.makedirs(os.path.join(path, "config_contexts", "locations"))
         os.makedirs(os.path.join(path, "config_context_schemas"))
         os.makedirs(os.path.join(path, "export_templates", "dcim", "device"))
         os.makedirs(os.path.join(path, "export_templates", "ipam", "vlan"))
+        os.makedirs(os.path.join(path, "jobs"))
 
         with open(os.path.join(path, "config_contexts", "context.yaml"), "w") as fd:
             yaml.dump(
@@ -167,6 +168,19 @@ class GitTest(TransactionTestCase):
         with open(os.path.join(path, "export_templates", "ipam", "vlan", "template.j2"), "w") as fd:
             fd.write("{% for vlan in queryset %}\n{{ vlan.name }}\n{% endfor %}")
 
+        with open(os.path.join(path, "jobs", "__init__.py"), "w") as fd:
+            pass
+
+        with open(os.path.join(path, "jobs", "job.py"), "w") as fd:
+            fd.write(
+                """\
+from nautobot.extras.jobs import Job
+
+class MyJob(Job):
+    def run(self, data, commit):
+        pass"""
+            )
+
         return mock.DEFAULT
 
     def empty_repo(self, path, url, *args, **kwargs):
@@ -177,6 +191,8 @@ class GitTest(TransactionTestCase):
         os.remove(os.path.join(path, "export_templates", "dcim", "device", "template.j2"))
         os.remove(os.path.join(path, "export_templates", "dcim", "device", "template2.html"))
         os.remove(os.path.join(path, "export_templates", "ipam", "vlan", "template.j2"))
+        os.remove(os.path.join(path, "jobs", "__init__.py"))
+        os.remove(os.path.join(path, "jobs", "job.py"))
         return mock.DEFAULT
 
     def assert_config_context_schema_record_exists(self, name):
@@ -263,6 +279,11 @@ class GitTest(TransactionTestCase):
         )
         self.assertIsNotNone(export_template_vlan)
 
+    def assert_job_exists(self, installed=True):
+        """Helper function to assert Job exists."""
+        job = Job.objects.get(git_repository=self.repo, job_class_name="MyJob")
+        self.assertEqual(job.installed, installed)
+
     def test_pull_git_repository_and_refresh_data_with_no_data(self, MockGitRepo):
         """
         The pull_git_repository_and_refresh_data job should succeed if the given repo is empty.
@@ -482,6 +503,8 @@ class GitTest(TransactionTestCase):
                 # Case when ContentType.model != ContentType.name, template was added and deleted during sync (#570)
                 self.assert_export_template_vlan_exists("template.j2")
 
+                self.assert_job_exists()
+
                 # Now "resync" the repository, but now those files no longer exist in the repository
                 MockGitRepo.side_effect = self.empty_repo
                 # For verisimilitude, don't re-use the old request and job_result
@@ -525,6 +548,9 @@ class GitTest(TransactionTestCase):
                 self.assertIsNone(device.local_context_data)
                 self.assertIsNone(device.local_context_data_owner)
 
+                # Job should still be present in the database but no longer installed
+                self.assert_job_exists(installed=False)
+
     def test_pull_git_repository_and_refresh_data_with_bad_data(self, MockGitRepo):
         """
         The test_pull_git_repository_and_refresh_data job should gracefully handle bad data in the Git repository
@@ -654,11 +680,11 @@ class GitTest(TransactionTestCase):
 
                 def populate_repo(path, url):
                     os.makedirs(path)
-                    # Just make config_contexts and export_templates directories as we don't load jobs
                     os.makedirs(os.path.join(path, "config_contexts"))
                     os.makedirs(os.path.join(path, "config_contexts", "devices"))
                     os.makedirs(os.path.join(path, "config_context_schemas"))
                     os.makedirs(os.path.join(path, "export_templates", "dcim", "device"))
+                    os.makedirs(os.path.join(path, "jobs"))
                     with open(os.path.join(path, "config_contexts", "context.yaml"), "w") as fd:
                         yaml.dump(
                             {
@@ -685,6 +711,18 @@ class GitTest(TransactionTestCase):
                         "w",
                     ) as fd:
                         fd.write("{% for device in queryset %}\n{{ device.name }}\n{% endfor %}")
+                    with open(os.path.join(path, "jobs", "__init__.py"), "w") as fd:
+                        pass
+                    with open(os.path.join(path, "jobs", "job.py"), "w") as fd:
+                        fd.write(
+                            """\
+from nautobot.extras.jobs import Job
+
+class MyJob(Job):
+    def run(self, data, commit):
+        pass"""
+                        )
+
                     return mock.DEFAULT
 
                 MockGitRepo.side_effect = populate_repo
@@ -744,6 +782,8 @@ class GitTest(TransactionTestCase):
                 )
                 self.assertIsNotNone(export_template)
 
+                self.assert_job_exists()
+
                 # Now delete the GitRepository
                 self.repo.delete()
 
@@ -768,6 +808,36 @@ class GitTest(TransactionTestCase):
                 device = Device.objects.get(name=self.device.name)
                 self.assertIsNone(device.local_context_data)
                 self.assertIsNone(device.local_context_data_owner)
+                self.assert_job_exists(installed=False)
+
+                # Now recreate the repository (https://github.com/nautobot/nautobot/issues/2974)
+                self.repo = GitRepository(
+                    name="Test Git Repository",
+                    slug="test_git_repo",
+                    remote_url="http://localhost/git.git",
+                    # Provide everything we know we can provide
+                    provided_contents=[
+                        entry.content_identifier for entry in get_datasource_contents("extras.gitrepository")
+                    ],
+                )
+                self.repo.save(trigger_resync=False)
+
+                self.job_result = JobResult.objects.create(
+                    name=self.repo.name,
+                    obj_type=ContentType.objects.get_for_model(GitRepository),
+                    job_id=uuid.uuid4(),
+                )
+
+                pull_git_repository_and_refresh_data(self.repo.pk, self.mock_request, self.job_result.pk)
+                self.job_result.refresh_from_db()
+
+                self.assertEqual(
+                    self.job_result.status,
+                    JobResultStatusChoices.STATUS_COMPLETED,
+                    self.job_result.data,
+                )
+
+                self.assert_job_exists(installed=True)
 
     def test_git_dry_run(self, MockGitRepo):
         with tempfile.TemporaryDirectory() as tempdir:

{nautobot-1.6.20 → nautobot-1.6.22}/nautobot/extras/utils.py

@@ -9,6 +9,7 @@ import sys
 from django.apps import apps
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
+from django.db import IntegrityError
 from django.db.models import Q
 from django.template.loader import get_template, TemplateDoesNotExist
 from django.utils.deconstruct import deconstructible
@@ -365,21 +366,37 @@ def refresh_job_model_from_job_class(job_model_class, job_source, job_class, *,
             JOB_MAX_NAME_LENGTH,
         )
 
-    job_model, created = job_model_class.objects.get_or_create(
-        source=job_source[:JOB_MAX_SOURCE_LENGTH],
-        git_repository=git_repository,
-        module_name=job_class.__module__[:JOB_MAX_NAME_LENGTH],
-        job_class_name=job_class.__name__[:JOB_MAX_NAME_LENGTH],
-        defaults={
-            "slug": default_slug[:JOB_MAX_SLUG_LENGTH],
-            "grouping": job_class.grouping[:JOB_MAX_GROUPING_LENGTH],
-            "name": job_class.name[:JOB_MAX_NAME_LENGTH],
-            "is_job_hook_receiver": issubclass(job_class, JobHookReceiver),
-            "is_job_button_receiver": issubclass(job_class, JobButtonReceiver),
-            "installed": True,
-            "enabled": False,
-        },
-    )
+    try:
+        job_model, created = job_model_class.objects.get_or_create(
+            source=job_source[:JOB_MAX_SOURCE_LENGTH],
+            git_repository=git_repository,
+            module_name=job_class.__module__[:JOB_MAX_NAME_LENGTH],
+            job_class_name=job_class.__name__[:JOB_MAX_NAME_LENGTH],
+            defaults={
+                "slug": default_slug[:JOB_MAX_SLUG_LENGTH],
+                "grouping": job_class.grouping[:JOB_MAX_GROUPING_LENGTH],
+                "name": job_class.name[:JOB_MAX_NAME_LENGTH],
+                "is_job_hook_receiver": issubclass(job_class, JobHookReceiver),
+                "is_job_button_receiver": issubclass(job_class, JobButtonReceiver),
+                "installed": True,
+                "enabled": False,
+            },
+        )
+    except IntegrityError:
+        # can occur in the case where we've deleted a GitRepository, resulting in a Job record with
+        # source="git" but git_repository=None, and are now creating a new GitRepository to "re-claim" the Job.
+        if git_repository is not None:
+            created = False
+            job_model = job_model_class.objects.get(
+                source=job_source[:JOB_MAX_SOURCE_LENGTH],
+                git_repository=None,
+                module_name=job_class.__module__[:JOB_MAX_NAME_LENGTH],
+                job_class_name=job_class.__name__[:JOB_MAX_NAME_LENGTH],
+            )
+            job_model.git_repository = git_repository
+            job_model.save()
+        else:
+            raise
 
     for field_name in JOB_OVERRIDABLE_FIELDS:
         # Was this field directly inherited from the job before, or was it overridden in the database?

{nautobot-1.6.20 → nautobot-1.6.22}/nautobot/project-static/docs/code-reference/nautobot/apps/models.html

@@ -5765,8 +5765,7 @@ having to define it on the model yourself.</p>
 
           <details class="quote">
             <summary>Source code in <code>nautobot/extras/utils.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-181">181</a></span>
-<span class="normal"><a href="#__codelineno-0-182">182</a></span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-182">182</a></span>
 <span class="normal"><a href="#__codelineno-0-183">183</a></span>
 <span class="normal"><a href="#__codelineno-0-184">184</a></span>
 <span class="normal"><a href="#__codelineno-0-185">185</a></span>
@@ -5782,24 +5781,25 @@ having to define it on the model yourself.</p>
 <span class="normal"><a href="#__codelineno-0-195">195</a></span>
 <span class="normal"><a href="#__codelineno-0-196">196</a></span>
 <span class="normal"><a href="#__codelineno-0-197">197</a></span>
-<span class="normal"><a href="#__codelineno-0-198">198</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-181" name="__codelineno-0-181"></a><span class="k">def</span> <span class="nf">extras_features</span><span class="p">(</span><span class="o">*</span><span class="n">features</span><span class="p">):</span>
-<a id="__codelineno-0-182" name="__codelineno-0-182"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<a id="__codelineno-0-183" name="__codelineno-0-183"></a><span class="sd">    Decorator used to register extras provided features to a model</span>
-<a id="__codelineno-0-184" name="__codelineno-0-184"></a><span class="sd">    &quot;&quot;&quot;</span>
-<a id="__codelineno-0-185" name="__codelineno-0-185"></a>
-<a id="__codelineno-0-186" name="__codelineno-0-186"></a>    <span class="k">def</span> <span class="nf">wrapper</span><span class="p">(</span><span class="n">model_class</span><span class="p">):</span>
-<a id="__codelineno-0-187" name="__codelineno-0-187"></a>        <span class="c1"># Initialize the model_features store if not already defined</span>
-<a id="__codelineno-0-188" name="__codelineno-0-188"></a>        <span class="k">if</span> <span class="s2">&quot;model_features&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">registry</span><span class="p">:</span>
-<a id="__codelineno-0-189" name="__codelineno-0-189"></a>            <span class="n">registry</span><span class="p">[</span><span class="s2">&quot;model_features&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="n">f</span><span class="p">:</span> <span class="n">collections</span><span class="o">.</span><span class="n">defaultdict</span><span class="p">(</span><span class="nb">list</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">EXTRAS_FEATURES</span><span class="p">}</span>
-<a id="__codelineno-0-190" name="__codelineno-0-190"></a>        <span class="k">for</span> <span class="n">feature</span> <span class="ow">in</span> <span class="n">features</span><span class="p">:</span>
-<a id="__codelineno-0-191" name="__codelineno-0-191"></a>            <span class="k">if</span> <span class="n">feature</span> <span class="ow">in</span> <span class="n">EXTRAS_FEATURES</span><span class="p">:</span>
-<a id="__codelineno-0-192" name="__codelineno-0-192"></a>                <span class="n">app_label</span><span class="p">,</span> <span class="n">model_name</span> <span class="o">=</span> <span class="n">model_class</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">label_lower</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;.&quot;</span><span class="p">)</span>
-<a id="__codelineno-0-193" name="__codelineno-0-193"></a>                <span class="n">registry</span><span class="p">[</span><span class="s2">&quot;model_features&quot;</span><span class="p">][</span><span class="n">feature</span><span class="p">][</span><span class="n">app_label</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">model_name</span><span class="p">)</span>
-<a id="__codelineno-0-194" name="__codelineno-0-194"></a>            <span class="k">else</span><span class="p">:</span>
-<a id="__codelineno-0-195" name="__codelineno-0-195"></a>                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">feature</span><span class="si">}</span><span class="s2"> is not a valid extras feature!&quot;</span><span class="p">)</span>
-<a id="__codelineno-0-196" name="__codelineno-0-196"></a>        <span class="k">return</span> <span class="n">model_class</span>
-<a id="__codelineno-0-197" name="__codelineno-0-197"></a>
-<a id="__codelineno-0-198" name="__codelineno-0-198"></a>    <span class="k">return</span> <span class="n">wrapper</span>
+<span class="normal"><a href="#__codelineno-0-198">198</a></span>
+<span class="normal"><a href="#__codelineno-0-199">199</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-182" name="__codelineno-0-182"></a><span class="k">def</span> <span class="nf">extras_features</span><span class="p">(</span><span class="o">*</span><span class="n">features</span><span class="p">):</span>
+<a id="__codelineno-0-183" name="__codelineno-0-183"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<a id="__codelineno-0-184" name="__codelineno-0-184"></a><span class="sd">    Decorator used to register extras provided features to a model</span>
+<a id="__codelineno-0-185" name="__codelineno-0-185"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-186" name="__codelineno-0-186"></a>
+<a id="__codelineno-0-187" name="__codelineno-0-187"></a>    <span class="k">def</span> <span class="nf">wrapper</span><span class="p">(</span><span class="n">model_class</span><span class="p">):</span>
+<a id="__codelineno-0-188" name="__codelineno-0-188"></a>        <span class="c1"># Initialize the model_features store if not already defined</span>
+<a id="__codelineno-0-189" name="__codelineno-0-189"></a>        <span class="k">if</span> <span class="s2">&quot;model_features&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">registry</span><span class="p">:</span>
+<a id="__codelineno-0-190" name="__codelineno-0-190"></a>            <span class="n">registry</span><span class="p">[</span><span class="s2">&quot;model_features&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="n">f</span><span class="p">:</span> <span class="n">collections</span><span class="o">.</span><span class="n">defaultdict</span><span class="p">(</span><span class="nb">list</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">EXTRAS_FEATURES</span><span class="p">}</span>
+<a id="__codelineno-0-191" name="__codelineno-0-191"></a>        <span class="k">for</span> <span class="n">feature</span> <span class="ow">in</span> <span class="n">features</span><span class="p">:</span>
+<a id="__codelineno-0-192" name="__codelineno-0-192"></a>            <span class="k">if</span> <span class="n">feature</span> <span class="ow">in</span> <span class="n">EXTRAS_FEATURES</span><span class="p">:</span>
+<a id="__codelineno-0-193" name="__codelineno-0-193"></a>                <span class="n">app_label</span><span class="p">,</span> <span class="n">model_name</span> <span class="o">=</span> <span class="n">model_class</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">label_lower</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;.&quot;</span><span class="p">)</span>
+<a id="__codelineno-0-194" name="__codelineno-0-194"></a>                <span class="n">registry</span><span class="p">[</span><span class="s2">&quot;model_features&quot;</span><span class="p">][</span><span class="n">feature</span><span class="p">][</span><span class="n">app_label</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">model_name</span><span class="p">)</span>
+<a id="__codelineno-0-195" name="__codelineno-0-195"></a>            <span class="k">else</span><span class="p">:</span>
+<a id="__codelineno-0-196" name="__codelineno-0-196"></a>                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">feature</span><span class="si">}</span><span class="s2"> is not a valid extras feature!&quot;</span><span class="p">)</span>
+<a id="__codelineno-0-197" name="__codelineno-0-197"></a>        <span class="k">return</span> <span class="n">model_class</span>
+<a id="__codelineno-0-198" name="__codelineno-0-198"></a>
+<a id="__codelineno-0-199" name="__codelineno-0-199"></a>    <span class="k">return</span> <span class="n">wrapper</span>
 </code></pre></div></td></tr></table></div>
           </details>
   </div>

{nautobot-1.6.20 → nautobot-1.6.22}/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">