diff options
| author | Jostein Kjønigsen <jostein@kjonigsen.net> | 2020-03-31 16:50:48 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-31 15:50:48 +0100 |
| commit | 2e826cd80c97cbdcec3e600b802c43ec27263e39 (patch) | |
| tree | d66d3387722395112dca6d006995950538f156b4 | |
| parent | Fix "'NoneType' has no attribute start|stop" logcontext errors (#7181) (diff) | |
| download | synapse-2e826cd80c97cbdcec3e600b802c43ec27263e39.tar.xz | |
Improve TURN documentation. (#7167)
| -rw-r--r-- | changelog.d/7167.doc | 1 | ||||
| -rw-r--r-- | docs/turn-howto.md | 7 |
2 files changed, 8 insertions, 0 deletions
diff --git a/changelog.d/7167.doc b/changelog.d/7167.doc new file mode 100644 index 0000000000..a7e7ba9b51 --- /dev/null +++ b/changelog.d/7167.doc @@ -0,0 +1 @@ +Improve README.md by being explicit about public IP recommendation for TURN relaying. 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 |