Skip to content

Commit 8715597

Browse files
docs: mention synapse & mas password scheme configuration
1 parent d3c1474 commit 8715597

3 files changed

Lines changed: 27 additions & 12 deletions

File tree

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Copyright 2025 New Vector Ltd
2+
#
3+
# SPDX-License-Identifier: AGPL-3.0-only
4+
5+
matrixAuthenticationService:
6+
additional:
7+
password-scheme.yml:
8+
config: |
9+
passwords:
10+
schemes:
11+
- version: 1
12+
algorithm: bcrypt
13+
- version: 2
14+
algorithm: argon2id

charts/matrix-stack/ci/pytest-matrix-authentication-service-syn2mas-values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#
33
# SPDX-License-Identifier: AGPL-3.0-only
44
#
5-
# source_fragments: synapse-minimal.yaml synapse-pytest-base-extras.yaml matrix-authentication-service-pytest-extras.yaml matrix-authentication-service-syn2mas-dryrun.yaml init-secrets-minimal.yaml init-secrets-pytest-extras.yaml postgres-minimal.yaml deployment-markers-pytest-extras.yaml
5+
# source_fragments: synapse-minimal.yaml synapse-pytest-base-extras.yaml matrix-authentication-service-pytest-extras.yaml matrix-authentication-service-syn2mas-dryrun.yaml init-secrets-minimal.yaml init-secrets-pytest-extras.yaml postgres-minimal.yaml deployment-markers-pytest-extras.yaml matrix-authentication-service-migrated-password-scheme.yaml
66
# DO NOT EDIT DIRECTLY. Edit the fragment files to add / modify / remove values
77

88
deploymentMarkers:

docs/syn2mas.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,24 @@ The syn2mas migration will run in a couple of minutes. It involves **three key s
2020
| 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. |
2121
| 3 | Disable syn2mas | System finalizes to `delegated_auth`. |
2222

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+
2328
## Step-by-Step Upgrade Process
2429

25-
### Step 1: Setup Matrix Authenticatin Service and prepare the migration
30+
### Step 1: Setup Matrix Authentication Service and prepare the migration
2631

2732
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 :
2833
- The `initSecrets` job is enabled (default)
2934
- You are using the chart-managed Postgres Server (we recommend using an external Postgres Server)
3035

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.
3239

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.
3441

3542
5. Run the helm upgrade command and enable syn2mas with `--set matrixAuthenticationService.syn2mas.enabled=true` :
3643

@@ -89,11 +96,5 @@ If the `deploymentMarkers` feature is enabled, the `MATRIX_STACK_MSC3861` marker
8996
4. **After Step 3**`delegated_auth` (migration finalized)
9097

9198
> ⚠️ **Note:** The `MATRIX_STACK_MSC3861` marker will :
92-
> **Prevent running syn2mas migration again** after it has run successfully and is in `syn2mas_migrated` state
93-
> **Prevent downgrading** from `syn2mas_migrated`/`delegated_auth` back to `legacy_auth`
94-
95-
96-
## Important Notes
97-
98-
- Please make sure to backup the synapse database before running the migration.
99-
- The migration is a **one-way process**.Once the system is in the `delegated_auth` state, it cannot be rolled back to `legacy_auth`.
99+
> - **Prevent running syn2mas migration again** after it has run successfully and is in `syn2mas_migrated` state
100+
> - **Prevent downgrading** from `syn2mas_migrated`/`delegated_auth` back to `legacy_auth`

0 commit comments

Comments
 (0)