About Dokeos Installation Guide GPL license Credits Dependencies Changelog Website

"Dokeos e-Learning Suite" Installation Guide

Thank you for downloading "Dokeos e-Learning Suite"

Contents

  1. Pre-requisites
  2. Installation of "Dokeos e-Learning Suite"
  3. Upgrade from a previous version
  4. Troubleshooting
  5. Administration section
  6. LDAP / Active Directory
  7. OogieRapid Learning
  8. Videoconferencing
  9. Mathematics
  10. Multisite
  11. Contact

1. Pre-requisites

Dokeos 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.

Dokeos is mainly a LCMS running Apache 2, 2.0, MySQL 5.1 and PHP 5.3 (the so called AMP trilogy). All these software are open source and freely available.

To run Dokeos on your server, you need to install WAMP, LAMP or MAMP:

MySQL database server

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, but before you must to create a database in your shared hosting.

2. Installation of "Dokeos e-Learning Suite"

The following directories need to be readable, writeable and executable for everyone:

(where 'dokeos' is the directory in which you installed Dokeos). 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).

The following files need to be readable and writeable for the web browser, only during the installation process:

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).

NOTES:
Do not modify the home_*.html files directly. Instead, choose "Configure the homepage" in the Dokeos administration section.

Windows : with combination packages like XAMPP, out of the box, login and password for MySQL should probably remain empty.

Configuration and security after installation

PHP configuration

To get the best of Dokeos, you need to finetune PHP settings. Consider :
max_execution_time = 300    ; Maximum execution time of each script, in seconds
max_input_time = 600 ; Maximum amount of time each script may spend parsing request data
memory_limit = 512M      ; Maximum amount of memory a script may consume (128MB)
post_max_size = 64M
upload_max_filesize = 200M

Some users could meet problems if their PHP settings don't fit these ones:

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.

Note: if you are using PHP 5.3 or higher, you need to set your date.timezone setting to whatever your server's timezone is. For example, if your server is in the 'America/Lima' timezone, set this in your php.ini: date.timezone = 'America/Lima'

Note: PHP 5.3.9 introduces a new setting "max_input_vars", which limits the number of elements you can send in one single form. If you are dealing with numerous users, make sure you set this setting higher than its default value of 1000.

BSD users: these php libraries have to be included during php installation:

You might also add the following php modules and packages:

3. Upgrade from a previous version

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.

3.0 From Dokeos 2.x

If you upgrade from Dokeos 2.x :

3.1 From Dokeos 1.8.x

If you upgrade from Dokeos 1.8.x : * 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 overwritten by the next step. To avoid loosing your customisations, always 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. In Dokeos 1.8.5, we have changed the name of several CSS themes. Backwards compatibility is ensured by the fact that an upgrade only adds the new themes, but you should try and use these new themes rather than sticking to the old ones which will be deprecated shortly (not maintained).

3.2 From Dokeos 1.6.x

An easy way to do that is to create a subdirectory called old_version in your current Dokeos directory and move everything in there using a simple "move" command (i.e. under Linux: mkdir old_version; mv * old_verion/), then make the old_version/ directory writeable by the web server so that courses/ and upload/ directories can be moved from the old to the new installation.

The complete process is as follow:

NOTE: The upgrade from 1.6.x to "Dokeos e-Learning Suite" 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 "Dokeos e-Learning Suite" allows you to create your own style in a separate css folder.

WARNING

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.

Do not modify the home_*.html files directly. Instead, choose "Configure the homepage" in the Dokeos administration section.

3.3 In both cases

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. In Windows, you may need to check the properties of the folders.

3.4 Quick-upgrade from 1.8.x or "Dokeos e-Learning Suite" guide for Linux servers

The following quick-upgrade guide assumes that: On the command-line, type: Then:

4. Troubleshooting

If you have problems, go to the Dokeos website

5. Administration section

To access the Dokeos administration section, open browser, go to your Dokeos adress and log in with the admin user. Then you will see a "Platform admin section" link in the header of the web page. There you can manage users, courses, sessions, portal look and feel, homepage content, course categories etc.

6. LDAP

This part is optional, only organisations with an LDAP server will need to read this. An LDAP module is already provided in Dokeos, but it has to be configured to make it work.

Compiling

Linux servers: It's possible that you have to recompile php with ldap support. Newer distributions also allow downloading rpms for additional packages.

Activating LDAP in Dokeos

In (dokeos folder)/main/inc/conf/configuration.php, around line 90, you see

//for new login module
//uncomment these to activate ldap
//$extAuthSource['ldap']['login'] = "./main/auth/ldap/login.php";
//$extAuthSource['ldap']['newUser'] = "./main/auth/ldap/newUser.php";
remove the // from the last two lines to activate LDAP.

Settings

Ask the LDAP server admin for the settings:

Since 1.8.5, you have to change the LDAP settings inside the "Portal administration" panel, under "Dokeos configuration settings", section "LDAP".

As an example, you should find the following kind of values:
LDAP main server's address: "myldapserver.com"; // your ldap server
LDAP main server's port: 389; // your ldap server's port number
LDAP domain: "dc=xx, dc=yy, dc=zz"; //domain

Teacher/student status

By default, Dokeos will check if the "employeenumber" field has a value. If it has, then Dokeos will consider this user as being a teacher.
If you want to change this behaviour, you can edit main/auth/ldap/authldap.php, function ldap_put_user_info_locally(), and change the if (empty($info_array[$tutor_field])) condition to whatever suits you.
You can also remove this check by removing the condition and leaving only the $status = STUDENT; line.

Protected LDAP servers

Some LDAP servers do not support anonymous use of the directory services.
In this case, you should fill in the appropriate fields in the administration panel (e.g. "manager" and "mypassword") and Dokeos will try to authenticate using these, or fall back to anonymous mode before giving up.

LDAP import into sessions

There is a new set of scripts now that allow you to insert users from LDAP directly into a Dokeos session. This, however, relies on a set of static choices in the LDAP contact attributes.
The fields used intensively by the Dokeos module are:

7. Oogie Rapid learning

Powerpoint conversion is available in Dokeos PRO. This feature will convert your slides into SCORM compliant courses and allow audio record on top of slides + adding quizzes in between the slides. 

7.2. Audio-recorder

Audio recording is available in Dokeos PRO and managed externally and audio is uploaded through MP3 format files

8. Videoconferencing

Videoconferencing is available in Dokeos PRO.

9. Mathematics

This part is optional, only organisations wanting to use mathematical formulas inside the online editor might want to read this.
You can enable mathematical equations writing inside the Dokeos online editor (FCKEditor) by applying the following steps: Adding the corresponding cgi-bin directory to your Apache configuration could be done, in Apache 2, like this:
ScriptAlias /cgi-bin/ /var/www/cgi-bin/
<Directory "/var/www/cgi-bin">
  AllowOverride None
  Options ExecCGI -MultiViews +SymLinksIfOwnerMatch
  Order allow,deny
  Allow from all
</Directory>
Adding a symbolic link can be done, under Windows, by creating a shortcut to the mimetex.exe file from the cgi-bin directory, or under Linux by issuing the following command:
ln -s /var/www/dokeos/main/inc/lib/mimetex/mimetex.cgi /var/www/cgi-bin/mimetex.cgi/div> This procedure should make a new icon available in your Dokeos online editor, which will make it possible to insert mathematical formulas into your documents.

10. Multisite

With Dokeos PRO you can run same portal under multiple URLs. This is a typical use for a Corporate company with various Business Objects, Training company with various clients or University with various departments.

11. Contact

if you are interested in our products, please contact us in our contact page, click here