summary refs log tree commit diff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorBrendan Abolivier <babolivier@matrix.org>2020-02-13 17:22:44 +0000
committerBrendan Abolivier <babolivier@matrix.org>2020-02-13 17:22:44 +0000
commit71cc6bab5fc37f20a8fc14a52d8bd7930aec1c23 (patch)
tree816ec8c1b930aae7f38ec75442a26cbf26904105 /INSTALL.md
parentUpdate changelog for #6905 to group it with upcoming PRs (diff)
downloadsynapse-71cc6bab5fc37f20a8fc14a52d8bd7930aec1c23.tar.xz
Update INSTALL.md to recommend reverse proxying and warn about ACMEv1 deprecation
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md26
1 files changed, 15 insertions, 11 deletions
diff --git a/INSTALL.md b/INSTALL.md
index d25fcf0753..42132f1eb4 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -388,15 +388,17 @@ Once you have installed synapse as above, you will need to configure it.
 
 ## TLS certificates
 
-The default configuration exposes a single HTTP port: http://localhost:8008. It
-is suitable for local testing, but for any practical use, you will either need
-to enable a reverse proxy, or configure Synapse to expose an HTTPS port.
+The default configuration exposes a single HTTP port on the local
+interface: `http://localhost:8008`. It is suitable for local testing,
+but for any practical use, you will need Synapse's APIs to be served
+over HTTPS.
 
-For information on using a reverse proxy, see
+The recommended way to do so is to set up a reverse proxy on port
+`8448`. You can find documentation on doing so in
 [docs/reverse_proxy.md](docs/reverse_proxy.md).
 
-To configure Synapse to expose an HTTPS port, you will need to edit
-`homeserver.yaml`, as follows:
+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
@@ -414,11 +416,13 @@ To configure Synapse to expose an HTTPS port, you will need to edit
   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). If you
-  are using your own certificate, be sure to use a `.pem` file that includes
-  the full certificate chain including any intermediate certificates (for
-  instance, if using certbot, use `fullchain.pem` as your certificate, not
-  `cert.pem`).
+  certificates through ACME can be found at [ACME.md](docs/ACME.md).
+  Note that, as pointed out in that document, this feature will not
+  work with installs set up after November 2020. If you are using your
+  own certificate, be sure to use a `.pem` file that includes the full
+  certificate chain including any intermediate certificates (for
+  instance, if using certbot, use `fullchain.pem` as your certificate,
+  not `cert.pem`).
 
 For a more detailed guide to configuring your server for federation, see
 [federate.md](docs/federate.md)