From 900bca970790f01fd1416b217e678f6ea6325f95 Mon Sep 17 00:00:00 2001
From: Brendan Abolivier <babolivier@matrix.org>
Date: Wed, 11 Mar 2020 19:40:30 +0000
Subject: [PATCH] Update wording and config
---
docs/sample_config.yaml | 3 +++
synapse/config/saml2_config.py | 3 +++
synapse/res/templates/saml_error.html | 4 ++--
3 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 301e6ae6b7..36be995726 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -1365,6 +1365,9 @@ saml2_config:
# If no file is provided, this defaults to some minimalistic HTML telling the
# user that something went wrong and they should try authenticating again.
#
+ # See https://github.com/matrix-org/synapse/blob/master/synapse/res/templates/saml_error.html
+ # for an example.
+ #
#error_html_path: /path/to/static/content/saml_error.html
diff --git a/synapse/config/saml2_config.py b/synapse/config/saml2_config.py
index 882aa3bb5b..1526f72748 100644
--- a/synapse/config/saml2_config.py
+++ b/synapse/config/saml2_config.py
@@ -343,6 +343,9 @@ class SAML2Config(Config):
# If no file is provided, this defaults to some minimalistic HTML telling the
# user that something went wrong and they should try authenticating again.
#
+ # See https://github.com/matrix-org/synapse/blob/master/synapse/res/templates/saml_error.html
+ # for an example.
+ #
#error_html_path: /path/to/static/content/saml_error.html
""" % {
"config_dir_path": config_dir_path
diff --git a/synapse/res/templates/saml_error.html b/synapse/res/templates/saml_error.html
index c112ac833f..223d3a74bc 100644
--- a/synapse/res/templates/saml_error.html
+++ b/synapse/res/templates/saml_error.html
@@ -24,8 +24,8 @@
// we just don't print anything specific.
let searchStr = "";
if (window.location.search) {
- // For some reason window.location.searchParams isn't always defined when
- // window.location.search is, so we can't just use it right away.
+ // window.location.searchParams isn't always defined when
+ // window.location.search is, so it's more reliable to parse the latter.
searchStr = window.location.search;
} else if (window.location.hash) {
// Replace the # with a ? so that URLSearchParams does the right thing and
--
GitLab