Freeswitch Module/de

 

Home

 

Download

 

News

 

Support

 

Admin

 

Dev

 

Screen Shots

 

Grid List

 

Bugs

Languages:

English    Deutsch    Français

Das FreeSWITCH-Modul ermöglicht Sprachfunktionen in OpenSimulator, ohne dass Änderungen am Linden Labs Second Life Viewer erforderlich sind. Für OpenSimulator 0.7.0.2 und früher muss der Viewer zwischen den Versionen 1.22 und 1.23.5 liegen. Für OpenSimulator 0.7.1 und später werden auch 2.x-Viewer funktionieren.

Eine kleine Geschichte zur Entwicklung des FreeSWITCH-Moduls finden Sie hier:

• http://zaki.asia/2009/04/28/freeswitch-module-in-opensim.html

So installieren Sie FreeSwitch PBX auf Ubuntu 20.04 und 18.04:

• https://computingforgeeks.com/how-to-install-freeswitch-pbx-on-ubuntu/

FreeSwitch Installation

Folge den Kompilierungsanweisungen im FreeSWITCH-Wiki. Stelle sicher, dass du vorerst aus dem FreeSWITCH-Trunk kompilierst, bis wir eine Mindestversionsnummer veröffentlichen können (es gibt bekannte Probleme mit älteren Versionen). Für die Zwecke von OpenSim müssen zwei spezifische Module aktiviert werden.

Stelle sicher, dass du die Haltemusik installierst, wenn du sie nicht im Abschnitt "Konferenzkonfigurationsdatei konfigurieren" unten deaktivieren möchtest.

Wenn du den Abschnitt "Module.conf bearbeiten" der FreeSWITCH-Bauanleitung erreichst, bearbeite die modules.conf-Datei und kommentiere die Einträge für xml_curl und den siren14-Codec aus, um sie aktiv zu machen.

codecs/mod_siren und xml_int/mod_xml_curl

Hinweis: Der FreeSWITCH-Git-Masterstand vom 18. April 2011 hat bereits codecs/mod_siren konfiguriert

Aktualisierung vom Januar 2019: Das FreeSWITCH-Wiki befindet sich nun unter https://freeswitch.org/confluence/. Wie angegeben, «Der Sprint, der die verbleibenden Seiten vom alten MediaWiki nach Confluence kopiert hat, hat uns alle druckfähigen Dokumentationen geliefert, aber sie sind nicht gut organisiert. Die Suche ist dein Freund.»

Die Installationsseite findest du unter https://freeswitch.org/confluence/display/FREESWITCH/Installation.

Konfigurationsseite: https://freeswitch.org/confluence/display/FREESWITCH/Configuring+FreeSWITCH

Beachte, dass Debian, Ubuntu und CentOS/RHEL Pakete haben, wie jeweils erklärt hier für Debian 9 Stretch, hier für Ubuntu 16.04 Xenial, und hier für CentOS 7 und RHEL 7.

FreeSwitch Config

Aktivieren von mod_xml_curl

Nachdem du FreeSWITCH kompiliert und installiert hast, musst du mod_siren und mod_xml_curl in /usr/local/freeswitch/conf/autoload_configs/modules.conf.xml aktivieren, da sie standardmäßig bei einer Neuinstallation deaktiviert sind.

Entkommentiere die Zeilen...

<load module="mod_xml_curl"/>

und

<load module="mod_siren"/>

Hinweis: Der FreeSWITCH-Git-Masterstand vom 18. April 2011 hat bereits mod_siren konfiguriert

Konfigurieren von mod_xml_curl

mod_xml_curl ist ein FreeSWITCH-Modul, das die dynamische Konfiguration von FreeSWITCH von einem Webserver aus ermöglicht. In diesem Fall handelt es sich um den OpenSim-Regions-Server.

Die Konfiguration des xml_curl-Moduls sollte auf eine OpenSim-Region zeigen, die das Freeswitch-Sprachmodul aktiviert hat (die Sprachfunktion muss auch in den Immobilieneinstellungen für alle Regionen aktiviert sein, die unterstützt werden sollen).

