Add SITE_LOGO_URL setting

Fixes: #323

CHANGELOG.md

@@ -5,6 +5,7 @@ All notable changes to this project will be documented in this file.
 
 ### Improvements
 - Use multicolor channel icons for better appearance in the dark mode
+- Add SITE_LOGO_URL setting (#323)
 
 ### Bug Fixes
 - Fix dark mode styling issues in Cron Syntax Cheatsheet

hc/front/context_processors.py

@@ -2,4 +2,8 @@ from django.conf import settings
 
 
 def branding(request):
-    return {"site_name": settings.SITE_NAME, "site_root": settings.SITE_ROOT}
+    return {
+        "site_name": settings.SITE_NAME,
+        "site_root": settings.SITE_ROOT,
+        "site_logo_url": settings.SITE_LOGO_URL,
+    }

hc/settings.py

@@ -155,6 +155,7 @@ LOCALE_PATHS = (os.path.join(BASE_DIR, "locale"),)
 
 SITE_ROOT = os.getenv("SITE_ROOT", "http://localhost:8000")
 SITE_NAME = os.getenv("SITE_NAME", "Mychecks")
+SITE_LOGO_URL = os.getenv("SITE_LOGO_URL")
 MASTER_BADGE_LABEL = os.getenv("MASTER_BADGE_LABEL", SITE_NAME)
 PING_ENDPOINT = os.getenv("PING_ENDPOINT", SITE_ROOT + "/ping/")
 PING_EMAIL_DOMAIN = os.getenv("PING_EMAIL_DOMAIN", "localhost")

templates/base.html

@@ -82,19 +82,15 @@
             {% if request.user.is_authenticated and project %}
                 {{ project }}
                 <span class="caret"></span>
-            {% elif request.user.is_authenticated%}
-                <img
-                    id="logo"
-                    height="50"
-                    src="{% static 'img/logo.png'%}"
-                    srcset="{% static 'img/logo.png'%} 1x, {% static 'img/logo@2x.png'%} 2x"
-                    alt="{{ site_name }}">
             {% else %}
                 <img
                     id="logo"
                     height="50"
-                    src="{% static 'img/logo-full.png'%}"
-                    srcset="{% static 'img/logo-full.png'%} 1x, {% static 'img/logo-full@2x.png'%} 2x"
+                    {% if site_logo_url %}
+                    src="{{ site_logo_url }}"
+                    {% else %}
+                    src="{% static 'img/logo.png' %}"
+                    {% endif %}
                     alt="{{ site_name }}">
             {% endif %}
             </a>

templates/docs/self_hosted_configuration.html

@@ -287,6 +287,14 @@ notifications. Healthcecks interacts with signal-cli over DBus.</p>
   example given in the signal-cli instructions.</li>
 <li>Set the <code>SIGNAL_CLI_ENABLED</code> environment variable to <code>True</code>.</li>
 </ul>
+<h2 id="SITE_LOGO_URL"><code>SITE_LOGO_URL</code></h2>
+<p>Default: <code>None</code></p>
+<p>An URL pointing to the image you want to use as the site logo. If not set,
+Healthchecks will use a fallback image (<code>/static/img/logo.png</code>).</p>
+<p>Example:</p>
+<div class="highlight"><pre><span></span><code><span class="na">SITE_LOGO_URL</span><span class="o">=</span><span class="s">https://example.org/my-custom-logo.svg</span>
+</code></pre></div>
+
 <h2 id="SITE_NAME"><code>SITE_NAME</code></h2>
 <p>Default: <code>Mychecks</code></p>
 <p>The display name of this Healthchecks instance. Healthchecks uses it throughout

templates/docs/self_hosted_configuration.md

@@ -456,6 +456,19 @@ To enable the Signal integration:
   example given in the signal-cli instructions.
 * Set the `SIGNAL_CLI_ENABLED` environment variable to `True`.
 
+## `SITE_LOGO_URL` {: #SITE_LOGO_URL }
+
+Default: `None`
+
+An URL pointing to the image you want to use as the site logo. If not set,
+Healthchecks will use a fallback image (`/static/img/logo.png`).
+
+Example:
+
+```ini
+SITE_LOGO_URL=https://example.org/my-custom-logo.svg
+```
+
 ## `SITE_NAME` {: #SITE_NAME }
 
 Default: `Mychecks`