Upgrade Synapse (v1.14 -> v1.15)

Fixes #539 (Github Issue).
This commit is contained in:
Slavi Pantaleev 2020-06-11 15:51:56 +03:00
parent 8275739926
commit 6538ae34f5
2 changed files with 112 additions and 69 deletions

View file

@ -5,7 +5,7 @@ matrix_synapse_enabled: true
matrix_synapse_container_image_self_build: false matrix_synapse_container_image_self_build: false
matrix_synapse_docker_image: "matrixdotorg/synapse:v1.14.0" matrix_synapse_docker_image: "matrixdotorg/synapse:v1.15.0"
matrix_synapse_docker_image_force_pull: "{{ matrix_synapse_docker_image.endswith(':latest') }}" matrix_synapse_docker_image_force_pull: "{{ matrix_synapse_docker_image.endswith(':latest') }}"
matrix_synapse_base_path: "{{ matrix_base_data_path }}/synapse" matrix_synapse_base_path: "{{ matrix_base_data_path }}/synapse"

View file

@ -1199,6 +1199,13 @@ auto_join_rooms:
# #
autocreate_auto_join_rooms: {{ matrix_synapse_autocreate_auto_join_rooms|to_json }} autocreate_auto_join_rooms: {{ matrix_synapse_autocreate_auto_join_rooms|to_json }}
# When auto_join_rooms is specified, setting this flag to false prevents
# guest accounts from being automatically joined to the rooms.
#
# Defaults to true.
#
#auto_join_rooms_for_guests: false
## Metrics ### ## Metrics ###
@ -1356,6 +1363,8 @@ trusted_key_servers: {{ matrix_synapse_trusted_key_servers|to_json }}
#key_server_signing_keys_path: "key_server_signing_keys.key" #key_server_signing_keys_path: "key_server_signing_keys.key"
## Single sign-on integration ##
# Enable SAML2 for registration and login. Uses pysaml2. # Enable SAML2 for registration and login. Uses pysaml2.
# #
# At least one of `sp_config` or `config_path` must be set in this section to # At least one of `sp_config` or `config_path` must be set in this section to
@ -1489,7 +1498,13 @@ saml2_config:
# * HTML page to display to users if something goes wrong during the # * HTML page to display to users if something goes wrong during the
# authentication process: 'saml_error.html'. # authentication process: 'saml_error.html'.
# #
# This template doesn't currently need any variable to render. # When rendering, this template is given the following variables:
# * code: an HTML error code corresponding to the error that is being
# returned (typically 400 or 500)
#
# * msg: a textual message describing the error.
#
# The variables will automatically be HTML-escaped.
# #
# You can see the default templates at: # You can see the default templates at:
# https://github.com/matrix-org/synapse/tree/master/synapse/res/templates # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
@ -1497,92 +1512,119 @@ saml2_config:
#template_dir: "res/templates" #template_dir: "res/templates"
# Enable OpenID Connect for registration and login. Uses authlib. # OpenID Connect integration. The following settings can be used to make Synapse
# use an OpenID Connect Provider for authentication, instead of its internal
# password database.
#
# See https://github.com/matrix-org/synapse/blob/master/openid.md.
# #
oidc_config: oidc_config:
# enable OpenID Connect. Defaults to false. # Uncomment the following to enable authorization against an OpenID Connect
# # server. Defaults to false.
#enabled: true #
#enabled: true
# use the OIDC discovery mechanism to discover endpoints. Defaults to true. # Uncomment the following to disable use of the OIDC discovery mechanism to
# # discover endpoints. Defaults to true.
#discover: true #
#discover: false
# the OIDC issuer. Used to validate tokens and discover the providers endpoints. Required. # the OIDC issuer. Used to validate tokens and (if discovery is enabled) to
# # discover the provider's endpoints.
#issuer: "https://accounts.example.com/" #
# Required if 'enabled' is true.
#
#issuer: "https://accounts.example.com/"
# oauth2 client id to use. Required. # oauth2 client id to use.
# #
#client_id: "provided-by-your-issuer" # Required if 'enabled' is true.
#
#client_id: "provided-by-your-issuer"
# oauth2 client secret to use. Required. # oauth2 client secret to use.
# #
#client_secret: "provided-by-your-issuer" # Required if 'enabled' is true.
#
#client_secret: "provided-by-your-issuer"
# auth method to use when exchanging the token. # auth method to use when exchanging the token.
# Valid values are "client_secret_basic" (default), "client_secret_post" and "none". # Valid values are 'client_secret_basic' (default), 'client_secret_post' and
# # 'none'.
#client_auth_method: "client_secret_basic" #
#client_auth_method: client_secret_post
# list of scopes to ask. This should include the "openid" scope. Defaults to ["openid"]. # list of scopes to request. This should normally include the "openid" scope.
# # Defaults to ["openid"].
#scopes: ["openid"] #
#scopes: ["openid", "profile"]
# the oauth2 authorization endpoint. Required if provider discovery is disabled. # the oauth2 authorization endpoint. Required if provider discovery is disabled.
# #
#authorization_endpoint: "https://accounts.example.com/oauth2/auth" #authorization_endpoint: "https://accounts.example.com/oauth2/auth"
# the oauth2 token endpoint. Required if provider discovery is disabled. # the oauth2 token endpoint. Required if provider discovery is disabled.
# #
#token_endpoint: "https://accounts.example.com/oauth2/token" #token_endpoint: "https://accounts.example.com/oauth2/token"
# the OIDC userinfo endpoint. Required if discovery is disabled and the "openid" scope is not asked. # the OIDC userinfo endpoint. Required if discovery is disabled and the
# # "openid" scope is not requested.
#userinfo_endpoint: "https://accounts.example.com/userinfo" #
#userinfo_endpoint: "https://accounts.example.com/userinfo"
# URI where to fetch the JWKS. Required if discovery is disabled and the "openid" scope is used. # URI where to fetch the JWKS. Required if discovery is disabled and the
# # "openid" scope is used.
#jwks_uri: "https://accounts.example.com/.well-known/jwks.json" #
#jwks_uri: "https://accounts.example.com/.well-known/jwks.json"
# skip metadata verification. Defaults to false. # Uncomment to skip metadata verification. Defaults to false.
# Use this if you are connecting to a provider that is not OpenID Connect compliant. #
# Avoid this in production. # Use this if you are connecting to a provider that is not OpenID Connect
# # compliant.
#skip_verification: false # Avoid this in production.
#
#skip_verification: true
# An external module can be provided here as a custom solution to mapping
# An external module can be provided here as a custom solution to mapping # attributes returned from a OIDC provider onto a matrix user.
# attributes returned from a OIDC provider onto a matrix user. #
user_mapping_provider:
# The custom module's class. Uncomment to use a custom module.
# Default is 'synapse.handlers.oidc_handler.JinjaOidcMappingProvider'.
# #
user_mapping_provider: # See https://github.com/matrix-org/synapse/blob/master/docs/sso_mapping_providers.md#openid-mapping-providers
# The custom module's class. Uncomment to use a custom module. # for information on implementing a custom mapping provider.
# Default is 'synapse.handlers.oidc_handler.JinjaOidcMappingProvider'. #
#module: mapping_provider.OidcMappingProvider
# Custom configuration values for the module. This section will be passed as
# a Python dictionary to the user mapping provider module's `parse_config`
# method.
#
# The examples below are intended for the default provider: they should be
# changed if using a custom provider.
#
config:
# name of the claim containing a unique identifier for the user.
# Defaults to `sub`, which OpenID Connect compliant providers should provide.
# #
#module: mapping_provider.OidcMappingProvider #subject_claim: "sub"
# Custom configuration values for the module. Below options are intended # Jinja2 template for the localpart of the MXID.
# for the built-in provider, they should be changed if using a custom
# module. This section will be passed as a Python dictionary to the
# module's `parse_config` method.
# #
# Below is the config of the default mapping provider, based on Jinja2 # When rendering, this template is given the following variables:
# templates. Those templates are used to render user attributes, where the # * user: The claims returned by the UserInfo Endpoint and/or in the ID
# userinfo object is available through the `user` variable. # Token
# #
config: # This must be configured if using the default mapping provider.
# name of the claim containing a unique identifier for the user. #
# Defaults to `sub`, which OpenID Connect compliant providers should provide. localpart_template: "{% raw %}{{ user.preferred_username }}{% endraw %}"
#
#subject_claim: "sub"
# Jinja2 template for the localpart of the MXID # Jinja2 template for the display name to set on first login.
# #
localpart_template: "{% raw %}{{ user.preferred_username }}{% endraw %}" # If unset, no displayname will be set.
#
# Jinja2 template for the display name to set on first login. Optional. #display_name_template: "{% raw %}{{ user.given_name }} {{ user.last_name }}{% endraw %}"
#
#display_name_template: "{% raw %}{{ user.given_name }} {{ user.last_name }}{% endraw %}"
@ -1597,7 +1639,8 @@ oidc_config:
# # name: value # # name: value
# Additional settings to use with single-sign on systems such as SAML2 and CAS. # Additional settings to use with single-sign on systems such as OpenID Connect,
# SAML2 and CAS.
# #
sso: sso:
# A list of client URLs which are whitelisted so that the user does not # A list of client URLs which are whitelisted so that the user does not