Du kannst dies einrichten, indem du die Datei /usr/local/freeswitch/conf/autoload_configs/xml_curl.conf.xml bearbeitest.

OpenSimulator 0.7.1 und später

Du kannst die vorhandene Konfiguration durch die folgenden Einstellungen ersetzen oder einfach das Verzeichnis und die Wählplan-Bindungen hinzufügen. Die IP-Adresse wird vom Freeswitch-Server verwendet, um den Freeswitch-Dienst von OpenSimulator zu erreichen und dessen Konfigurationsdetails abzurufen. Wenn du alles auf einem einzigen Server ausführst und dein System nur eine IP-Adresse hat, kann dies einfach localhost sein. Wenn du Freeswitch auf einem anderen Server ausführst oder mehrere IP-Adressen hast, muss dies explizit die Adresse deines Standalone-Servers sein.

Du musst auch die Portnummer ändern, wenn du einen anderen Standalone-HTTP-Port als den Standard (9000) verwendest.

Im Grid-Modus musst du "localhost" durch die IP des ROBUST-Instanz ersetzen, auf der der FreeSwitch-Grid-Dienst ausgeführt wird, und den Port durch den Dienstport (normalerweise 8004) ersetzen.

Diese Konfiguration gibt Freeswitch an, wo er die Konfiguration für "Wählplan" und "Verzeichnis" von OpenSim erhalten kann (wie in den Bindungsattributen erwähnt). Weitere Details zum Modul mod_xml_curl findest du hier.

<configuration name="xml_curl.conf" description="cURL XML Gateway">
<bindings>
   <binding name="directory">
           <param name="gateway-url" value="http://localhost:9000/fsapi/freeswitch-config" bindings="directory"/>
           <param name="gateway-credentials" value="freeswitch:password"/>
           <param name="disable-100-continue" value="true"/>
   </binding>
   <binding name="dialplan">
           <param name="gateway-url" value="http://localhost:9000/fsapi/freeswitch-config" bindings="dialplan"/>
           <param name="gateway-credentials" value="freeswitch:password"/>
           <param name="disable-100-continue" value="true"/>
   </binding>
</bindings>
</configuration>

OpenSimulator 0.7.0.2 und früher

Für OpenSimulator 0.7.0.2 und früher ist die Einrichtung identisch, nur dass die Pfade der gateway-url mit /api anstatt /fsapi beginnen.

<configuration name="xml_curl.conf" description="cURL XML Gateway">
<bindings>
   <binding name="directory">
           <param name="gateway-url" value="http://localhost:9000/api/freeswitch-config" bindings="directory"/>
           <param name="gateway-credentials" value="freeswitch:password"/>
           <param name="disable-100-continue" value="true"/>
   </binding>
   <binding name="dialplan">
           <param name="gateway-url" value="http://localhost:9000/api/freeswitch-config" bindings="dialplan"/>
           <param name="gateway-credentials" value="freeswitch:password"/>
           <param name="disable-100-continue" value="true"/>
   </binding>
</bindings>
</configuration>

Konfigurieren von vars.xml

Hinweis: Der FreeSWITCH-Git-Masterstand vom 18. April 2011 hat dies bereits konfiguriert

Die Datei /usr/local/freeswitch/conf/vars.xml muss geändert werden, um den siren14-Codec zu aktivieren.

Suche in vars.xml nach global_codec_prefs und ändere die Zeile wie folgt:

<X-PRE-PROCESS cmd="set" data="global_codec_prefs=G7221@32000h,G722,PCMU,PCMA,GSM"/>

oder

<X-PRE-PROCESS cmd="set" data="global_codec_prefs=G7221@32000h,G7221@16000h,G722,PCMU,PCMA,GSM"/>

G7221@32000h ist der siren14-Codec.

Konfigurieren von conference.conf.xml

