Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Document using a certificate with a full chain #4849

Merged
merged 13 commits into from
Mar 13, 2019
9 changes: 6 additions & 3 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -374,9 +374,12 @@ To configure Synapse to expose an HTTPS port, you will need to edit
* 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).
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 and key, be sure to use a certificate that
includes a full chain (for instance, if using certbot, use `fullchain.pem`
as your certificate, not `cert.pem`).

## Registering a user

Expand Down
1 change: 1 addition & 0 deletions changelog.d/4849.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update install docs to explicitly state a full-chain (not just the top-level) TLS certificate must be provided to Synapse. This caused some people's Synapse ports to appear correct in a browser but still (rightfully so) upset the federation tester.