From 814f15f3f93bd07bac9a6bd3fdc00e33aa355bee Mon Sep 17 00:00:00 2001
From: Zoidberg2 <162704458+Zoidberg2@users.noreply.github.com>
Date: Tue, 12 Mar 2024 13:42:37 +0800
Subject: [PATCH] Update README.md
This README.md reflects more accurately the state of the plugin. I also changed the link to the "How to" to a guide that I made recently specifically for the Pionturn plugin, but that also teaches how to setup the External Service Discovery plugin.
---
README.md | 10 ++--------
1 file changed, 2 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 6b1980f..bdc1d10 100644
--- a/README.md
+++ b/README.md
@@ -8,14 +8,8 @@ This plugin provides a TURN/STUN Server for Openfire.
## Overview
-This plugin uses the Pion Turn Project (https://github.com/pion/turn) to create a TURN/STUN server for Openfire.
+This plugin uses the Pion Turn Project (https://github.com/pion/turn) to create a TURN/STUN server for Openfire. This plugin is used to help users who are on uncooperative networks to connect their calls/video calls.
-This plugin is only useful when Openfire is in a network location that is **not** behind restrictive constructs like NAT (one of it's main purposes is to *help* clients circumvent NATs in the first place). The STUN service itself needs to see the 'public' IP address of the client (and possibly vice versa). That works best if the server is itself in a public network segment. The TURN service is more elaborate: instead of just being used to report on the observed client IP/port, it will act as a proxy. That means that all data flows over the TURN server (which isn't true for a STUN server). In any case: make your Openfire server have a public IPs, not something behind a NAT.
-
-When your Openfire is behind a NAT, it probably **makes less sense** to run a STUN/TURN server embedded in Openfire.
-When this is the case, a valid alternative might be to position a stand-alone STUN/TURN server somewhere 'public' (not NATted), and tie that to Openfire using the external service discovery plugin for Openfire.
-
-When you have clients from outside your network wanting to do STUN/TURN, then it's likely that placing your openfire server in a DMZ will make it easier for them to connect to it. Please note that there probably are drawbacks with regards to security policies etc.
## Known Issues
This version has embedded binaries for only Linux 64 and Windows 64.
@@ -37,7 +31,7 @@ After you've set up the STUN and TURN service, you'll need to configure Openfire
How to use
-See this blog - https://discourse.igniterealtime.org/t/preparing-openfire-for-audio-video-calls-with-conversations/87828
+See this guide - https://discourse.igniterealtime.org/t/guide-pionturn-external-service-discovery-usage-for-people-trying-to-set-up-calls/93699
## Reporting Issues