Browse Source

Improve TURN documentation. (#7167)

Jostein Kjønigsen 4 years ago
parent
commit
2e826cd80c
2 changed files with 8 additions and 0 deletions
  1. 1 0
      changelog.d/7167.doc
  2. 7 0
      docs/turn-howto.md

+ 1 - 0
changelog.d/7167.doc

@@ -0,0 +1 @@
+Improve README.md by being explicit about public IP recommendation for TURN relaying.

+ 7 - 0
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