Go to file
Dele Olajide f7b829e143 march on to 0.0.6-snapshot 2023-11-23 13:06:57 +00:00
.github/workflows Update workflow file 2023-05-03 20:47:00 +01:00
classes prepare for release 0.0.5 2023-11-23 12:45:58 +00:00
src prepare for release 0.0.5 2023-11-23 12:45:58 +00:00
.gitignore revert ignore 2020-10-22 16:11:41 +01:00
LICENSE first release 2020-05-09 18:16:47 +01:00
README.md Merge branch 'main' of https://github.com/igniterealtime/openfire-pionturn-plugin 2023-11-23 12:52:37 +00:00
changelog.html march on to 0.0.6-snapshot 2023-11-23 13:06:57 +00:00
logo_large.gif first release 2020-05-09 18:16:47 +01:00
logo_small.gif first release 2020-05-09 18:16:47 +01:00
plugin.xml release 0.0.5 2023-11-23 13:05:05 +00:00
pom.xml march on to 0.0.6-snapshot 2023-11-23 13:06:57 +00:00
readme.html first release 2020-05-09 18:16:47 +01:00

README.md

Openfire Pion TURN Plugin

This plugin provides a TURN/STUN Server for Openfire.

CI Build Status

Build Status

Overview

This plugin uses the Pion Turn Project (https://github.com/pion/turn) to create a TURN/STUN server for Openfire.

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.

Installation

  1. Copy the pionturn.jar file to the OPENFIRE_HOME/plugins directory.
  2. Configure the admin properties page.

Configuration

Under Server|Media Services settings -> PionTurn tab you can configure the parameters. After you've set up the STUN and TURN service, you'll need to configure Openfire to expose the availability of this new service to your users. You can do this easily with the External Service Discovery plugin for Openfire.

How to use

See this blog - https://discourse.igniterealtime.org/t/preparing-openfire-for-audio-video-calls-with-conversations/87828

Reporting Issues

Issues may be reported to the forums or via this repo's Github Issues.