summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorBrendan Abolivier <babolivier@matrix.org>2020-03-13 19:53:19 +0000
committerGitHub <noreply@github.com>2020-03-13 19:53:19 +0000
commitd8d91983bca1b449866002212cb2b60c0e6629aa (patch)
tree7b765bc1b947178e4631af93421d76ac0f1b0204 /docs
parentAdd type annotations and comments to auth handler (#7063) (diff)
parentUse innerText instead of innerHTML (diff)
downloadsynapse-d8d91983bca1b449866002212cb2b60c0e6629aa.tar.xz
Merge pull request #7067 from matrix-org/babolivier/saml_error_moar
Move the default SAML2 error HTML to a dedicated file
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_config.yaml22
1 files changed, 17 insertions, 5 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 301e6ae6b7..91eff4c8ad 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -1360,12 +1360,24 @@ saml2_config:
   #
   #grandfathered_mxid_source_attribute: upn
 
-  # Path to a file containing HTML content to serve in case an error happens
-  # when the user gets redirected from the SAML IdP back to Synapse.
-  # If no file is provided, this defaults to some minimalistic HTML telling the
-  # user that something went wrong and they should try authenticating again.
+  # Directory in which Synapse will try to find the template files below.
+  # If not set, default templates from within the Synapse package will be used.
+  #
+  # DO NOT UNCOMMENT THIS SETTING unless you want to customise the templates.
+  # If you *do* uncomment it, you will need to make sure that all the templates
+  # below are in the directory.
+  #
+  # Synapse will look for the following templates in this directory:
+  #
+  # * HTML page to display to users if something goes wrong during the
+  #   authentication process: 'saml_error.html'.
   #
-  #error_html_path: /path/to/static/content/saml_error.html
+  #   This template doesn't currently need any variable to render.
+  #
+  # You can see the default templates at:
+  # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
+  #
+  #template_dir: "res/templates"