From f37cd8009a6d15a6279fc92190c87ab73c727a3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jostein=20Kj=C3=B8nigsen?= Date: Sat, 28 Mar 2020 18:53:19 +0100 Subject: [PATCH 1/6] Improve TURN documentation. Public IP seems to be a fixed requirement, and not mentioning it in the docs is guaranteed to have people waste their time on setups which will never work. --- docs/turn-howto.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/turn-howto.md b/docs/turn-howto.md index 1bd3943f54b4..b7697243a338 100644 --- a/docs/turn-howto.md +++ b/docs/turn-howto.md @@ -11,6 +11,12 @@ TURN server. The following sections describe how to install [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 pirt forwarding) is known to cause issues and often not work. + ## `coturn` Setup ### Initial installation From a52a6e0c50d002dedb3ac7807d1b868a5ef6986c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jostein=20Kj=C3=B8nigsen?= Date: Mon, 30 Mar 2020 15:08:18 +0200 Subject: [PATCH 2/6] Update docs/turn-howto.md Co-Authored-By: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> --- docs/turn-howto.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/turn-howto.md b/docs/turn-howto.md index b7697243a338..426af604e79c 100644 --- a/docs/turn-howto.md +++ b/docs/turn-howto.md @@ -15,7 +15,8 @@ The following sections describe how to install [coturn]( Date: Mon, 30 Mar 2020 15:08:27 +0200 Subject: [PATCH 3/6] Update docs/turn-howto.md Co-Authored-By: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> --- docs/turn-howto.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/turn-howto.md b/docs/turn-howto.md index 426af604e79c..b26e41f19e14 100644 --- a/docs/turn-howto.md +++ b/docs/turn-howto.md @@ -11,7 +11,7 @@ TURN server. The following sections describe how to install [coturn]() (which implements the TURN REST API) and integrate it with synapse. -## requirements +## Requirements For TURN relaying with `coturn` to work, it must be hosted on a server/endpoint with a public IP. From 0b09ec161f47a0f50c80095a0934d7feaca9d27f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jostein=20Kj=C3=B8nigsen?= Date: Tue, 31 Mar 2020 07:23:45 +0200 Subject: [PATCH 4/6] Add changelog. --- changelog.d/7167.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/7167.doc diff --git a/changelog.d/7167.doc b/changelog.d/7167.doc new file mode 100644 index 000000000000..553dc6c92ca6 --- /dev/null +++ b/changelog.d/7167.doc @@ -0,0 +1 @@ +Improve README.md. Be explicit about public IP recomendation. \ No newline at end of file From 378d166b591470ae5faab1892a0f504e74ae3095 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 31 Mar 2020 15:14:58 +0100 Subject: [PATCH 5/6] Update changelog --- changelog.d/7167.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/7167.doc b/changelog.d/7167.doc index 553dc6c92ca6..7f08cff94453 100644 --- a/changelog.d/7167.doc +++ b/changelog.d/7167.doc @@ -1 +1 @@ -Improve README.md. Be explicit about public IP recomendation. \ No newline at end of file +Improve README.md by being explicit about public IP recommendation. From b6bf05fdd431215687e8dfe83d0323f1a389643a Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 31 Mar 2020 15:16:01 +0100 Subject: [PATCH 6/6] Mention TURN in the changelog --- changelog.d/7167.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/7167.doc b/changelog.d/7167.doc index 7f08cff94453..a7e7ba9b51f5 100644 --- a/changelog.d/7167.doc +++ b/changelog.d/7167.doc @@ -1 +1 @@ -Improve README.md by being explicit about public IP recommendation. +Improve README.md by being explicit about public IP recommendation for TURN relaying.