Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Improve TURN documentation. #7167

Merged
merged 6 commits into from
Mar 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/7167.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve README.md by being explicit about public IP recommendation for TURN relaying.
7 changes: 7 additions & 0 deletions docs/turn-howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down