-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
readme.html
76 lines (70 loc) · 6.24 KB
/
readme.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome file</title>
<link rel="stylesheet" href="https://stackedit.io/style.css" />
</head>
<body class="stackedit">
<div class="stackedit__left">
<div class="stackedit__toc">
<ul>
<li>
<ul>
<li><a href="#galene">Galene</a></li>
<li><a href="#overview">Overview</a></li>
<li><a href="#known-issues">Known Issues</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#configuration">Configuration</a></li>
<li><a href="#how-to-use">How to use</a></li>
<li><a href="#further-information">Further information</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="stackedit__right">
<div class="stackedit__html">
<h2 id="galene">Galene</h2>
<p>Selective Forwarding Unit (SFU) for Openfire using Galene.</p>
<h2 id="overview">Overview</h2>
<img src="https://igniterealtime.github.io/openfire-galene-plugin/galene-summary.png">
<h2 id="known-issues">Known Issues</h2>
<p>This version has embedded binaries for only Linux 64 and Windows 64.</p>
<h2 id="installation">Installation</h2>
<p>copy galene.jar to the plugins folder</p>
<h2 id="configuration">Configuration</h2>
<img src="https://user-images.githubusercontent.com/110731/259781570-5a9a2918-ca51-4bed-80f0-b50db7aa63cb.png">
<h3 id="enable-sfu">Enable SFU</h3>
<p>Enables or disables the plugin. Reload plugin or restart Openfire if this or any of the settings other settings are changed.</p>
<h3 id="enable-muc-groupchat-support">Enable MUC (Groupchat) Support</h3>
<p>If this option is not enabled, Galene will only use a single parent group called <em>public</em>. Subgroups will be enabled and all participants will have <em>operator</em> privileges. They can publish media streams and manage the meeting. See Galene documentation for full details. Both anonymous and authenticated XMPP sessions can join a public group and all subgroups.</p>
<p>To join a public subgroup called my-meeting, with the galene web client, use <a href="http://your-openfire-server:7070/galene/?room=public/my-meeting&username=your-user-name">http://your-openfire-server:7070/galene/?room=public/my-meeting&username=your-user-name</a>.</p>
<p>If this option is enabled, then Galene SFU becomes integrated with Openfire. Openfire MUC group-chat rooms can be used as Galene groups in addition to the default public group. Authentication is enabled and only authenticated XMPP sessions can join a Galene group subject to the room configuration. For example, member only MUC rooms will disable allow-anonymous in Galene and only room member xmpp sessions will be allowed to join the Galene group.</p>
<p>In this mode, users will require an authenticated XMPP session to join an Openfire MUC groupchat room. See Pade client or the Galene plugin for ConverseJS for more details.</p>
<p>Once a user has joined with at least presenter permissions, they can invite an external user with an invitation token.</p>
<p>To join an MUC groupchat room called lobby with the Galene web client as user <em>fred</em> using invitation token xxxxxxxxxxx, use <a href="http://localhost:7070/galene?token=xxxxxxxxxxx&room=public&username=fred">http://localhost:7070/galene?token=xxxxxxxxxxx&room=public&username=fred</a></p>
<h3 id="usernamepassword">Username/Password</h3>
<p>This is Openfire username/password for the user that will have Galene admin permissions to view stream stats and join any meeting. By default the user will be “sfu-user” and the password witll be a random string. If you are using ldap or your Openfire user manager is in read-only mode and a new user cannot be created, then you must create the user and specify the username and password here…</p>
<h3 id="ip-addresstcp-port">IP Address/TCP Port</h3>
<p>This is the internal IP address of the network card to which you want Galene to bind to. Galene is not exposed outside of the internal network and can only be accessed via Openfire using an XMPP client connection. By default port 6060 will be used. However any other internal port can be used. Use <a href="http://ip-address">http://ip-address</a>:port on the internal network to confirm galene is up and running.</p>
<h3 id="udp-port-minmax">UDP Port Min/Max</h3>
<p>This limits the pool of ephemeral ports that ICE UDP connections can allocate from. This affects both host candidates, and the local address of server reflexive candidates.</p>
<h3 id="turn-ip-addressport">TURN IP Address/Port</h3>
<p>This is the public IP address of the FQDN of your openfire server that will be exposed to client web browsers when they ask for ICE canndidates during media negotiation. Make sure the port specified is opened for TCP and UDP. galene will bind its interrnal TURN server to this port. If Galene is behind NAT and your NAT device doesn’t support hairpinning, then you must use an external TURN server.</p>
<h3 id="external-url">External URL</h3>
<p>This is the base public URL (minus path) that is used to access galene externally by clients. The host name should resolve to the IP address specified for TURN above otherwise, ensure you have a proxy or http forwarding rule that ensures this happens.</p>
<h2 id="how-to-use">How to use</h2>
<p>This plugin implements <a href="https://igniterealtime.github.io/openfire-galene-plugin/xep/xep-xxx-sfu_01-01.xml">XEP-XXXX: In-Band SFU Sessions</a> for the Galene SFU.</p>
<p>For an example client, see the <a href="https://github.com/conversejs/community-plugins/tree/master/packages/galene">galene plugin for conversejs</a></p>
<img src="https://github.com/conversejs/community-plugins/blob/master/packages/galene/galene.png?raw=true">
<p>Also see the <a href="https://github.com/igniterealtime/openfire-zgitea-plugin">Gitea plugin for Openfire</a></p>
<p><img src="https://user-images.githubusercontent.com/110731/180422009-3ef9255b-0f27-4b93-b06a-f250aeaf69c1.png" alt="image"></p>
<h2 id="further-information">Further information</h2>
<p>Galène’s web page is at <a href="https://galene.org">https://galene.org</a> and was created by Juliusz Chroboczek <a href="https://www.irif.fr/~jch/">https://www.irif.fr/~jch/</a><br>
Answers to common questions and issues are at <a href="https://galene.org#faq">https://galene.org#faq</a>.</p>
</div>
</div>
</body>
</html>