Skip to content

Commit b4c2e05

Browse files
committed
Add missing synapse_idp_id to docs
This is documented in the config schema but confusingly not visible in the docs, when it is an integral part of running `syn2mas` for a Synapse with upstream OIDC providers. Added also a short mention in the `syn2mas` page for clarity.
1 parent 98f2776 commit b4c2e05

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/reference/cli/syn2mas.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ Global options:
88
- `--synapse-config <synapse-config>`: Path to the Synapse configuration file.
99
- `--synapse-database-uri <synapse-database-uri>`: Override the Synapse database URI.
1010

11+
If your Synapse is configured with OIDC providers, note that you will need to
12+
configure the `synapse_idp_id` for them for each provider in the MAS
13+
`upstream_oauth2.providers` list. The Synapse IDP ID's can be removed after
14+
a successful migration has been completed.
15+
1116
## `syn2mas check`
1217

1318
Check the setup for potential problems before running a migration

docs/reference/configuration.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -770,6 +770,20 @@ upstream_oauth2:
770770
# This helps end user identify what account they are using
771771
account_name:
772772
#template: "@{{ user.preferred_username }}"
773+
774+
# The ID of the provider that was used by Synapse when doing a
775+
# Synapse-to-MAS migration.
776+
#
777+
# For `oidc_providers` this should be specified as `oidc-` followed by the ID
778+
# that was configured as `idp_id` in one of the `oidc_providers` in the Synapse
779+
# configuration.
780+
# For example, if Synapse's configuration contained `idp_id: wombat` for
781+
# this provider, then specify `oidc-wombat` here.
782+
#
783+
# For `oidc_config` (legacy), specify `oidc` here.
784+
#
785+
# This is safe to remove once the Synapse-to-MAS migration has been done.
786+
#synapse_idp_id: oidc
773787
```
774788

775789
## `experimental`

0 commit comments

Comments
 (0)