From 68fc0dcb5a3612c869259573f50bee5d388a8a66 Mon Sep 17 00:00:00 2001
From: Marcus Schopen <lists@localguru.de>
Date: Fri, 13 Nov 2020 13:07:50 +0100
Subject: [PATCH] SAML: add <mdui:UIInfo> element examples (#8718)

add some mdui:UIInfo element examples for saml2_config in homeserver.yaml
---
 changelog.d/8718.misc          |  1 +
 docs/sample_config.yaml        | 22 ++++++++++++++++++++++
 synapse/config/saml2_config.py | 22 ++++++++++++++++++++++
 3 files changed, 45 insertions(+)
 create mode 100644 changelog.d/8718.misc

diff --git a/changelog.d/8718.misc b/changelog.d/8718.misc
new file mode 100644
index 000000000..f1868ce70
--- /dev/null
+++ b/changelog.d/8718.misc
@@ -0,0 +1 @@
+Add some `mdui:UIInfo` element examples for `saml2_config` in the homeserver config.
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 7e2cf97c3..c0cd00923 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -1560,6 +1560,28 @@ saml2_config:
     #description: ["My awesome SP", "en"]
     #name: ["Test SP", "en"]
 
+    #ui_info:
+    #  display_name:
+    #    - lang: en
+    #      text: "Display Name is the descriptive name of your service."
+    #  description:
+    #    - lang: en
+    #      text: "Description should be a short paragraph explaining the purpose of the service."
+    #  information_url:
+    #    - lang: en
+    #      text: "https://example.com/terms-of-service"
+    #  privacy_statement_url:
+    #    - lang: en
+    #      text: "https://example.com/privacy-policy"
+    #  keywords:
+    #    - lang: en
+    #      text: ["Matrix", "Element"]
+    #  logo:
+    #    - lang: en
+    #      text: "https://example.com/logo.svg"
+    #      width: "200"
+    #      height: "80"
+
     #organization:
     #  name: Example com
     #  display_name:
diff --git a/synapse/config/saml2_config.py b/synapse/config/saml2_config.py
index 778750f43..2ff7dfb31 100644
--- a/synapse/config/saml2_config.py
+++ b/synapse/config/saml2_config.py
@@ -271,6 +271,28 @@ class SAML2Config(Config):
             #description: ["My awesome SP", "en"]
             #name: ["Test SP", "en"]
 
+            #ui_info:
+            #  display_name:
+            #    - lang: en
+            #      text: "Display Name is the descriptive name of your service."
+            #  description:
+            #    - lang: en
+            #      text: "Description should be a short paragraph explaining the purpose of the service."
+            #  information_url:
+            #    - lang: en
+            #      text: "https://example.com/terms-of-service"
+            #  privacy_statement_url:
+            #    - lang: en
+            #      text: "https://example.com/privacy-policy"
+            #  keywords:
+            #    - lang: en
+            #      text: ["Matrix", "Element"]
+            #  logo:
+            #    - lang: en
+            #      text: "https://example.com/logo.svg"
+            #      width: "200"
+            #      height: "80"
+
             #organization:
             #  name: Example com
             #  display_name: