Skip to content

Commit

Permalink
Merge pull request #10 from Zoidberg2/patch-1
Browse files Browse the repository at this point in the history
Thank you for doing this 👍
  • Loading branch information
deleolajide authored Mar 12, 2024
2 parents f7b829e + 814f15f commit 80c3c36
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -37,7 +31,7 @@ After you've set up the STUN and TURN service, you'll need to configure Openfire
<h2>How to use</h2>

<p>
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
<p/>

## Reporting Issues
Expand Down

0 comments on commit 80c3c36

Please sign in to comment.