feat: custom /favicon.ico

[wesleyboar]

Overview

Adds a Django view that serves /favicon.ico directly from Django.

Why?

PDF renderers fetch /favicon.ico from origin and won't follow a <link> tag pointing to a CDN URL, so this view is needed to serve the correct favicon to those clients.

PORTAL_FAVICON["is_remote"]	result (only for /favicon.ico)
True	view proxies CDN URL
False	view serves file via staticfiles.finders*

Responses are cached for 24 hours.

Related

• review requested via WP-1310

Caution

• coupled to refactor(nginx): delete favicon nginx intercept (so CMS can do it instead) Camino#84
• required by https://github.com/TACC/Core-Portal-Deployments/pull/203

Changes

• added taccsite_cms/views.py with favicon proxy view
• updated taccsite_cms/urls.py to register ^favicon\.ico$ route

Testing

1. make start
2. In settings_local.py, set

   PORTAL_FAVICON = {
       "is_remote": True,
       "img_file_src": "https://cdn.jsdelivr.net/gh/TACC/Core-CMS-Custom@ec5bc70/3dem_assets/favicon.ico"
   }

3. curl -si http://localhost:8000/favicon.ico.
4. Verify 200 image/x-icon with the remote favicon.
5. Change setting value to

   PORTAL_FAVICON = {
       "is_remote": False,
       "img_file_src": "site_cms/img/favicons/favicon.ico"
   }

6. curl -si http://localhost:8000/favicon.ico
7. Verify 200 image/x-icon with the local static file.

UI

GH.1190.mov

[qodo-code-review]

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →