[Freeswitch-svn] [commit] r11134 - in freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax: . configs

Mon Jan 12 03:07:47 PST 2009

Author: gmaruzz
Date: Mon Jan 12 05:07:47 2009
New Revision: 11134

Log:
docs

Modified:
   freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/README
   freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/README.skypiax_auth
   freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/skypiax.conf.xml
   freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/startskype.bat
   freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/startskype.sh

Modified: freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/README
==============================================================================

--- freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/README	(original)
+++ freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/README	Mon Jan 12 05:07:47 2009
@@ -2,7 +2,36 @@
 #########################################################
 #########################################################
 
-  An example of installation
+WHAT IS SKYPIAX
+
+This software (Skypiax) uses the Skype API but is not endorsed, 
+     certified or otherwise approved in any way by Skype. 
+
+#########################################################
+#########################################################
+#########################################################
+
+Skypiax is an endpoint (channel driver) that use the Skype client as an interface to the Skype network, and allows incoming and outgoing Skype calls from/to FreeSWITCH. 
+
+Think at Skypiax as similar to OpenZAP for analog lines: for each channel you need an interface (a Skype client). So, for eg, for two concurrent calls, you will need two channels, and two Skype clients running on your machine.
+
+On Linux the Skype client uses a lot of CPU. To lower its CPU consumption, you can use the Xvfb "fake" X server and (more important) the snd-dummy ALSA "fake" sound driver. 
+
+On a Linux machine with 3GB ram and a quad core intel6600, we got no problem with 20 concurrent calls, and plenty of room for adding more Skypiax channels.
+
+On Windows, no need to do anything special, the Skype client is lighter on CPU.
+
+More info on skypiax:	http://wiki.freeswitch.org/wiki/Skypiax
+			http://www.celliax.org
+
+Skypiax has been contributed to the community by:
+			Giovanni Maruzzelli 
+			(gmaruzz at gmail dot com)
+#########################################################
+#########################################################
+#########################################################
+
+  An example of Skypiax installation on FreeSWITCH Linux
 
 #########################################################
 #########################################################
@@ -57,6 +86,9 @@
 *** copy the skypiax configuration file
 root at 8-04-srv:~/freeswitch_gmaruzz# cp src/mod/endpoints/mod_skypiax/configs/skypiax.conf.xml /usr/local/freeswitch/conf/autoload_configs/
 
+*** optionally, copy the dialplan configuration file that contains the "skypiax" modifications (eg: you can call "sip:skype/remote_skypename__OR__skypeout_phonenumber" for calling via the Skype network from a SIP softphone to remote_skypename or to a phone number via SkypeOut, or you can call the "2908" extension from any phone to be bridged to the Skype Test Call)
+root at 8-04-srv:~/freeswitch_gmaruzz# cp src/mod/endpoints/mod_skypiax/configs/default.xml /usr/local/freeswitch/conf/dialplan/
+
 *** now, let's get and install the Skype client
 root at 8-04-srv:~/freeswitch_gmaruzz# cd ..
 root at 8-04-srv:~#
@@ -65,7 +97,7 @@
 root at 8-04-srv:~# dpkg -i skype_ubuntu-2.0.0.72-1_amd64.deb
 
 *** now, let's get the skype configuration directory we prepared on another (desktop) machine
-*** on "How to prepare the configuration directory of Skype clients", see configs/README.skypiax_auth
+*** on "How to prepare the configuration directory of Skype clients on Linux", see configs/README.skypiax_auth
 root at 8-04-srv:~# cp /mnt/root/configskypenew.tgz ./
 root at 8-04-srv:~# tar xzf configskypenew.tgz
 root at 8-04-srv:~# chown root.root .Skype
@@ -102,6 +134,7 @@
 
 
 =============================================
+20 idle skypiax channels:
 
 top - 18:14:26 up  2:02,  2 users,  load average: 0.03, 0.08, 0.04
 Tasks: 111 total,   1 running, 110 sleeping,   0 stopped,   0 zombie

Modified: freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/README.skypiax_auth
==============================================================================
--- freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/README.skypiax_auth	(original)
+++ freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/README.skypiax_auth	Mon Jan 12 05:07:47 2009
@@ -1,18 +1,34 @@
-How to use skypiax_auth 
+#######################################
+HOW TO USE SKYPIAX_AUTH 
+#######################################
 
