Skip to content

Add missing synapse_idp_id to docs #4576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/reference/cli/syn2mas.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ Global options:
- `--synapse-config <synapse-config>`: Path to the Synapse configuration file.
- `--synapse-database-uri <synapse-database-uri>`: Override the Synapse database URI.

If your Synapse is configured with OIDC providers, note that you will need to
configure the `synapse_idp_id` for them for each provider in the MAS
`upstream_oauth2.providers` list. The Synapse IDP ID's can be removed after
a successful migration has been completed.

## `syn2mas check`

Check the setup for potential problems before running a migration
Expand Down
14 changes: 14 additions & 0 deletions docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -770,6 +770,20 @@ upstream_oauth2:
# This helps end user identify what account they are using
account_name:
#template: "@{{ user.preferred_username }}"

# The ID of the provider that was used by Synapse when doing a
# Synapse-to-MAS migration.
#
# For `oidc_providers` this should be specified as `oidc-` followed by the ID
# that was configured as `idp_id` in one of the `oidc_providers` in the Synapse
# configuration.
# For example, if Synapse's configuration contained `idp_id: wombat` for
# this provider, then specify `oidc-wombat` here.
#
# For `oidc_config` (legacy), specify `oidc` here.
#
# This is safe to remove once the Synapse-to-MAS migration has been done.
#synapse_idp_id: oidc
```

## `experimental`
Expand Down
Loading