Merge pull request #1428 from opengisch/QF-6414-enable-whitelabelling-on-auth-pages

feat: add whitelabelling

Author: Rakanhf

docker-app/qfieldcloud/core/staticfiles/css/qfieldcloud.css

@@ -37,6 +37,22 @@ h1, h2, h3, h4, h5, h6 {
 
 .qfc-header-logo {
   height: 1.5rem;
+  margin-left: 1rem;
+}
+
+.qfc-logo-wrapper {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  min-height: 15rem;
+  padding: 1rem 0;
+}
+
+.qfc-main-logo {
+  max-width: 100%;
+  max-height: 15rem;
+  width: auto;
+  height: auto;
 }
 
 .ml-5rem {

docker-app/qfieldcloud/core/templates/account/base.html

@@ -9,11 +9,11 @@
 
   {% sri_static 'css/vendor.css' %}
   {% sri_static 'css/qfieldcloud.css' %}
-  <link rel="shortcut icon" type="image/x-icon" href="{% static 'favicon.ico' %}" />
+  <link rel="shortcut icon" type="image/x-icon" href="{% static whitelabel.favicon %}" />
 
   <title>
     {% block title %}
-      {% block title_contents %}{{ title }}{% endblock title_contents %} | {{ site_title|default:_('QFieldCloud') }}
+      {% block title_contents %}{{ title }}{% endblock title_contents %} | {{ whitelabel.site_title }}
     {% endblock title %}
   </title>
 
@@ -25,7 +25,7 @@
   <!-- Navbar -->
   <nav class="navbar navbar-expand-md navbar-dark nav-fill w-100 bg-primary">
     <a href="{% url 'index' %}">
-      <img src="{% static 'logo_sidetext_white.svg' %}" alt="QFieldCloud" class="logo-nav qfc-header-logo ml-1">
+      <img src="{% static whitelabel.logo_navbar %}" alt="{{ whitelabel.logo_alt }}" class="qfc-header-logo">
     </a>
 
 
@@ -37,9 +37,9 @@
       <div class="flex-shrink-0 col-12">
         <div class="row">
           <div class="col-lg-6 offset-lg-3">
-            <p class="text-center">
-              <img src="{% static 'logo_undertext.svg' %}" alt="QFieldCloud" class="logo-nav" style="height: 15rem">
-            </p>
+            <div class="qfc-logo-wrapper">
+              <img src="{% static whitelabel.logo_main %}" alt="{{ whitelabel.logo_alt }}" class="qfc-main-logo">
+            </div>
 
             {% block content %}{% endblock content %}
 

docker-app/qfieldcloud/core/whitelabel.py

@@ -0,0 +1,51 @@
+import copy
+from typing import Any
+
+from django.conf import settings
+from django.http import HttpRequest
+from django.utils.translation import gettext as _
+
+# Default whitelabel configuration
+DEFAULT_WHITELABEL = {
+    # Branding
+    "site_title": _("QFieldCloud"),
+    # Logos (paths relative to static directory)
+    "logo_navbar": "logo_sidetext_white.svg",
+    "logo_main": "logo_undertext.svg",
+    "favicon": "favicon.ico",
+}
+
+
+def get_whitelabel_settings() -> dict[str, Any]:
+    """
+    Get whitelabel settings by merging user settings with defaults.
+    Filters out None values from user settings to preserve defaults.
+    """
+    # Start with a deep copy of defaults
+    whitelabel_settings = copy.deepcopy(DEFAULT_WHITELABEL)
+
+    user_settings = {}
+    for k, v in getattr(settings, "WHITELABEL", {}).items():
+        if v is None:
+            continue
+
+        user_settings[k] = v
+
+    # Update defaults with user settings
+    whitelabel_settings.update(user_settings)
+
+    # Post-processing: Add any computed defaults or normalization here
+    # Example: favicon could default to logo_navbar if not set
+    # whitelabel_settings["favicon"] = whitelabel_settings["favicon"] or "default.ico"
+
+    return whitelabel_settings
+
+
+def whitelabel(request: HttpRequest) -> dict[str, Any]:
+    """Make whitelabel configuration available to all templates with translations."""
+
+    whitelabel_config = get_whitelabel_settings()
+
+    return {
+        "whitelabel": whitelabel_config,
+    }

docker-app/qfieldcloud/settings.py

@@ -190,6 +190,7 @@
                 "django.contrib.auth.context_processors.auth",
                 "django.contrib.messages.context_processors.messages",
                 "qfieldcloud.core.context_processors.signup_open",
+                "qfieldcloud.core.whitelabel.whitelabel",
             ],
         },
     },
@@ -887,3 +888,14 @@ def before_send(event, hint):
     # Additional custom CSS file for the Django Admin pages.
     "custom_css": "css/admin.css",
 }
+
+# Whitelabel configuration
+# Uncomment and customize to override default branding
+# See qfieldcloud/core/whitelabel.py for all available options and defaults
+# WHITELABEL = {
+#     "site_title": "Your Custom Title",
+#     "logo_navbar": "path/to/logo_navbar.svg",
+#     "logo_main": "path/to/logo_main.svg",
+#     "logo_alt": "Your logo description",
+#     "favicon": "path/to/favicon.ico",
+# }