diff options
| author | Neil Johnson <neil@matrix.org> | 2019-03-12 14:23:28 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-03-12 14:23:28 +0000 |
| commit | 8b692bf7c21bdd09fd9c3d790f06e6ef601b6793 (patch) | |
| tree | a171bfb1d780f1cc1f97bddae179669d4dc5f81a /INSTALL.md | |
| parent | Add zwsp in bug report template (#4811) (diff) | |
| download | synapse-8b692bf7c21bdd09fd9c3d790f06e6ef601b6793.tar.xz | |
Neilj/improved delegation doc 2 (#4832)
Improved federation configuration docs. Specifically detailing .well-known and SRV based delegation methods. Inspiration Valentin Lab <valentin.lab@kalysto.org> for https://github.com/matrix-org/synapse/pull/4781
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/INSTALL.md b/INSTALL.md index 2993f3a9e2..6105cd6db8 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -71,7 +71,8 @@ set this to the hostname of your server. For a more production-ready setup, you will probably want to specify your domain (`example.com`) rather than a matrix-specific hostname here (in the same way that your email address is probably `user@example.com` rather than `user@email.example.com`) - but -doing so may require more advanced setup. - see [Setting up Federation](README.rst#setting-up-federation). Beware that the server name cannot be changed later. +doing so may require more advanced setup: see [Setting up Federation](docs/federate.md). +Beware that the server name cannot be changed later. This command will generate you a config file that you can then customise, but it will also generate a set of keys for you. These keys will allow your Home Server to @@ -375,9 +376,12 @@ To configure Synapse to expose an HTTPS port, you will need to edit `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 + for having Synapse automatically provision and renew federation certificates through ACME can be found at [ACME.md](docs/ACME.md). +For those of you upgrading your TLS certificate in readiness for Synapse 1.0, +please take a look at `our guide <docs/MSC1711_certificates_FAQ.md#configuring-certificates-for-compatibility-with-synapse-100>`_. + ## Registering a user You will need at least one user on your server in order to use a Matrix |