diff options
| author | Jan Christian Grünhage <jan.christian@gruenhage.xyz> | 2023-09-19 13:24:47 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-19 07:24:47 -0400 |
| commit | 3d60b07cdeb2f91a3d41b6f1190967c1c84bd325 (patch) | |
| tree | dd61866c9b657b5d85a3663cd24084c4fefcd183 | |
| parent | Bump serde_json from 1.0.106 to 1.0.107 (#16345) (diff) | |
| download | synapse-3d60b07cdeb2f91a3d41b6f1190967c1c84bd325.tar.xz | |
Use string for federation_client_minimum_tls_version documentation examples (#16353)
| -rw-r--r-- | changelog.d/16353.doc | 1 | ||||
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 8 |
2 files changed, 5 insertions, 4 deletions
diff --git a/changelog.d/16353.doc b/changelog.d/16353.doc new file mode 100644 index 0000000000..80af22ed53 --- /dev/null +++ b/changelog.d/16353.doc @@ -0,0 +1 @@ +Use string for federation_client_minimum_tls_version documentation examples. Contributed by @jcgruenhage. diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 885a7bf0a3..54315a417e 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -1133,14 +1133,14 @@ federation_verify_certificates: false The minimum TLS version that will be used for outbound federation requests. -Defaults to `1`. Configurable to `1`, `1.1`, `1.2`, or `1.3`. Note -that setting this value higher than `1.2` will prevent federation to most -of the public Matrix network: only configure it to `1.3` if you have an +Defaults to `"1"`. Configurable to `"1"`, `"1.1"`, `"1.2"`, or `"1.3"`. Note +that setting this value higher than `"1.2"` will prevent federation to most +of the public Matrix network: only configure it to `"1.3"` if you have an entirely private federation setup and you can ensure TLS 1.3 support. Example configuration: ```yaml -federation_client_minimum_tls_version: 1.2 +federation_client_minimum_tls_version: "1.2" ``` --- ### `federation_certificate_verification_whitelist` |