diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2021-01-21 12:25:02 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-21 12:25:02 +0000 |
| commit | 7447f197026db570c1c1af240642566b31f81e42 (patch) | |
| tree | f4c1707b40e8161918b732589f6ee64048e5dd0d /docs | |
| parent | Fix a typo in the release notes. (diff) | |
| download | synapse-7447f197026db570c1c1af240642566b31f81e42.tar.xz | |
Prefix idp_id with "oidc-" (#9189)
... to avoid clashes with other SSO mechanisms
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sample_config.yaml | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index b49a5da8cc..87bfe22237 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -1728,7 +1728,9 @@ saml2_config: # # idp_icon: An optional icon for this identity provider, which is presented # by identity picker pages. If given, must be an MXC URI of the format -# mxc://<server-name>/<media-id> +# mxc://<server-name>/<media-id>. (An easy way to obtain such an MXC URI +# is to upload an image to an (unencrypted) room and then copy the "url" +# from the source of the event.) # # discover: set to 'false' to disable the use of the OIDC discovery mechanism # to discover endpoints. Defaults to true. @@ -1814,13 +1816,16 @@ saml2_config: # # For backwards compatibility, it is also possible to configure a single OIDC # provider via an 'oidc_config' setting. This is now deprecated and admins are -# advised to migrate to the 'oidc_providers' format. +# advised to migrate to the 'oidc_providers' format. (When doing that migration, +# use 'oidc' for the idp_id to ensure that existing users continue to be +# recognised.) # oidc_providers: # Generic example # #- idp_id: my_idp # idp_name: "My OpenID provider" + # idp_icon: "mxc://example.com/mediaid" # discover: false # issuer: "https://accounts.example.com/" # client_id: "provided-by-your-issuer" @@ -1844,8 +1849,8 @@ oidc_providers: # For use with Github # - #- idp_id: google - # idp_name: Google + #- idp_id: github + # idp_name: Github # discover: false # issuer: "https://github.com/" # client_id: "your-client-id" # TO BE FILLED |