-You will use skypiax_auth only at the setup moment, to make the Skype client asking you to authorize "skypiax" to connect to the same Skype client.
+You will use skypiax_auth only at the setup moment, to force the Skype client to ask you to authorize "skypiax" to connect to it.
 
 Then you copy the .Skype configuration directory of the user that has launched Skype (eg: /home/maruzz/.Skype if you are maruzz) on the home directory of the user that will start Skype on the server (eg: root).
 
 Compile skypiax_auth:
 $ gcc -Wall -ggdb skypiax_auth.c -o skypiax_auth -lX11
 
-Start the Skype client on a desktop linux machine, logout from your autologin username if any, and login with the username and password you want to use for skypiax
+Then:
 
-Configure the Skype client to use the right audio devices, to not update, to not make "events", etc etc...
+1) Start the Skype client on a desktop linux machine, logout from your autologin username if any, and login with the username and password you want to use for skypiax
 
-Then, when satisfied, use skypiax_auth (that simulates FS-skypiax connecting to the Skype client). The Skype client will ask you to be authorized to let "skypiax" connect.
+2) Configure the Skype client to use the right audio devices, to not update, to not make "events", etc etc...
 
+3) Then, when satisfied, use skypiax_auth (that simulates FS-skypiax connecting to the Skype client). The Skype client will ask you to be authorized to let "skypiax" connect.
+
+4) Give the authorization and check the "not ask me again" option.
+
+5) Close (Quit) the Skype client from the tray icon, so it saves its config.
+
+6) Then, relaunch the Skype client and use skypiax_auth again, just to be sure it now succeed.
+
+7) Close (Quit) the Skype client from the tray icon, so it saves its config.
+
+*** Do the steps 1-7 for all Skype usernames you will want to use on the server (eg: one Skype username per channel)
+
+When finished wityh all the Skype usernames:
+Copy or targzip the .Skype directory and all its content on the home directory of the server user that will launch the Skype client(s).
 
 ############################
 first time you use skypiax_auth

Modified: freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/skypiax.conf.xml
==============================================================================
--- freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/skypiax.conf.xml	(original)
+++ freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/skypiax.conf.xml	Mon Jan 12 05:07:47 2009
@@ -29,6 +29,7 @@
 	<param name="tcp_srv_port" value="15559"/>
 	<param name="skype_user" value="skypiax2"/>
     </interface>
+    <!-- following interfaces are commented out!
     <interface id="3" name="skypiax3">
 	<param name="hold-music" value="$${moh_uri}"/>
 	<param name="dialplan" value="XML"/>
@@ -206,5 +207,6 @@
 	<param name="tcp_srv_port" value="15595"/>
 	<param name="skype_user" value="skypiax20"/>
     </interface>
+    -->
   </per_interface_settings>
 </configuration>

Modified: freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/startskype.bat
==============================================================================
--- freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/startskype.bat	(original)
+++ freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/startskype.bat	Mon Jan 12 05:07:47 2009
@@ -12,38 +12,41 @@
 call wait 7
 start Skype.exe /secondary /username:skypiax2 /password:xxx
 call wait 7
-start Skype.exe /secondary /username:skypiax3 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax4 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax5 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax6 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax7 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax8 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax9 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax10 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax11 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax12 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax13 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax14 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax15 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax16 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax17 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax18 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax19 /password:xxx
-call wait 7
-start Skype.exe /secondary /username:skypiax20 /password:xxx
+REM 
+REM Following Skype client instances are commented out
+REM
+REM start Skype.exe /secondary /username:skypiax3 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax4 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax5 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax6 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax7 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax8 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax9 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax10 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax11 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax12 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax13 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax14 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax15 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax16 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax17 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax18 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax19 /password:xxx
+REM call wait 7
+REM start Skype.exe /secondary /username:skypiax20 /password:xxx

Modified: freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/startskype.sh
==============================================================================
--- freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/startskype.sh	(original)
+++ freeswitch/branches/gmaruzz/src/mod/endpoints/mod_skypiax/configs/startskype.sh	Mon Jan 12 05:07:47 2009
@@ -21,112 +21,116 @@
 echo "skypiax2 xxx"| DISPLAY=:102 /usr/bin/skype --pipelogin &
 
 sleep 7
