From cfc6b33eaa0c6005d290d080a56c1e3ea18e7f05 Mon Sep 17 00:00:00 2001
From: Alex Vandiver <alexmv@zulip.com>
Date: Mon, 3 Nov 2025 15:26:36 -0500
Subject: [PATCH] settings: Clarify that display_icon can be a full URL.

---
 zproject/prod_settings_template.py | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/zproject/prod_settings_template.py b/zproject/prod_settings_template.py
index ee948a7bfa..59b8d34880 100644
--- a/zproject/prod_settings_template.py
+++ b/zproject/prod_settings_template.py
@@ -458,10 +458,12 @@ SOCIAL_AUTH_SAML_ENABLED_IDPS: dict[str, Any] = {
         ## the login button.
         "display_name": "SAML",
         ##
-        ## Path to a square image file containing a logo to appear at
+        ## URL of a square image file containing a logo to appear at
         ## the left end of the login/register buttons for this IDP.
-        ## The default of None results in a text-only button.
-        # "display_icon": "/path/to/icon.png",
+        ## This can be a relative path, on the same host, most likely
+        ## under /static/ (stored in ~zulip/prod-static/). The default
+        ## of None results in a text-only button.
+        # "display_icon": "https://example.com/path/to/icon.png",
         ##
         ## If you want this IdP to only be enabled for authentication
         ## to certain subdomains, uncomment and edit the setting below.