Requirements
- Dokeos 1.8.4 or better 1.8.5 (and their requirements)
- Red5 0.6.x (0.7 is not yet supported as, when first testing this release, it was not available).
- Optional: if you want to use the command-line script, you will need the CLI version of PHP5
Installing Red 5
You can find all the documentation on the Red5 website : http://osflash.org/red5/063final
If you are using Ubuntu or Debian (which we recommend), you can install it opening a terminal and using (as root or using sudo):
# wget http://dl.fancycode.com/red5/0.6.3/debian/red5_0.6.3-1_all.deb
# dpkg -i red5_0.6.3-1_all.deb
The latter will probably ask you to install java-5-bin and java-5-jre in case you didn’t have these installed. These are official Java packages and you can install them without a doubt:
# sudo apt-get install sun-java5-bin sun-java5-jre
then re-execute the dpkg -i line above (if it failed the first time)
Under Ubuntu, gcj might be installed by default, which we do not recommend (Red5 doesn’t work with it). To update this setting, after installing Red5 and Java 5 as above:
# update-alternatives --set java /usr/lib/jvm/java-1.5.0-sun/jre/bin/java
Installing the Dokeos application for Red5
First, download our conferencing application inside the Red5 installation directory.
On Debian & Ubuntu:
# cd /usr/lib/red5/webapps
# wget http://www.dokeos.com/maven/repository/com/dokeos/dokeos-recorder/2.0.0-SNAPSHOT/dokeos-recorder-2.0.0-SNAPSHOT.war -O dokeos-recorder.war
Then configure it as follows:
Create the Dokeos Red5 configuration directory:
# mkdir /etc/dokeos
In this folder, create the configuration file:
# vi /etc/dokeos/videoconference-config.xml
Then insert the configuration as follows:
<?xml version="1.0" encoding="UTF-8"?>
<videoconference-config>
<server-keys>
<server-key host="dokeos.domaine.com_" key="PaSSw0rd" />
<server-key host="www.domaine.com_dokeos_" key="p4ssWoRD" />
</server-keys>
<moderator-check-on-whiteboard>false</moderator-check-on-whiteboard>
<video-streams-dir>/opt/dokeos/recorded-streams</video-streams-dir>
<vod-streams-dir>/opt/dokeos/vod-streams</vod-streams-dir>
</videoconference-config>
In this file, you will have to put at least one server-key line per portal. In this above example we authorize portals installed at the URLs:
The “_” at the end of each URL really matters, don’t forget it.
Reloading Red5
Restart Red5 to reload the configuration file and the new application using, on Ubuntu or Debian:
# /etc/init.d/red5 stop
# /etc/init.d/red5 start
Patch Dokeos 1.8.4
From a browser
- Download the patch here: http://www.dokeos.com/download/dokeos-1.8.4-patch-videoconference-2.0.tar.gz
- Uncompress it and send the files to your Dokeos web root directory (directly inside the “dokeos” directory)
- Change the permissions to writeable by the web browser on, or edit the main/inc/lib/add_course.lib.inc.php file to remove the conditions (but not the api_sql_query lines) under if(api_get_setting(’service_visio’,'active’)==’true’). You should end up with something like this:
if(api_get_setting('service_visio','active')=='true'){
api_sql_query("INSERT INTO `" . $tbl_course_homepage . "` VALUES (, '" . TOOL_VISIO_CONFERENCE . "','conference/index.php?type=conference','visio_meeting.gif','1','0','squaregrey.gif','NO','_self','interaction')");
api_sql_query("INSERT INTO `" . $tbl_course_homepage . "` VALUES (, '" . TOOL_VISIO_CLASSROOM . "','conference/index.php?type=classroom','visio.gif','1','0','squaregrey.gif','NO','_self','authoring')");
}
- Get on your portal’s homepage (e.g. http://my.dokeos.com/ or http://whatever.com/dokeos/)
- Update the URL to load the videosetweb.php script: http://my.dokeos.com/videosetweb.php
- A set of instructions will appear. Update your URL accordingly, to add the three required parameters: host, port and pass, then query that URL (press enter). For example (these are not real parameters):
http://my.dokeos.com/videosetweb.php?host=streaming.dokeos.com&port=1935&pass=password
- Don’t execute this script twice! If it failed, try to locate the problem and restore the backup before trying again.
- Once the script is done (it should give you an “Operation succeeded” message), delete the videoset.php and videosetweb.php scripts from your Dokeos directory.
- You can always ask for help on the forums: http://www.dokeos.com/forum/
From the command line
Go inside your dokeos installation portal. Beware that you should be root or a user allowed to overwrite files inside your Dokeos web root. Under Ubuntu, use sudo before any command.
On Debian/Ubuntu:
# cd /var/www/dokeos/
Download the patch:
# wget http://www.dokeos.com/download/dokeos-1.8.4-patch-videoconference-2.0.tar.gz
Uncompress the patch:
# tar zfvx dokeos-1.8.4-patch-videoconference-2.0.tar.gz
And finaly active the videoconferencing using either :
# php videoset.php . {host} {port} {pass}
(Where {host} must be replaced by the ip/hostname of your red5 server, {port} will be 1935 in most case, {pass} must be the key linked with the current domain in the configuration of RED5 (see above))
Delete the videoset.php and videosetweb.php scripts.
You should now be able to further edit these settings from the Dokeos administration panel.
Patch Dokeos 1.8.5
The 1.8.5 is a bit different. It already had part of the upgrade process ready, which means you have to disable one part of the script. This is done automatically by an additional parameter to the script.
From a browser
- Download the patch here: http://www.dokeos.com/download/dokeos-1.8.4-patch-videoconference-2.0.tar.gz
- Uncompress it and send the files to your Dokeos web root directory (directly inside the “dokeos” directory)
- Change the permissions to writeable by the web browser on, or edit the main/inc/lib/add_course.lib.inc.php file to remove the conditions (but not the api_sql_query lines) under if(api_get_setting(’service_visio’,'active’)==’true’). You should end up with something like this:
if(api_get_setting('service_visio','active')=='true'){
api_sql_query("INSERT INTO `" . $tbl_course_homepage . "` VALUES (, '" . TOOL_VISIO_CONFERENCE . "','conference/index.php?type=conference','visio_meeting.gif','1','0','squaregrey.gif','NO','_self','interaction')");
api_sql_query("INSERT INTO `" . $tbl_course_homepage . "` VALUES (, '" . TOOL_VISIO_CLASSROOM . "','conference/index.php?type=classroom','visio.gif','1','0','squaregrey.gif','NO','_self','authoring')");
}
- Get on your portal’s homepage (e.g. http://my.dokeos.com/ or http://whatever.com/dokeos/)
- Update the URL to load the videosetweb.php script: http://my.dokeos.com/videosetweb.php
- A set of instructions will appear. Update your URL accordingly, to add the five required parameters: host, port, pass, active and complete, then query that URL (press enter). For example (these are not real parameters):
http://my.dokeos.com/videosetweb.php?host=streaming.dokeos.com&port=1935&pass=password&active=1&complete=0
- active tells the script whether to add the links to the videoconference tool as visible (1) or invisible (0) to the users. complete tells the script to start from a 1.8.5 alpha architecture (0) or from a 1.8.4 architecture (1).
- Don’t execute this script twice! If it failed, try to locate the problem and restore the backup before trying again.
- Once the script is done (it should give you an “Operation succeeded” message), delete the videoset.php and videosetweb.php scripts from your Dokeos directory.
- You can always ask for help on the forums: http://www.dokeos.com/forum/
From the command line
Go inside your dokeos installation portal. Beware that you should be root or a user allowed to overwrite files inside your Dokeos web root. Under Ubuntu, use sudo before any command.
On Debian/Ubuntu:
# cd /var/www/dokeos/
Download the patch:
# wget http://www.dokeos.com/download/dokeos-1.8.4-patch-videoconference-2.0.tar.gz
Uncompress the patch:
# tar zfvx dokeos-1.8.4-patch-videoconference-2.0.tar.gz
And finaly active the videoconferencing using either :
# php videoset.php . {host} {port} {pass} {active} {complete}
(Where {host} must be replaced by the ip/hostname of your red5 server, {port} will be 1935 in most case, {pass} must be the key linked with the current domain in the configuration of RED5 (see above), {active} must be 1 or 0 depending on whether you want the links to the videoconference tool to be added as visible or invisible, and finally {complete} must be set to 0 for a 1.8.5 alpha version of Dokeos)
Delete the videoset.php and videosetweb.php scripts.
You should now be able to further edit these settings from the Dokeos administration panel.
Testing
If you have set everything up correctly and don’t have a firewall or whatever network problem, you should be able to: – enter a course – follow the “virtual classroom” link or the “virtual meeting” link
Known limitations
At present, the tool still has the following limitations – translations in english, spanish, french, german and dutch only – in virtual meeting, only one person at a time can write on the whiteboard (otherwise the drawings get messy) – conversion of PowerPoint presentations only work if Oogie is enabled on your server