-/usr/bin/Xvfb :103 &
-sleep 3
-
-echo "skypiax3 xxx"| DISPLAY=:103 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :104 &
-sleep 3
-
-echo "skypiax4 xxx"| DISPLAY=:104 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :105 &
-sleep 3
-
-echo "skypiax5 xxx"| DISPLAY=:105 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :106 &
-sleep 3
-
-echo "skypiax6 xxx"| DISPLAY=:106 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :107 &
-sleep 3
-
-echo "skypiax7 xxx"| DISPLAY=:107 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :108 &
-sleep 3
-
-echo "skypiax8 xxx"| DISPLAY=:108 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :109 &
-sleep 3
-
-echo "skypiax9 xxx"| DISPLAY=:109 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :110 &
-sleep 3
-
-echo "skypiax10 xxx"| DISPLAY=:110 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :111 &
-sleep 3
-
-echo "skypiax11 xxx"| DISPLAY=:111 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :112 &
-sleep 3
-
-echo "skypiax12 xxx"| DISPLAY=:112 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :113 &
-sleep 3
-
-echo "skypiax13 xxx"| DISPLAY=:113 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :114 &
-sleep 3
-
-echo "skypiax14 xxx"| DISPLAY=:114 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :115 &
-sleep 3
-
-echo "skypiax15 xxx"| DISPLAY=:115 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :116 &
-sleep 3
-
-echo "skypiax16 xxx"| DISPLAY=:116 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :117 &
-sleep 3
-
-echo "skypiax17 xxx"| DISPLAY=:117 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :118 &
-sleep 3
-
-echo "skypiax18 xxx"| DISPLAY=:118 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :119 &
-sleep 3
-
-echo "skypiax19 xxx"| DISPLAY=:119 /usr/bin/skype --pipelogin &
-
-sleep 7
-/usr/bin/Xvfb :120 &
-sleep 3
-
-echo "skypiax20 xxx"| DISPLAY=:120 /usr/bin/skype --pipelogin &
-
-sleep 7
 
+#################################################################
+# Following X server Skype client instances are commented out
+#################################################################
+###/usr/bin/Xvfb :103 &
+###sleep 3
+###
+###echo "skypiax3 xxx"| DISPLAY=:103 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :104 &
+###sleep 3
+###
+###echo "skypiax4 xxx"| DISPLAY=:104 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :105 &
+###sleep 3
+###
+###echo "skypiax5 xxx"| DISPLAY=:105 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :106 &
+###sleep 3
+###
+###echo "skypiax6 xxx"| DISPLAY=:106 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :107 &
+###sleep 3
+###
+###echo "skypiax7 xxx"| DISPLAY=:107 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :108 &
+###sleep 3
+###
+###echo "skypiax8 xxx"| DISPLAY=:108 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :109 &
+###sleep 3
+###
+###echo "skypiax9 xxx"| DISPLAY=:109 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :110 &
+###sleep 3
+###
+###echo "skypiax10 xxx"| DISPLAY=:110 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :111 &
+###sleep 3
+###
+###echo "skypiax11 xxx"| DISPLAY=:111 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :112 &
+###sleep 3
+###
+###echo "skypiax12 xxx"| DISPLAY=:112 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :113 &
+###sleep 3
+###
+###echo "skypiax13 xxx"| DISPLAY=:113 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :114 &
+###sleep 3
+###
+###echo "skypiax14 xxx"| DISPLAY=:114 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :115 &
+###sleep 3
+###
+###echo "skypiax15 xxx"| DISPLAY=:115 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :116 &
+###sleep 3
+###
+###echo "skypiax16 xxx"| DISPLAY=:116 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :117 &
+###sleep 3
+###
+###echo "skypiax17 xxx"| DISPLAY=:117 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :118 &
+###sleep 3
+###
+###echo "skypiax18 xxx"| DISPLAY=:118 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :119 &
+###sleep 3
+###
+###echo "skypiax19 xxx"| DISPLAY=:119 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###/usr/bin/Xvfb :120 &
+###sleep 3
+###
+###echo "skypiax20 xxx"| DISPLAY=:120 /usr/bin/skype --pipelogin &
+###
+###sleep 7
+###

