Skip to content

Commit b9985ba

Browse files
authored
Update MLS section of docs in developer/reference/config-options.md (#3763)
1 parent 1637ea3 commit b9985ba

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/src/developer/reference/config-options.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -291,11 +291,11 @@ sndFactorPasswordChallenge:
291291

292292
### MLS
293293

294-
This feature specifies how should behave. It has no effect on the server's behaviour.
294+
If this feature is enabled then clients that support the MLS feature will allow its user to switch between Proteus and the MLS protocol provided the user is listed in `protocolToggleUsers`. The default protocol that clients will create new conversations with is specified in `defaultProtocol`. The `supportedProtocols` array is an ordered list of protocols which may be used by the client. It is used to determine the protocol to use for 1:1 conversations. It must contain the `defaultProtocol`.
295295

296-
If this feature is enabled then clients that support this feature will allowing its user to switch between Proteus and the MLS protocol provided the user is listed ini `protocolToggleUsers`. The default protocol that clients will create new conversations with is specified in `defaultProtocol`. The `defaultCipherSuite` and `allowedCipherSuites` contain the default ciphersuite and the allowed ciphersuites that clients should be using. The numerical values should correspond to the indices (starting at 1) specified here https://messaginglayersecurity.rocks/mls-protocol/draft-ietf-mls-protocol.html#table-5
296+
The `defaultCipherSuite` and `allowedCipherSuites` contain the default ciphersuite and the allowed ciphersuites that clients should be using. The numerical values should correspond to the indices (starting at 1) specified [here](https://www.rfc-editor.org/rfc/rfc9420.html#table-6).
297297

298-
If this feature is disabled then clients will use the Proteus protocol with this backend.
298+
If the MLS feature is disabled then clients will use the Proteus protocol with this backend.
299299

300300
The default configuration that applies to all teams that didn't explicitly change their feature configuration can be given in galley's `featureFlags` section in the config file:
301301

@@ -307,9 +307,9 @@ mls:
307307
config:
308308
protocolToggleUsers: []
309309
defaultProtocol: mls
310+
supportedProtocols: [proteus, mls] # must contain defaultProtocol
310311
allowedCipherSuites: [1]
311312
defaultCipherSuite: 1
312-
supportedProtocols: [proteus, mls] # must contain defaultProtocol
313313
lockStatus: locked
314314
```
315315

0 commit comments

Comments
 (0)