Standardmäßig spielt FreeSwitch Haltemusik ab, wenn sich nur ein Avatar in der Konferenz befindet, und es piept für alle, wenn Avatare eintreffen und die Konferenz verlassen. Um dies zu deaktivieren, bearbeite die Datei /usr/local/freeswitch/conf/autoload_configs/conference.conf.xml. Finde das "default" Profil und kommentiere die Zeilen für die Sounddateien aus, wie im folgenden Beispiel gezeigt.

  <!-- Profiles are collections of settings you can reference by name. -->
  <profiles>
    <!--If no profile is specified it will default to "default"-->
    <profile name="default">
    ...
      <!-- If TTS is enabled all audio-file params beginning with -->
      <!-- 'say:' will be considered text to say with TTS -->
      <!-- Override the default path here, after which you use relative paths in the other sound params -->
      <!-- Note: The default path is the conference's first caller's sound_prefix -->
      <!--<param name="sound-prefix" value="$${sounds_dir}/en/us/callie"/>-->
      <!-- File to play to acknowledge succees -->
      <!--<param name="ack-sound" value="beep.wav"/>-->
      <!-- File to play to acknowledge failure -->
      <!--<param name="nack-sound" value="beeperr.wav"/>-->
      <!-- File to play to acknowledge muted -->
      <!-- <param name="muted-sound" value="conference/conf-muted.wav"/> -->
      <!-- File to play to acknowledge unmuted -->
      <!-- <param name="unmuted-sound" value="conference/conf-unmuted.wav"/> -->
      <!-- File to play if you are alone in the conference -->
      <!-- <param name="alone-sound" value="conference/conf-alone.wav"/> -->
      <!-- File to play endlessly (nobody will ever be able to talk) -->
      <!--<param name="perpetual-sound" value="perpetual.wav"/>-->
      <!-- File to play when you're alone (music on hold)-->
      <!-- <param name="moh-sound" value="$${hold_music}"/> -->
      <!-- File to play when you join the conference -->
      <!-- <param name="enter-sound" value="tone_stream://%(200,0,500,600,700)"/> -->
      <!-- File to play when you leave the conference -->
      <!-- <param name="exit-sound" value="tone_stream://%(500,0,300,200,100,50,25)"/> -->
      <!-- File to play when you ae ejected from the conference -->
      <!-- <param name="kicked-sound" value="conference/conf-kicked.wav"/> -->
      <!-- File to play when the conference is locked -->
      <!-- <param name="locked-sound" value="conference/conf-locked.wav"/> -->
      <!-- File to play when the conference is locked during the call-->
      <!-- <param name="is-locked-sound" value="conference/conf-is-locked.wav"/> -->
      <!-- File to play when the conference is unlocked during the call-->
      <!-- <param name="is-unlocked-sound" value="conference/conf-is-unlocked.wav"/> -->
      <!-- File to play to prompt for a pin -->
      <!-- <param name="pin-sound" value="conference/conf-pin.wav"/> -->
      <!-- File to play to when the pin is invalid -->
      <!-- <param name="bad-pin-sound" value="conference/conf-bad-pin.wav"/> -->
      ...
    </profile>
  ...
  </profiles>

OpenSimulator-Konfiguration

Konfiguration für OpenSimulator 0.7.1 und höher

Standalone

Die Konfiguration wird in OpenSim.ini.example erklärt. Hier ist ein Beispiel:

[FreeSwitchVoice]

   Enabled = true
   LocalServiceModule = OpenSim.Services.FreeswitchService.dll:FreeswitchService
   

[FreeswitchService]

   ServerAddress = 192.168.1.2

In diesem Fall läuft der FreeSWITCH-Server auf 192.168.1.2 und nur Viewer im lokalen LAN müssen darauf zugreifen. Wenn Personen auf den Standalone-Server zugreifen müssten (und damit auf den Voice-Dienst), müsste diese IP-Adresse eine sein, die von außen erreichbar ist (z. B. 80.175.122.1). Es müssen keine anderen Dateien konfiguriert werden.

Grid-Modus

Im Grid-Modus müssen [FreeSwitchVoice] in OpenSim.ini und [FreeswitchService] in Robust.ini oder Robust.HG.ini konfiguriert werden. Die Konfigurationsdetails werden sowohl in OpenSim.ini.example, Robust.ini.example als auch Robust.HG.ini.example angezeigt. Hier ist ein Beispiel für die Konfiguration in OpenSim.ini:

