You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/syn2mas.md
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,17 +20,24 @@ The syn2mas migration will run in a couple of minutes. It involves **three key s
20
20
| 2 | Run migration (dry run disabled) | System transitions to `syn2mas_migrated`. Users now login using the delegated authentication. Rollback to legacy authentication is not possible anymore. syn2mas cannot be run anymore. |
21
21
| 3 | Disable syn2mas | System finalizes to `delegated_auth`. |
22
22
23
+
## Important Notes
24
+
25
+
- Please make sure to backup the synapse database before running the migration.
26
+
- The migration is a **one-way process**.Once the system is in the `delegated_auth` state, it cannot be rolled back to `legacy_auth`.
27
+
23
28
## Step-by-Step Upgrade Process
24
29
25
-
### Step 1: Setup Matrix Authenticatin Service and prepare the migration
30
+
### Step 1: Setup Matrix Authentication Service and prepare the migration
26
31
27
32
1. You need to enable Matrix Authentication Service. The minimal settings required are described in `charts/matrix-stack/ci/fragments/matrix-authentication-service-minimal.yaml`. This is a minimal configuration that you can use if :
28
33
- The `initSecrets` job is enabled (default)
29
34
- You are using the chart-managed Postgres Server (we recommend using an external Postgres Server)
30
35
31
-
2. If you are using an external Postgres database, please refer to the quick-setup example in `charts/matrix-stack/ci/fragments/quick-setup-postgresql.yaml` to configure the Matrix Authentication Service database.
36
+
2. To migrate passwords from Synapse to Matrix Authentication Service, you need to enable Synapse passwords scheme into Matrix Authentication Service. Enable them under `matrixAuthenticationService.additional` according to the example file `charts/matrix-stack/ci/fragments/matrix-authentication-service-migrated-password-scheme.yaml`.
37
+
38
+
3. If you are using an external Postgres database, please refer to the quick-setup example in `charts/matrix-stack/ci/fragments/quick-setup-postgresql.yaml` to configure the Matrix Authentication Service database.
32
39
33
-
3. If you have disabled the `initSecrets` job, please refer to the example in `charts/matrix-stack/ci/fragments/matrix-authentication-service-secrets-in-helm.yaml` to configure the secrets manually.
40
+
4. If you have disabled the `initSecrets` job, please refer to the example in `charts/matrix-stack/ci/fragments/matrix-authentication-service-secrets-in-helm.yaml` to configure the secrets manually.
34
41
35
42
5. Run the helm upgrade command and enable syn2mas with `--set matrixAuthenticationService.syn2mas.enabled=true` :
36
43
@@ -89,11 +96,5 @@ If the `deploymentMarkers` feature is enabled, the `MATRIX_STACK_MSC3861` marker
0 commit comments