diff options
author | Shay <hillerys@element.io> | 2022-06-30 09:21:39 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-06-30 09:21:39 -0700 |
commit | 8330fc9953032f21eb4c7d5f0627c1e6aba2459c (patch) | |
tree | 3c7d7ef7e04844c50bc8714da1cfd5d0a7365b9e /docs/setup | |
parent | Add a link to the configuration manual from the homeserver sample config docu... (diff) | |
download | synapse-8330fc9953032f21eb4c7d5f0627c1e6aba2459c.tar.xz |
Cleanup references to sample config in the docs and redirect users to configuration manual (#13077)
Diffstat (limited to 'docs/setup')
-rw-r--r-- | docs/setup/forward_proxy.md | 4 | ||||
-rw-r--r-- | docs/setup/installation.md | 14 |
2 files changed, 10 insertions, 8 deletions
diff --git a/docs/setup/forward_proxy.md b/docs/setup/forward_proxy.md index 494c14893b..3482691f83 100644 --- a/docs/setup/forward_proxy.md +++ b/docs/setup/forward_proxy.md @@ -66,8 +66,8 @@ in Synapse can be deactivated. **NOTE**: This has an impact on security and is for testing purposes only! -To deactivate the certificate validation, the following setting must be made in -[homserver.yaml](../usage/configuration/homeserver_sample_config.md). +To deactivate the certificate validation, the following setting must be added to +your [homserver.yaml](../usage/configuration/homeserver_sample_config.md). ```yaml use_insecure_ssl_client_just_for_testing_do_not_use: true diff --git a/docs/setup/installation.md b/docs/setup/installation.md index 1580529fd1..260e50577b 100644 --- a/docs/setup/installation.md +++ b/docs/setup/installation.md @@ -407,11 +407,11 @@ The recommended way to do so is to set up a reverse proxy on port Alternatively, you can configure Synapse to expose an HTTPS port. To do so, you will need to edit `homeserver.yaml`, as follows: -- First, under the `listeners` section, uncomment the configuration for the - TLS-enabled listener. (Remove the hash sign (`#`) at the start of - each line). The relevant lines are like this: +- First, under the `listeners` option, add the configuration for the + TLS-enabled listener like so: ```yaml +listeners: - port: 8448 type: http tls: true @@ -419,9 +419,11 @@ so, you will need to edit `homeserver.yaml`, as follows: - names: [client, federation] ``` -- You will also need to uncomment the `tls_certificate_path` and - `tls_private_key_path` lines under the `TLS` section. You will need to manage - provisioning of these certificates yourself. +- You will also need to add the options `tls_certificate_path` and + `tls_private_key_path`. to your configuration file. You will need to manage provisioning of + these certificates yourself. +- You can find more information about these options as well as how to configure synapse in the + [configuration manual](../usage/configuration/config_documentation.md). If you are using your own certificate, be sure to use a `.pem` file that includes the full certificate chain including any intermediate certificates |