[FreeSwitchVoice]

   Enabled = true
   LocalServiceModule = OpenSim.Services.Connectors.dll:RemoteFreeswitchConnector
   FreeswitchServiceURL = http://192.168.1.3:8004/fsapi

Hinzufügen für Robust.ini/Robust.HG.ini:

[FreeswitchService]

   LocalServiceModule = OpenSim.Services.FreeswitchService.dll:FreeswitchService
   ServerAddress = http://192.168.1.4

In diesem Fall läuft der Grid-Dienst auf 192.168.1.3 und der FreeSWITCH-Server auf 192.168.1.4.

Für weitere Details zur FreeSWITCH-Konfiguration für diese Version kannst du folgende Links besuchen:

   http://opensimulator.org/mantis/view.php?id=5267
   http://opensimulator.org/mantis/view.php?id=5274

OpenSimulator 0.7.0.2 und früher

Standalone

Füge Folgendes zu deiner OpenSim.ini hinzu:

[FreeSwitchVoice] Enabled = true LocalServiceModule = "OpenSim.Services.FreeswitchService.dll:FreeswitchService"

[FreeswitchService] ServerAddress = youropensimregionip Realm = "youropensimregionip"

Grid-Modus

Füge Folgendes zu deiner OpenSim.ini hinzu:

[FreeSwitchVoice] Enabled = true LocalServiceModule = OpenSim.Services.Connectors.dll:RemoteFreeswitchConnector FreeswitchServiceURL = http://ip.of.your.robust.server.for.freeswitch.connector:8004/fsapi

Füge Folgendes zu deiner Robust.ini oder Robust.HG.ini hinzu:

[FreeswitchService] LocalServiceModule = OpenSim.Services.FreeswitchService.dll:FreeswitchService ServerAddress = ip.of.your.robust.server.for.freeswitch.connector Realm = "ip.of.your.robust.server.for.freeswitch.connector"

Wenn dein Freeswitch über eine unbekannte Domain beschwert, hast du wahrscheinlich IPs und Hostnamen gemischt. Du solltest immer mit Punktquad-IP-Adressen arbeiten, da in Freeswitch-Code Zeichenfolgenvergleiche durchgeführt werden und ein Name und die entsprechende Adresse nicht als gleich betrachtet werden!

Firewall-Konfiguration

Im Grunde müssen die Ports 1720 und 5060 geöffnet sein, und möglicherweise muss auch Port 50505 für den Empfang geöffnet sein.

Stelle sicher, dass die von FreeSWITCH verwendeten Ports über deine Firewall(s) erreichbar sind. Im obigen Beispiel wird der Hauptport 5060 verwendet, obwohl andere Ports für den Verbindungsaufbau verwendet werden können (Port 1720 für die H.323-Anrufsignalisierung) und dynamisch zugewiesene Ports für spezifischen Anrufsverkehr. Die übliche Handhabung dynamischer Ports für H.323- und SIP-Verkehr auf modernen Firewalls ermöglicht dies normalerweise.

Wird Port 50505 tatsächlich verwendet, oder handelt es sich nur um eine Information, die von OpenSimulator gemeldet werden muss, wenn der Freeswitch-Dienst Kontakt aufnimmt?

Weitere Details zu den von FreeSWITCH verwendeten Ports und zur Firewall-Konfiguration findest du unter http://wiki.freeswitch.org/wiki/Firewall.

Wenn du Probleme mit NAT/Routern hast, solltest du STUN (Simple Traversal of UDP through NATs) in Betracht ziehen. Weitere Informationen findest du unter http://wiki.freeswitch.org/wiki/NAT_Traversal.

Alles hochfahren

   Freeswitch holt OpenSimulator-bezogene Konfigurationen aus dem zuvor eingerichteten OpenSimulator FreeSWITCH-Stimmenmodul und -Dienst ab. Daher musst du zuerst OpenSimulator starten. Beim Start solltest du die Zeilen sehen:

21:45:33 - [FreeSwitchVoice]: Verwendung des FreeSwitch-Servers <Ihre IP-Adresse>
21:45:33 - [FreeSwitchVoice]: Plugin aktiviert

   Starte Freeswitch. Es wird sich über folgende Fehler beschweren:

