summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorJostein Kjønigsen <jostein@kjonigsen.net>2020-03-31 16:50:48 +0200
committerGitHub <noreply@github.com>2020-03-31 15:50:48 +0100
commit2e826cd80c97cbdcec3e600b802c43ec27263e39 (patch)
treed66d3387722395112dca6d006995950538f156b4 /docs
parentFix "'NoneType' has no attribute start|stop" logcontext errors (#7181) (diff)
downloadsynapse-2e826cd80c97cbdcec3e600b802c43ec27263e39.tar.xz
Improve TURN documentation. (#7167)
Diffstat (limited to 'docs')
-rw-r--r--docs/turn-howto.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/turn-howto.md b/docs/turn-howto.md
index 1bd3943f54..b26e41f19e 100644
--- a/docs/turn-howto.md
+++ b/docs/turn-howto.md
@@ -11,6 +11,13 @@ TURN server.
 
 The following sections describe how to install [coturn](<https://github.com/coturn/coturn>) (which implements the TURN REST API) and integrate it with synapse.
 
+## Requirements
+
+For TURN relaying with `coturn` to work, it must be hosted on a server/endpoint with a public IP.
+
+Hosting TURN behind a NAT (even with appropriate port forwarding) is known to cause issues
+and to often not work.
+
 ## `coturn` Setup
 
 ### Initial installation