<p>Thank you for downloading Dokeos, the open source Learning Management System for professionals. </p>
<ul>
<li>Quick preview of <ahref="http://www.dokeos.com/features.php">Dokeos features </a></li>
<li>test Dokeos on <ahref="http://campus.dokeos.com">Free Campus</a><br>
</li>
<li>Test Dokeos on <ahref="http://campus.dokeos.com">Free Campus</a></li>
</ul>
<p>This guide explains how to install Dokeos Learning
@ -48,190 +31,116 @@ Management System (LMS). It explains how to install Dokeos Oogie
PowerPoint conversion and Dokeos Videoconferencing although these
packages are not required to use Dokeos LMS. Please read this fully before proceeding with the installation. </p>
If
you want to save time, trouble and money, you can alternatively have
your Dokeos portal <ahref="http://www.dokeos.com/get.php">hosted</a> by Dokeos or one of its partners.<ahref="http://www.dokeos.com/get.php"></a><br>
If you want to save time, trouble and money, you can alternatively have your Dokeos portal <ahref="http://www.dokeos.com/get.php">hosted</a> by Dokeos or one of its partners.<ahref="http://www.dokeos.com/get.php"></a><br>
can be installed on Windows, Linux, Mac OS X and UNIX servers
indifferently. However, we recommend the use of Linux server for
optimal flexibility, remote control and scalability. <br>
<br>
optimal flexibility, remote control and scalability. <br/>
<br/>
Dokeos is mainly a LMS running <spanstyle="font-weight: bold;">Apache</span>, <spanstyle="font-weight: bold;">MySQL</span> and <spanstyle="font-weight: bold;">PHP5</span> (the so called <spanstyle="font-weight: bold;">AMP</span> trilogy). <br/>
<br/>
Dokeos is mainly a LMS running <spanstyle="font-weight: bold;">Apache</span>, <spanstyle="font-weight: bold;">MySQL</span> and <spanstyle="font-weight: bold;">PHP5</span> (the so called <spanstyle="font-weight: bold;">AMP</span> trilogy). <br>
<br>
It
can be enriched with PowerPoint conversion (feature called Dokeos
It can be enriched with PowerPoint conversion (feature called Dokeos
Oogie) using <spanstyle="font-weight: bold;">OpenOffice</span> + Java. You may also want to add the Dokeos Videoconferencing plugin using the <spanstyle="font-weight: bold;">RED5</span> Open
Source Flash server. <br>
<br>
All these software are open source and freely available. <br>
<br>
Source Flash server. <br/>
<br/>
All these software are open source and freely available. <br/>
<br/>
To run Dokeos <spanstyle="font-weight: bold;">LMS</span> on your server, you need to install WAMP, LAMP or MAMP:
<ul>
<li>To install <spanstyle="font-weight: bold;">WAMP</span> (AMP on Windows), we recommend the <ahref="http://www.apachefriends.org/en/xampp.html">XAMPP</a> .exe installer<ahref="http://www.apachefriends.org/en/xampp.html"><br>
</a></li>
<li>To install <spanstyle="font-weight: bold;">WAMP</span> (AMP on Windows), we recommend the <ahref="http://www.apachefriends.org/en/xampp.html">XAMPP</a> .exe installer<ahref="http://www.apachefriends.org/en/xampp.html"></a></li>
(AMP on Linux), use the Package manager of your favourite distribution (Synaptic, RPMFinder etc.).
For instance, on a Ubuntu server, use Shell or Synaptic following the
<ahref="http://ubuntuguide.org/wiki/Ubuntu:Feisty#Apache_HTTP_Server">Ubuntuguide on Apache</a> and the following sections</li>
<li>To install <spanstyle="font-weight: bold;">MAMP</span> (AMP on Mac OS X), refer to the <ahref="http://www.mamp.info/en/index.php">MAMP</a> dedicated website<ahref="http://www.mamp.info/en/index.php"></a></li>
the dokeos directory in your Apache web directory. This can be
<li>Copy the dokeos directory in your Apache web directory. This can be
<spanstyle="font-weight: bold;">C:\xampp\htdocs\</span> on a Windows server or <spanstyle="font-weight: bold;">/var/www/html/</span> on a Linux server</li>
<li>Open
your web browser (Internet Explorer, Firefox...) and type
<li>Open your web browser (Internet Explorer, Firefox...) and type
<spanstyle="font-weight: bold;">http://localhost/dokeos/</span> if you install locally or
<spanstyle="font-weight: bold;">http://www.mydomain.com/dokeos/</span> if you install remotely</li>
<li>Follow the web installation process. You can accept all default
values. Consider changing the admin password to remember it. </li>
<li>Follow the web installation process. You can accept all default values. Consider changing the admin password to remember it. </li>
</ul>
<br>
<br/>
The following directories need to be readable, writeable and executable for everyone:
<ul>
<li>dokeos/main/inc/conf/</li>
<li>dokeos/main/garbage/</li>
<li>dokeos/main/upload/</li>
<li>dokeos/archive/</li>
<li>dokeos/courses/</li>
<li>dokeos/home/</li>
</ul>
(where 'dokeos' is the directory in which you installed Dokeos)
<p>
On Linux, Mac OS X and BSD operating systems you can use the CHMOD 777 command for this.
On Linux, Mac OS X and BSD operating systems you can use the CHMOD 777 command for this (although we recommend you seek advice from an experienced system administrator).
In Windows, you may need to check the properties of the folders (by right-clicking on them).
</p>
<p>
2.5. The following files need to be readable and writeable for everyone:
2.5. The following files need to be readable and writeable for the web browser:
On Linux, Mac OS X and BSD operating systems you can use the CHMOD 666 command for this.
On Linux, Mac OS X and BSD operating systems you can use the CHMOD 666 command for this (although we recommend you seek advice from an experienced system administrator).
In Windows, you may need to check the properties of the files and folders (by right-clicking on them).
</p>
@ -239,34 +148,26 @@ In Windows, you may need to check the properties of the files and folders (by ri
<p>
<b>NOTES:</b><br>
Do not modify the home_*.html files directly. Instead,
choose "Configure the homepage" in the Dokeos administration section.</p>
<p><spanstyle="font-weight: bold;">Windows</span> : with combination packages like XAMPP, out of the box, login and password
for MySQL should probably remain empty.</p>
<p></p>
<h3><strong> Configuration and security after installation</strong></h3>
<ul>
<li><strong>Protect your configuration file: </strong>
make sure no one can overwrite it. You can find the config file in <em>(dokeos folder)</em>/main/inc/conf/configuration.php.
Make it read-only (windows/xwindows: right-click the file to edit the
properties. linux/bsd/macosx: use the chmod 444 command). The config
file is created by Apache so you may need to be root user to change its
permissions.</li>
<li><strong>Protect your installation folder: </strong>
if the <em>(dokeos folder)</em>/main/install
folder is still accessible, someone could install over your existing
version (you could lose your data that way). Move the folder somewhere
out of the web directories so it is not accessible, change its name, or
edit its properties so no one can read or execute it.</li>
<li><strong>For better security: </strong>
making the files world-writable will help you install, and solves many
issues for people without much admin experience. However, it's better
@ -274,81 +175,49 @@ security to make the owner of the apache process (often called apache
or www-data) also owner of all the dokeos files and folders. Ths way,
these files need only be readable and writable by the Apache process
owner, not by the entire world.</li>
<li><strong>Configure your Dokeos installation: </strong>
in the administration section of Dokeos, you can use the Dokeos Config Settings to adjust the behavior of your installation.</li>
<li><strong>Configure Dokeos mail: </strong>
most of Dokeos uses the mail settings from the php.ini file. However,
the announcements tool uses phpMailer (another free software project)
and the settings for this tool can be adjusted in <em>(dokeos folder)</em>/main/inc/conf/mail.conf.php.</li>
</ul>
<br>
<br/>
<h3>PHP configuration</h3>
To get the best of Dokeos, you need to finetune PHP settings. Consider : <br>
To get the best of Dokeos, you need to finetune PHP settings. Consider : <br/>
<ul>
<li>Editing php.ini file (on windows can be located at <spanstyle="font-weight: bold;">C:\xampp\php\php.ini</span>, on Ubuntu Linux : <spanstyle="font-weight: bold;">/etc/php5/apache2/php.ini</span></li>
<li>search the word "max" and increase values to optimise the server</li>
<li>you may want to end up with the following values : <br>
</li>
<li>you may want to end up with the following values : </li>
<tdstyle="vertical-align: top; background-color: rgb(229, 229, 229);"><small>max_execution_time = 300 ; Maximum execution time of each script, in seconds<br>
max_input_time = 600 ; Maximum amount of time each script may spend parsing request data<br>
memory_limit = 256M ; Maximum amount of memory a script may consume (128MB)<br>
<hr><h2><aname="3._Upgrade_from_a_previous_version_of"></a>3. Upgrade from a previous version of Dokeos</h2>Before upgrading we <b>heavily</b> recommend you do a full backup of the previous
<hr/>
<h2><aname="3._Upgrade_from_a_previous_version_of"></a>3. Upgrade from a previous version of Dokeos</h2>Before upgrading we <b>heavily</b> recommend you do a full backup of the previous
Dokeos directories and databases. If you are unsure how to achieve this
please ask your hosting provider for advice.<br><p>
</p>
please ask your hosting provider for advice.<br/>
<p></p>
<h3>3.1 Upgrading from Dokeos 1.8.x</h3>
<em>If you upgrade from Dokeos 1.8.x</em> :
<ul><li> check that you haven't left any customised stylesheet or image*</li><li> download the Dokeos 1.8.4 install package from the <ahref="http://www.dokeos.com/download.php">Dokeos download page</a></li><li> unzip the new files of Dokeos 1.8.4 over the files of the older version</li><li> point your browser on your portal URL + main/install/</li><li> choose your language and click <spanstyle="font-style: italic;">Upgrade from 1.8.x</span></li></ul>
<br>
<br/>
<fontsize="-1">* Styles and images are located in the main/css or main/img
directories. You can still recover them from your backup if you have made it.
Any modified style or image that uses the default style/image name will be
@ -405,11 +258,9 @@ directories. You can still recover them from your backup if you have made it.
ensure you copy the styles/images under a new name and use and modify the
copy, not the original. The original will always be overwritten by newer
versions.</font>
<br>
<p>
</p><h3>3.2 Upgrading from Dokeos 1.6.x</h3>
<br/>
<p></p>
<h3>3.2 Upgrading from Dokeos 1.6.x</h3>
<em>If you upgrade from a lower version of Dokeos (1.6.x)</em>, the first
and most important thing to do is to *move* your current directory to another
@ -423,77 +274,64 @@ mv * old_verion/), then make the old_version/ directory writeable by the web ser
new directory <em>main</em> should be located directly inside your
Dokeos root folder</li><li> point your browser on your portal URL</li><li> choose your language and click <spanstyle="font-style: italic;">Upgrade from 1.6.x</span> and confirm the
current directory of the old version</li></ul>
<br>
<br/>
<em> NOTE: </em> The upgrade from 1.6.x to 1.8.x implies a revision of
the customised graphics and styles. The new version uses a complete new
set of icons and styles, which means the ones from version 1.6 cannot be
simply reused. The good news is the version 1.8.x allows you to create
your own style in a separate css folder, that you can then reuse through
all the 1.8.x versions
<br>
<br/>
<p></p>
<p>
<b>WARNING:</b><br>
<b>WARNING:</b><br/>
Do not delete the previous Dokeos installation directory before installing
the new one. When the update is successfully finished, you can remove
the old path.
</p>
<p>
<b>NOTE:</b><br>
<b>NOTE:</b><br/>
Do not modify the home_*.html files directly. Instead,
choose "Configure the homepage" in the Dokeos administration section.
</p>
<p>
</p><h3>3.3 In both cases</h3>
The following directories need to be readable, writeable and executable for the web server:
On Linux, Mac OS X and BSD operating systems you can quick-fix this using the
CHMOD 777 command, but if you are unsure, we recommend you seek advice for
your own OS on <ahref="http://www.dokeos.com/forum/">our forum</a>.
In Windows, you may need to check the properties of the folders.
<p>
</p><h3>3.4 Quick-upgrade from 1.6.x guide for Linux</h3>
The following quick-upgrade guide assumes that:
<ul><li>the Dokeos database username (for MySQL) is "dokeos_db_user" and your login is "dokeos_user"</li><li>the Dokeos installation is currently in /var/www/dokeos/ and it has 777 permissions</li><li>your portal's URL is http://www.portalurl.com/</li></ul>
<ul><li>Direct your browser to http://www.portalurl.com/main/install/</li><li>Proceed with the installation</li><li>Review the directories permissions</li></ul>
Oogie converts your presentations coming from Ms-Office and OpenOffice into SCORM standardized e-courses or <spanstyle="font-style: italic;">learning paths</span>.
This feature needs OpenOffice to convert the slides and RED5 (optional)
to record your voice on top of the slides through a Flash based
<tdstyle="vertical-align: top; background-color: rgb(229, 229, 229);"><small>On some Windows computers, located : <spanstyle="font-weight: bold;">C:\Program Files\OpenOffice.org 2.2\share\registry\data\org\openoffice\Setup.xcu</span><br>
On some Linux computers, located : <spanstyle="font-weight: bold;">/usr/lib/openoffice/share/registry/data/org/openoffice/Setup.xcu</span></small></td>
Enter your Dokeos portal on the web ><spanstyle="font-style: italic;">Admin section > Configure the Services > Oogie </span>and type :<br>
<br>
Enter your Dokeos portal on the web ><spanstyle="font-style: italic;">Admin section > Configure the Services > Oogie </span>and type :<br/>
<li>Start OpenOffice. Conversion will work only if this software is up and running. Check the <ahref="http://www.dokeos.com/wiki/index.php/MakeOOOListening">MakeOOOListening</a> wiki page to start OpenOffice as a service.</li>
<li>Test the conversion : create a course > enter the course >
Learning Path > PowerPoint conversion. If the slides are converted,
then OpenOffice is listening to Dokeos. </li>
</ul>
<spanstyle="font-weight: bold;">NOTE</span> : during the conversion,
you should see a progress bar with a percentage. If you only see a
default animated GIF progress bar without percentage, you may want to
install the PECL library for PHP. <br><br><spanstyle="font-weight: bold;">NOTE</span> : On Linux servers, you may want to do a <spanstyle="font-weight: bold;">$ sudo apt-get install msttcorefonts</span> so as to install Microsoft fonts. This will give PowerPoint conversion a better rendering. <br>
<br>
<spanstyle="font-weight: bold;"><br></span><h3>7.2. Audio-recorder</h3>See below : Videoconferencing<br><br><hrstyle="width: 100%; height: 2px;"><h2><aname="8._Videoconferencing_and_audio-recorder"></a>8. Videoconferencing and audio-recorder</h2>We will now install and configure RED5 Open Source Flash server <EFBFBD> the Dokeos RED5 webapplication. These will provide both <br><ul><li>Videoconferencing and</li><li>Audio recorder for Oogie</li></ul>
install the PECL library for PHP. <br/><br/><spanstyle="font-weight: bold;">NOTE</span> : On Linux servers, you may want to do a <spanstyle="font-weight: bold;">$ sudo apt-get install msttcorefonts</span> so as to install Microsoft fonts. This will give PowerPoint conversion a better rendering. <br/>
<h2><aname="8._Videoconferencing_and_audio-recorder"></a>8. Videoconferencing and audio-recorder</h2>We will now install and configure RED5 Open Source Flash server <EFBFBD> the Dokeos RED5 webapplication. These will provide both <br/><ul><li>Videoconferencing and</li><li>Audio recorder for Oogie</li></ul>
Oogie allows you to convert slides but also <br/>
<ul>
<li>add tests, pages and activities between the slides, thanks to the Learning Path builder</li>
<li>get SCORM reporting thanks to the Learning path tool</li>
<li>add audio on top of the slides thanks to the online audio recorder</li>
installation processes for this part were very complex. The whole setup
was considerably simplified. Please ignore any previous documentation
on the same topic.
<br><br><br>You may want to take advantage of the audio recorder. For this :<br>
<br/><br/><br/>You may want to take advantage of the audio recorder. For this :<br/>
<ul>
<li>Download and install <ahref="http://osflash.org/red5">RED5 Open Source Flash server</a> (you will find Linux packages and a Windows installer on the RED 5 website)</li>
<li>Unzip it and copy it into the <spanstyle="font-style: italic;">webapps</span> directory of your RED5 installation. Windows : you can use <ahref="http://www.7-zip.org/">7-ZIP</a>
to untar. Target directory can be C:/Program Files/Red5/webapps/ .
Linux with Nautilus or through a shell : cp dokeos-red5APP-1.8/*
/usr/lib/red5/webapps</li>
<li>Edit the RED5 settings to fit with your firewall requirements in terms of open ports if there is a limitation. </li><li>Configure Red5.</li><ul><li>Edit /usr/lib/red5/conf/red5.properties</li><li>Edit /usr/lib/red5/conf/realm.properties and change the default administrator password.</li></ul></ul><h4>More informations on RED5</h4>Please take a look on this page : <ahref="http://www.dokeos.com/wiki/index.php/Installing_videoconference">http://www.dokeos.com/wiki/index.php/Installing_videoconference</a><br><br><h4>Configuration of your dokeos Videoconference plugin</h4>The
configuration of the VideoServing is done via the admin pages of Dokeos
configuration in Dokeos platform admin, Configure the services,
Configure Visio-conference<br>This contains the URL to the video
Configure Visio-conference<br/>This contains the URL to the video
conferencing application. You probably need to add something before
these paths if Dokeos is not installed into the root of your webserver.<br>url:/main/webrooms/videoconference.html and <br> /main/webrooms/videoconference2.html<br><br><h4>Connect your Dokeos installation to RED5</h4>You
should tell Dokeos the configuration of you red5 server. This is done
using the administration page of Dokeos. In the first field below the
two url, set the public ip of your red5 server. The second field <br>will
two url, set the public ip of your red5 server. The second field <br/>will
contain the value of <EFBFBD> rtmp.port <EFBFBD> from you red5
configuration and the last field will contains <EFBFBD> rtmpt.port <EFBFBD>
Yannick Warnier
18 years ago