[ERR] mod_xml_curl.c:302 Fehler beim Parsen des Ergebnisses! [1] Daten: [hostname=fruitfly&section=directory&tag_name=&key_name=&key_value=&Event-Name=REQUEST_PARAMS&Core-UUID=8cdac78a-e880-11e0-a320-3324fcf85684&FreeSWITCH-Hostname=fruitfly&FreeSWITCH-Switchname=fruitfly&FreeSWITCH-IPv4=192.168.1.2&FreeSWITCH-IPv6=%3A%3A1&Event-Date-Local=2011-09-26%2021%3A46%3A03&Event-Date-GMT=Mon,%2026%20Sep%202011%2020%3A46%3A03%20GMT&Event-Date-Timestamp=1317069963782065&Event-Calling-File=sofia.c&Event-Calling-Function=config_sofia&Event-Calling-Line-Number=3965&purpose=gateways&profile=external]

und

[ERR] mod_xml_curl.c:305 HTTP-Fehler 404 beim Abrufen von http://localhost:9000/fsapi/freeswitch-config Daten: [hostname=fruitfly&section=directory&tag_name=domain&key_name=name&key_value=192.168.1.2&Event-Name=GENERAL&Core-UUID=8cdac78a-e880-11e0-a320-3324fcf85684&FreeSWITCH-Hostname=fruitfly&FreeSWITCH-Switchname=fruitfly&FreeSWITCH-IPv4=192.168.1.2&FreeSWITCH-IPv6=%3A%3A1&Event-Date-Local=2011-09-26%2021%3A46%3A05&Event-Date-GMT=Mon,%2026%20Sep%202011%2020%3A46%3A05%20GMT&Event-Date-Timestamp=1317069965442975&Event-Calling-File=switch_core.c&Event-Calling-Function=switch_load_network_lists&Event-Calling-Line-Number=1173&domain=192.168.1.2&purpose=network-list]

Diese Fehler können vorerst ignoriert werden - sie sollten in Zukunft behoben werden, beeinträchtigen jedoch nicht die Funktionsweise von Freeswitch.

Auf der OpenSimulator-Region (im Standalone-Modus) oder der Grid-Konsole (im Grid-Modus) sollten die folgenden Zeilen angezeigt werden:

[FreeSwitchVoice]: Anforderung für Konfigurationsabschnitt Verzeichnis empfangen, Aufruffunktion 'config_sofia' [FreeSwitchVoice]: Anforderung für Konfigurationsabschnitt Verzeichnis empfangen, Aufruffunktion 'config_sofia' [FreeSwitchVoice]: Anforderung für Konfigurationsabschnitt Verzeichnis empfangen, Aufruffunktion 'switch_load_network_lists'

   Stelle nun sicher, dass dein Bereich in der Region die Sprachfunktion im Bereichsdialog aktiviert hat. Wenn dies nicht zuvor eingestellt wurde, musst du dies möglicherweise ändern und OpenSimulator neu starten.

   Melde dich bei deinem Client an. Stelle sicher, dass die Sprachfunktion aktiviert und funktionstüchtig ist (wahrscheinlich durch Testen auf einem anderen Grid zuerst).

   Wenn alles nach Plan verlaufen ist, solltest du eine Zeile sehen wie:

[FreeSwitchVoice]: OnRegisterCaps() aufgerufen mit Agenten-ID 0fe223e7-370a-46da-b935-b0831ddf6d08 Caps OpenSim.Framework.Capabilities.Caps in Szene test2

unter anderem auf der OpenSimulator-Region-Konsole. Und auf der Freeswitch-Konsole solltest du etwas sehen wie:

2011-09-26 22:10:09.866918 [WARNING] sofia_reg.c:1241 SIP-Authentifizierungsaufforderung (REGISTER) im Sofiaprofil 'internal' für [xD-Ij5zcKRtq5NbCDHd9tCA==@192.168.1.2] von IP 192.168.1.2

Mit etwas Glück sind die Sprachtasten auf deinem Client jetzt aktiv und funktionieren.

Issues and Solutions

Make sure that you have enabled voice in the "About Land"->"Voice" dialogue in the region, you will need to be a region admin to do this.

