diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 24c3cab0..6d297f05 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -13,7 +13,7 @@ - [Homeserver configuration](./setup/homeserver.md) - [Configuring a reverse proxy](./setup/reverse-proxy.md) - [Running the service](./setup/running.md) - +- [Migrating an existing homeserver](./setup/migration.md) # Usage - [Configuration file reference](./usage/configuration.md) diff --git a/docs/setup/migration.md b/docs/setup/migration.md new file mode 100644 index 00000000..ae9d5ea9 --- /dev/null +++ b/docs/setup/migration.md @@ -0,0 +1,15 @@ +# Migrating an existing homeserver + +One of the design goals of MAS has been to allow it to be used to migrate an existing homeserver to an OIDC-based architecture. + +Specifically without requiring users to re-authenticate and that non-OIDC clients continue to work. + +Features that are provided to support this include: + +- Ability to import existing password hashes from Synapse +- Ability to import existing sessions and devices +- Ability to import existing access tokens +- Ability to import existing upstream IdP subject ID mappings +- Provides a compatibility layer for legacy Matrix authentication + +There will be tools to help with the migration process itself. But these aren't quite ready yet.