summary refs log tree commit diff
diff options
context:
space:
mode:
authorNeil Johnson <neil@matrix.org>2019-06-10 16:22:31 +0100
committerNeil Johnson <neil@matrix.org>2019-06-10 16:22:31 +0100
commitcac2e11e36d3d18604b094e1fe24ed457f6c3f3d (patch)
tree8b1dbdda18aa7d23c1b19832269e8d2a125d9d71
parent1.0.0rc1 (diff)
downloadsynapse-cac2e11e36d3d18604b094e1fe24ed457f6c3f3d.tar.xz
add a health warning making it clear that the 1711 upgrade FAQ is now out of date
-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..d0d4a88a48 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.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 (release
+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