Check the plot also has voice enabled. You must be a plot owner or have suitable permisison to do this. Recent Linden Labs Second Life viewers do not offer this option, so use Hippo or another client which does.

Use some of the debugging features in FreeSWITCH:

• conference list <--- to see if you have any conferences setup (note you have to be inworld when you try this)
• xml_curl debug_on <--- this command will dump the transactions between OpenSimulator and FreeSWITCH into a file (on linux it is in /tmp)
• xml_curl debug_off <-- turn it off after you login/logout a few times

Notes from Openvue Grid setup for FreeSwitch

Using Windows Vista 32 bit OS. Works with FreeSwitch 1.0.4 and later (for a specific tested example, FreeSWITCH Version 1.0.head (git-e0c37c1 2010-11-05 18-20-09 -0500)).

Additional notes that might help:

1. We established a simple OpenSim.exe on the SAME host as the FreeSwitch.exe service and put a single simple island on that (we called it "Talk") as some folks observed that FreeSwitch had problems with connecting if it was CONFIGURED to link to another server, but we don't believe this is necessary.

2. FreeSwitch provides service to all OpenSim.exe instances on any servers you wish even though its only configured for one.

3. There is one FreeSwitch channel per region, change regions and you change channel. So all users to talk must be on the same region. All plots on one region share the same single region channel.

4. You appear as one user in the SL Viewers, ALL other users appear as a single "user" with a coded name for the other users on the channel - something like conf-x9999999999999999999.

5. You must have voice enabled at the region, AND the plot level. This is a pain, as the default setting in OpenSimulator is that PLOTS have voice turned off. The standard viewers 1.23 and 2.x do not allow you to turn this back on, so you must use a third party viewer to turn on PLOT voice. I have asked before that we change the default setting when a plot is created to have this on by default (or on if the region voice is on - which it is by default).

6. We are not sure if you MUST start FreeSwitch.exe before the regions that you want voice to work on. But we do so for safety. It works fine over OpenSim.exe restarts without FreeSwitch being started again.

7. If you wish to use FreeSwitch beyond your local network, remember to configure for EXTERNALLY accessible IP addresses. Use IP numbers for FreeSwitch... and if there are 192.168.x.x style local net addresses in there you will not get FreeSwitch to work with external users. It can work through a range of firewalls with suitable mechanisms such as port forwarding or DMZs, so long as you definitely map to the externally visible IP address. Ensure you have the appropriate ports open in your Firewall(s). See separate section in Wiki on ports required.

8. There are some red errors on startup of FreeSwitch - at least in our setup - which appears to be related to a missing config file that FreeSwitch tries to retrieve from OpenSimulator (opensim-region-server-url:port/api/freeswitch-config) that is not in the OpenSimulator setup... We have (safely?) ignored those without problems...

2010-11-13 14:42:55.252361 [ERR] mod_xml_curl.c:252 Received HTTP error 0 trying
to fetch http://129.215.219.143:9000/api/freeswitch-config
data: [hostname=shuna&section=directory&tag_name=domain&key_name=name&key_value=
129.215.219.143&Event-Name=GENERAL&Core-UUID=cb64ea40-aa92-494b-be13-65d9c468efe
c&FreeSWITCH-Hostname=shuna&FreeSWITCH-IPv4=129.215.219.143&FreeSWITCH-IPv6=2002
%3A81d7%3Adb8f%3A%3A81d7%3Adb8f&Event-Date-Local=2010-11-13%2014%3A42%3A54&Event
-Date-GMT=Sat,%2013%20Nov%202010%2014%3A42%3A54%20GMT&Event-Date-Timestamp=12896
59374247361&Event-Calling-File=switch_core.c&Event-Calling-Function=switch_load_
network_lists&Event-Calling-Line-Number=984&domain=129.215.219.143&purpose=network-list]

9. By default, FreeSwitch plays hold music when there is only one avatar in the conference and beeps for everyone when avatars arrive and leave. To disable, edit /usr/local/freeswitch/conf/autoload_configs/conference.conf.xml. Locate the "default" profile and comment out the relevant lines. See examples above on this Wiki page.