summary refs log tree commit diff
path: root/README.rst
diff options
context:
space:
mode:
authorDavid Baker <dave@matrix.org>2017-04-26 11:31:55 +0100
committerDavid Baker <dave@matrix.org>2017-04-26 11:31:55 +0100
commit81804909d3a7c20330b2992cf1fed0672dd8f531 (patch)
treea6849618c8e3d2e6eb8f7136c8055c5c4b3e10fb /README.rst
parentFix get_json (diff)
parentdocument how to make IPv6 work (#2088) (diff)
downloadsynapse-81804909d3a7c20330b2992cf1fed0672dd8f531.tar.xz
Merge remote-tracking branch 'origin/develop' into dbkr/http_request_propagate_error
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 5be9eabdf3..d090ad86a2 100644
--- a/README.rst
+++ b/README.rst
@@ -245,6 +245,25 @@ Setting up a TURN server
 For reliable VoIP calls to be routed via this homeserver, you MUST configure
 a TURN server.  See `<docs/turn-howto.rst>`_ for details.
 
+IPv6
+----
+
+As of Synapse 0.19 we finally support IPv6, many thanks to @kyrias and @glyph
+for providing PR #1696.
+
+However, for federation to work on hosts with IPv6 DNS servers you **must**
+be running Twisted 17.1.0 or later - see https://github.com/matrix-org/synapse/issues/1002
+for details.  We can't make Synapse depend on Twisted 17.1 by default
+yet as it will break most older distributions (see https://github.com/matrix-org/synapse/pull/1909)
+so if you are using operating system dependencies you'll have to install your
+own Twisted 17.1 package via pip or backports etc.
+
+If you're running in a virtualenv then pip should have installed the newest
+Twisted automatically, but if your virtualenv is old you will need to manually
+upgrade to a newer Twisted dependency via:
+
+    pip install Twisted>=17.1.0
+
 
 Running Synapse
 ===============