Merge branch 'main' of https://github.com/igniterealtime/openfire-pio…

…nturn-plugin

# Conflicts:
#	README.md

.github/workflows/build.yml

@@ -1,73 +1,10 @@
-# Version 2021-10-27
+# Version 2023-03-05
 name: Java CI
 on: [push, pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        java: [ "1.8", "11" ]
-
-    steps:
-      # Checkout Repo
-      - uses: actions/checkout@v2
-
-      # Create a variable with this plugin's name
-      - id: get-id
-        name: Compute needed variables
-        run: |
-          set -x
-          id=$(echo ${{ github.repository }} | cut -d- -f2)
-          echo "::set-output name=id::$id"
-          echo "id is '$id'"
-          tag=$(echo ${{ github.ref }} | cut -d '/' -f3)
-          echo "::set-output name=tag::$tag"
-          echo "tag is '$tag'"
-          version=$(echo ${{ github.ref }} | cut -d '/' -f3 | cut -c 2-)
-          echo "::set-output name=version::$version"
-          echo "version is '$version'"
-          rel_id=$(curl -sL https://api.github.com/repos/${{github.repository}}/releases | jq -r --arg TAG "$tag" '.[] | select(.tag_name==$TAG) | .id')
-          echo ::set-output name=rel_id::$rel_id
-          echo "rel_id is '$rel_id'"
-
-      - name: Setup JDK ${{ matrix.java }}
-        uses: actions/setup-java@v1
-        with:
-          java-version: ${{ matrix.java }}
-
-      - name: Cache Maven repository
-        uses: actions/cache@v1
-        with:
-          path: ~/.m2/repository
-          key: ${{ runner.os }}-java${{ matrix.java }}-maven-${{ hashFiles('**/pom.xml') }}
-          restore-keys: |
-            ${{ runner.os }}-java${{ matrix.java }}-maven-
-            ${{ runner.os }}-
-
-      - name: Igniterealtime CI Tooling
-        run: |
-          git clone --depth 1 https://github.com/igniterealtime/ci-tooling.git target/ci-tooling
-          cp target/ci-tooling/maven-settings-for-openfire-plugins.xml $HOME/.m2/settings.xml
-
-      - name: Build with Maven
-        run:  mvn -B package
-
-      - name: Conditionally Deploy to Igniterealtime Archiva
-        id: deploy
-        if: ${{ contains(github.repository, 'igniterealtime/') && ( ( github.event_name == 'push' && github.ref == 'refs/heads/main' ) || contains(github.ref, 'refs/tags/') ) && matrix.java == '1.8' }}
-        run: mvn -B deploy --settings target/ci-tooling/maven-settings-for-openfire-plugins.xml
-        env:
-          CI_DEPLOY_USERNAME: ${{ secrets.IGNITE_REALTIME_MAVEN_USERNAME }}
-          CI_DEPLOY_PASSWORD: ${{ secrets.IGNITE_REALTIME_MAVEN_PASSWORD }}
-
-      - name: Conditionally Push Artifact to Github Release
-        uses: actions/upload-release-asset@v1
-        if: ${{ contains(github.repository, 'igniterealtime/') && github.event_name == 'push' && contains(github.ref, 'refs/tags/') && matrix.java == '1.8' }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: https://uploads.github.com/repos/${{ github.repository }}/releases/${{ steps.get-id.outputs.rel_id }}/assets?name=${{ steps.get-id.outputs.id }}.jar
-          asset_path: target/${{ steps.get-id.outputs.id }}-openfire-plugin-assembly.jar
-          asset_name: ${{ steps.get-id.outputs.id }}.jar
-          asset_content_type: application/java-archive
+    uses: igniterealtime/openfire-plugin-builder-action/.github/workflows/openfire-plugin-build.yml@main
+    secrets:
+      IGNITE_REALTIME_MAVEN_USERNAME: ${{ secrets.IGNITE_REALTIME_MAVEN_USERNAME }}
+      IGNITE_REALTIME_MAVEN_PASSWORD: ${{ secrets.IGNITE_REALTIME_MAVEN_PASSWORD }}

README.md

@@ -6,14 +6,19 @@ This plugin provides a TURN/STUN Server for Openfire.
 
 [![Build Status](https://github.com/igniterealtime/openfire-pionturn-plugin/workflows/Java%20CI/badge.svg)](https://github.com/igniterealtime/openfire-pionturn-plugin/actions)
 
-<h2>Overview</h2>
+## Overview
 
-<p>
 This plugin uses the Pion Turn Project (https://github.com/pion/turn) to create a TURN/STUN server for Openfire.
-</p>
 
-<h2>Known Issues</h2>
-This version has embedded binaries for only Linux 64 and Windows 64 only.
+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.
 <p>
 
 </p>