diff options
author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2019-02-19 13:09:38 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-02-19 13:09:38 +0000 |
commit | 49b58f0a167a4ede6612e6445892be464fa31109 (patch) | |
tree | 203adc0e3c5010d92df05b81ee93b5b177373f80 /INSTALL.md | |
parent | Merge pull request #4676 from matrix-org/rav/pg95 (diff) | |
download | synapse-49b58f0a167a4ede6612e6445892be464fa31109.tar.xz |
clarify TLS instructions
Diffstat (limited to 'INSTALL.md')
-rw-r--r-- | INSTALL.md | 39 |
1 files changed, 19 insertions, 20 deletions
diff --git a/INSTALL.md b/INSTALL.md index fb6a5e4e99..2993f3a9e2 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -358,26 +358,25 @@ For information on using a reverse proxy, see [docs/reverse_proxy.rst](docs/reverse_proxy.rst). To configure Synapse to expose an HTTPS port, you will need to edit -`homeserver.yaml`. - -First, under the `listeners` section, uncomment the configuration for the -TLS-enabled listener. (Remove the hash sign (`#`) and space at the start of -each line). The relevant lines are like this: - -``` - - port: 8448 - type: http - tls: true - resources: - - names: [client, federation] -``` - -You will also need to uncomment the `tls_certificate_path` and -`tls_private_key_path` lines under the `TLS` section. You can either point -these settings at an existing certificate and key, or you can enable Synapse's -built-in ACME (Let's Encrypt) support. Instructions for having Synapse -automatically provision and renew federation certificates through ACME can be -found at [ACME.md](docs/ACME.md). +`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: + + ``` + - port: 8448 + type: http + tls: true + resources: + - names: [client, federation] + ``` +* You will also need to uncomment the `tls_certificate_path` and + `tls_private_key_path` lines under the `TLS` section. You can either + point these settings at an existing certificate and key, or you can + enable Synapse's built-in ACME (Let's Encrypt) support. Instructions + for having Synapse automatically provision and renew federation + certificates through ACME can be found at [ACME.md](docs/ACME.md). ## Registering a user |