summary refs log tree commit diff
path: root/docs/MSC1711_certificates_FAQ.md
diff options
context:
space:
mode:
authorNeil Johnson <neil@matrix.org>2019-06-11 12:17:43 +0100
committerGitHub <noreply@github.com>2019-06-11 12:17:43 +0100
commit426218323b8475a71b3c58d7d291f0046faa62ab (patch)
treede5dab25724fe8813ed73e0c2c60c21c966842c9 /docs/MSC1711_certificates_FAQ.md
parent1.0.0rc3 (diff)
downloadsynapse-426218323b8475a71b3c58d7d291f0046faa62ab.tar.xz
Neilj/improve federation docs (#5419)
Add FAQ questions to federate.md. Add a health warning making it clear that the 1711 upgrade FAQ is now out of date.
Diffstat (limited to 'docs/MSC1711_certificates_FAQ.md')
-rw-r--r--docs/MSC1711_certificates_FAQ.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/MSC1711_certificates_FAQ.md b/docs/MSC1711_certificates_FAQ.md
index 599462bdcb..7f9a23ff31 100644
--- a/docs/MSC1711_certificates_FAQ.md
+++ b/docs/MSC1711_certificates_FAQ.md
@@ -1,5 +1,22 @@
 # MSC1711 Certificates FAQ
 
+## Historical Note
+This document was originally written to guide server admins through the upgrade
+path towards Synapse 1.0. Specifically,
+[MSC1711](https://github.com/matrix-org/matrix-doc/blob/master/proposals/1711-x509-for-federation.md)
+required that all servers present valid TLS certificates on their federation
+API. Admins were encouraged to achieve compliance from version 0.99.0 (released
+in February 2019) ahead of version 1.0 (released June 2019) enforcing the
+certificate checks.
+
+Much of what follows is now outdated since most admins will have already
+upgraded, however it may be of use to those with old installs returning to the
+project.
+
+If you are setting up a server from scratch you almost certainly should look at
+the [installation guide](INSTALL.md) instead.
+
+## Introduction
 The goal of Synapse 0.99.0 is to act as a stepping stone to Synapse 1.0.0. It
 supports the r0.1 release of the server to server specification, but is
 compatible with both the legacy Matrix federation behaviour (pre-r0.1) as well