<ahref="index.html">Documentation</a>> English installation guide
<divid="outerframe">
<divid="main">
<p> Thank you for downloading Dokeos!
This text will guide you through the basics of installing Dokeos 1.8.
Please read this fully before proceeding with the installation. </p>
<p> The installation guide is also available in other languages, please see <ahref="documentation/index.html">this overview page</a> for a list. The Dokeos website will notify when new translations are available. </p>
<p> This is only a short installation guide. We are writing a manual with more info on installation, but this was not ready at the time of writing. When ready, this manual will be accessible through the <ahref="http://www.dokeos.com/documentation.php">Dokeos documentation page</a>. You can read the work in progress manual on our <ahref="http://www.dokeos.com/wiki/index.php/Manual">web writing area</a>. We also maintain a list of <ahref="http://www.dokeos.com/wiki/index.php/FAQ">Frequently Asked Questions (FAQ)</a>. </p>
<p><b>Contents</b>
<ol>
<li><ahref="#requirements">Requirements</a></li>
<li><ahref="#install_new_version">Installing a new version of Dokeos</a></li>
<li><ahref="#upgrade_previous_version">Upgrading from a previous version of Dokeos</a></li>
<p> These software packages have to be installed on the computer where you will install Dokeos. <br/>
You can install all these software packages separately, which often gives the best results. However, beginning users who want to test Dokeos can use a <i>combination package</i> that installs all these software packages in one simple install. If you want to use a combination package, we recommend Wamp (Download at <ahref="http://www.wampserver.com/en/index.php">the WAMP5 website</a>, you also need the <ahref="http://www.wampserver.com/en/add-ons.php">PHP4 add-on</a>) or <ahref="http://www.apachefriends.org/en/index.html">XAMP</a>. </p>
<h4>1.1.1. A web server</h4>
<p> The Apache web server is recommended, and Dokeos is configured to use some Apache security enhancements if possible. However, other web servers will work too. For best security results, you need to have the Apache module mod_rewrite activated. The mod_rewrite rules for Dokeos are read from a .htaccess file in the courses folder, so Apache needs to allow this (AllowOverride FileInfo in httpd.conf). <br/>
<br/>
<ahref="http://httpd.apache.org/download.cgi">Download Apache web server</a><br/>
<ahref="http://httpd.apache.org/docs-project/">Apache web server manual</a></p>
<h4>1.1.2. PHP</h4>
<p> You need PHP version 4.3.2 or later (4.x versions), configured with the following modules : mysql, zlib, preg, xml. PHP versions 5 or later are not supported by Dokes yet.
You need the ldap module too if you want to use ldap with Dokeos.
Most of the PHP4 compiled distributions are provided with these modules.
Anyway, their presence is checked by the Dokeos install script. <br/>
<p> Some users could meet problems if their PHP setting doesn't fit
these ones:</p>
<ul>
<li>short_open_tag = On</li>
<li>safe_mode = Off</li>
<li>magic_quotes_gpc = On</li>
<li>magic_quotes_runtime = Off</li>
</ul>
<p> Past Dokeos versions required register_globals to be set to On. This is
no longer necessary, this can be set to Off and Dokeos will work fine. </p>
<p><strong>BSD users:</strong> these php libraries have to be included during php installation:</p>
<ul>
<li>php-mysql The mysql shared extension for php</li>
<li>php-pcre The pcre shared extension for php</li>
<li>php-session The session shared extension for php</li>
<li>php-zlib The zlib shared extension for php</li>
<li>php-xml</li>
<li>(optional) php-ldap if you want to be able to use LDAP authentication</li>
</ul>
<h4>1.1.3. The MySQL database server</h4>
<p> You will need a login and password allowing to administrate
and create at least one database. By default, Dokeos will create a new
database for each course created. It means your host should allow you to
create and administrate several databases. You can also install DOkeos using only one database, in that case you have to select this option during the
installation. <br/>
<br/>
<ahref="http://dev.mysql.com/downloads/">Download MySQL server</a><br/>
<ahref="http://dev.mysql.com/doc/mysql/en/index.html">MySQL server manual</a></p>
<p><b>Note:</b><br/>
It seems the backticks characters (`) inserted inside most of
the Dokeos SQL queries since version 1.3 don't work with MySQL
versions before 3.23.6. </p>
<h4>1.1.4. Permissions</h4>
<p> Furthermore, Dokeos needs to have write access to specific directories. The best way to deal with these permission is to give the webserver user
read/ write access on the specified directories. The other directories can work with read access. The specific directories are <ahref="#protections">listed in the installation section.</a>
or unzipped to. On a Windows machine locally, this
is not a problem. Remotely, you need to be allowed to CHMOD
(ex on Debian /usr/lib/openoffice/share/registry/data/org/openoffice/Setup.xcu)
</p>
<p>For the basic convertion of a presentation to Dokeos one need to run the openoffice server in headless mode. On linux systems this is
done via the X framebuffer (xvfb package). When your server does not contain an x-window system, additional fonts and basic x-window libraries have to be installed for
not running into problems.</p>
<p>
If during the conversion sets one need additional recording of sound, then the installation of the
<ahref="#Openlaszlo">Openlaszlo and tomcat modules</a>are needed.
</p>
<p>
The startup from the Openoffice server at startup from the computer van be done via the file oooserver.init. Additional description is found
on the Dokeos wiki<ahref="http://www.dokeos.com/wiki/index.php/MakeOOOListening">http://www.dokeos.com/wiki/index.php/MakeOOOListening</a>
</p>
<p>
Configuration in dokeos platform admin, Configure the services, Configure PowerPoint2LearningPath
<ul>
<li>host:<b>localhost</b></li>
<li>Username:</li>
<li>Ftp password:</li>
<li>Path to LZX Files:</li>
When the openofficeserver runs on the same server as Dokeos. Host is localhost. Otherwise the remote parameters have to be entered.
When a recording of audio is needed then the path to the lzx files is needed. When the openlaszlo server is installed on an other
server the host has to be added otherwise.<b>/lps-latest/dokeos/videoconference/ppt2lprecorder.lzx</b>
</ul>
</p>
<h3><aname="VideoConferencing">1.4 Requirements for VideoConferencing</a></h3>
<p>The set-up and usage of the videoconferencing and recording functionality in Dokeos is provided by patched external
packages. These patches are at this moment not yet available in the latest stable release of the packages. The following
4 packages are used. Openlaszlo comes in a packages with the tomcat server 5.0.24. The red5 streaming servers is packaged with the
jetty servlet engine. In order to be able to correctly identify the usercontext from Dokeos into Openlaszlo and Red5 the
connection between the apache webserver and the tomcat servlet engine is needed.
<h4><aname="Openlaszlo">1.4.1 Requirements and installation of OpenLaszlo</a></h4>
<p>Depending if the Openlaszlo server is installed on the same server as the webserver of dokeos, different parameters have to be changed</p>
<ul>
<li>Installation of the Openlaszlo server tar -xzvf dokeosopenlaszlo_1_8.tar.gz</li>
<li>Check the path to the JAVA_HOME in <b>$yourinst/lps-latest/Server/tomcat-5.0.24/bin/startup.bin(bat)</b></li>
<li>If on a different server then the file should be edited <b>$yourinst/lps-latest/Server/lps-latest/videoconference/videoconference.lzx</b> (rmtphost should change to the host of dokeosserver, rmtphostlocal local tomcatserver)</li>
<li>Start server with <b>$yourinst/lps-latest/Server/tomcat-5.0.24/bin/startup.bin(bat)</b></li>
</ul>
<h4><aname="Red5">1.4.2 Requirements and installation of Red5 Server</a></h4>
<p>Installation and set-up of the Red5 Server</p>
<ul>
<li>Installation tar -xzvf dokeosred5_1_8.tar.gz</li>
<li>Check the path to the JAVA_HOME<b>$yourinst/dist/red5.sh(bat)</b></li>
<li>Start the server with <b>$yourinst/dist/red5.sh(bat)</b></li>
</ul>
<h4><aname="ApacheConfig">1.4.3 Requirements for the connection of Tomcat with Apache</a></h4>
<p>The mod-jk or mod-jk module for apache(2) has to be installed in order to transfer the sessiondata from the Dokeos to the
additional plugins. For the installation of the additional modules see the installation guide of the webserver.</p>
<h2><aname="install_new_version">2. Installing a new version of Dokeos</a></h2>
<p> 2.1. Download the Dokeos 1.8 install package (.zip for Windows users or .tar.gz for all others) from the <ahref="http://www.dokeos.com/download.php">Dokeos download page</a>. </p>
<p> 2.2. Unzip or untar the downloaded install package.
Most current operating systems
can do this with a built-in graphical application, if this doesn't work
you can open a commandline, go to the download directory and type
tar -zxvf dokeos-community-1.8.tar.gz </p>
<p> 2.3. Move by any means (FTP, SCP, local file copy) the contents of the
Dokeos install package to your website on your webserver (whether webroot or subdirectory). Your webserver can also be your local computer. Be sure to copy all the folders (archive, home, claroline, courses) as well as all the .php files. </p>
<p> For Windows users who install Dokeos locally: if you use an Apache/PHP/MySQL combination package, just drag and drop the contents of the Dokeos install package into the web directory of the combination package:</p>
If you install Dokeos locally (not on a server) open:
http://localhost/dokeos/index.php </p>
<p> 2.7. Click on the install button and follow instructions.
Windows: with combination packages like easyphp, out of the box, login and password
for MySQL should probably remain empty. </p>
<p><strong>2.8. Configuration and security after installation</strong></p>
<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 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>
<hr>
<h2><aname="upgrade_previous_version">3. Upgrading from a previous version of Dokeos</a></h2>
<p> Before upgrading we heavily 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><em>If you upgrade from Dokeos 1.8</em>, you can simply copy the new files of 2.0.1 over
the files of the older version. You should not copy over the home, courses or archive folders, otherwise you might lose data. If you accidentally copy over those folders, you can simply replace them with the folders from your backup.<br/>
<em>If you upgrade from a lower version of Dokeos (1.6.x)</em>,
you'll have to use the built-in upgrade facility, as described below. </p>
<p> 3.1. Download the Dokeos 1.8 install package (.zip for Windows users or .tar.gz for all others) from the <ahref="http://www.dokeos.com/download.php">Dokeos download page</a>. </p>
<p> 3.2. Unzip or untar the downloaded install package.
Most current operating systems
can do this with a built-in graphical application, if this doesn't work
you can open a commandline, go to the download directory and type
tar -zxvf dokeos-community-1.8.tar.gz </p>
<p> 3.3. Move the Dokeos directory to a different path from the previous version </p>
<p><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>TIP:</b><br/>
If you want Dokeos 1.8 to be installed in the same directory as
the previous version :
<ul>
<li>move the old directory to a new location (e.g. move dokeos/ to dokeos_old/)</li>
<li>uncompress Dokeos 1.8 to the old version directory (e.g. uncompress Dokeos 2.0.1 to dokeos/)</li>
<li>go to next step</li>
</ul>
</p>
<p> 3.4. The following files need to be readable and writeable by the web server:
<p> In the future we will also provide instructions on how to do a "manual" install
of Dokeos, by creating the database tables yourself.
If you have any problems, go to the <ahref="http://www.dokeos.com">Dokeos website</a> and ask a question on our <ahref="http://www.dokeos.com/forum/">support forum</a>. Please read the previous messages first to see if there is
already an answer to your question. We also maintain a list of <ahref="http://www.dokeos.com/wiki/index.php/FAQ">Frequently Asked Questions</a>. </p>
