Chamilo - Documentation

Chamilo - Installation Guide

Thank you for downloading Chamilo

This guide explains how to install Chamilo FREE. Please read this fully before proceeding with the installation.

Spanish: También puede leer esta guía de instalación en español.

French: Vous pouvez aussi lire ce guide d'installation en français.

Italian: You can also read this guide in Italian.

Contents

  1. Pre-requisites
  2. Installation of Chamilo LMS
  3. Upgrade from a previous version of Chamilo/Dok€os
  4. Troubleshooting
  5. Administration section
  6. LDAP 
  7. Mathematical formulas with LaTeX
  8. Mathematical formulas with ASCIIMathML
  9. Mathematical formulas with WIRIS
  10. Full-text indexation with Xapian
  11. Chamilo Rapid - PPT conversion system
  12. Setting chronological tasks
  13. Changing the language's firstname/lastname order
  14. Improving files download time

1. Pre-requisites

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

Chamilo is mainly a LMS running Apache (2.2 recommended), MySQL 5.1 or 5.5 (or MariaDB) and PHP 5.3, 5.4 or 5.5 (5.5 recommended for greater efficiency) (the so called AMP trilogy).

All these pieces of software are free software and freely available.

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

MySQL or MariaDB database server

You will need a login and password allowing to manage and create a database. Usually, the default configuration on local computers is to allow you to connect as root with an empty password. It is HIGHLY RECOMMENDED to change the password and define a user with access to only a specific database. Please refer to the MySQL or MariaDB documentation in order to do this.
Note that this has been greatly simplified since version 1.9, as it previously required to choose between multiple databases and a deprecated single-database mode.

2. Installation of Chamilo LMS

  1. Download Chamilo LMS
  2. Unzip it
  3. Copy the Chamilo directory in your Apache web directory. This can be C:\xampp\htdocs\ on a Windows server or /var/www/html/ (or /var/www/chamilo/) on a Linux server
  4. Open your web browser (Internet Explorer, Firefox...) and type http://localhost/chamilo/ if you install locally or http://www.domain.com/chamilo/ if you install remotely. We recommend defining a specific Virtual Host for this installation if you have the skills to do so
  5. Follow the web installation process. You can accept all default values. Consider changing the admin password to remember it. 

Note: if installing Chamilo locally using localhost or the IP address of your computer during the installation, you might get issues while accessing from another computer. To avoid this, you can apply a little change to your configuration file.
The following directories need to be readable, writeable and executable by your web server. This usually requires no specific action on Windows servers, but will require a "chmod" under Linux and Mac. See instructions below.
Replace [chamilo] with the directory where your Chamilo installation is located): Optionally, you can do the same to the following directories if you want to enable CSS styles package upload and sub-language definition: Starting from Chamilo 1.8.8, you can also enable full-text indexing features which require the php5-xapian PHP's extension module to be installed. If you do use it, you will need to allow your system to write into the sarchdb directory: If you find a tests/ directory at the root of your package, please delete it. This is a development directory that has not been checked for security issues, an it should *never* be accessible to final users on a production server.

On Linux, Mac OS X and BSD operating systems you can use the chmod 0775 command for this (although we recommend you seek advice from an experienced system administrator to avoid security issues). On Windows, you may need to check the properties of the folders (by right-clicking on them).

The following directory needs 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 Chamilo administration section.

Windows : with all-in-one packages like XAMPP, you can install Chamilo easily. In this case (and unless you use it in production), the login and password for MySQL will probably remain empty.

Configuration and security after installation


PHP configuration

To get the best out of Chamilo, you need to finetune your 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 = 256M ;Maximum amount of memory a script may consume (128MB)
post_max_size = 100M
upload_max_filesize = 100M

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

Past Chamilo versions required register_globals to be set to On. This is no longer necessary, this can (and should) be set to Off. It is considered a bad choice in terms of security to set register_globals to On.

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/New_York' timezone, set this in your php.ini:

date.timezone = 'America/New_York'

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 or very long learning paths (many items), 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 of Chamilo LMS (1.*) or Dok€os (<2.0)

Before upgrading, we heavily recommend you do a full backup of the previous Chamilo or Dok€os directories and databases. If you are unsure how to achieve this please ask your hosting provider for advice.
Chamilo LMS 1.10 comes with a new database structure in comparison to 1.9, and so between 1.9 and 1.8. Although the upgrade script takes the migration in charge, it might be generating a very heavy load on your server during the upgrade, and will change your database completely, preserving the data as well as possible (we have tested the procedure many times, but remember this is GNU/GPLv3 and we cannot be held responsible for what would happen to your data without professional supervision). This is why we *really* recommend you take a full backup of your system before you upgrade.
NOTE: For very heavy Chamilo databases, some of our official providers have developed improved migration procedures that use more memory but process the upgrades up to 20 times faster. If this is the kind of thing you need, we highly recommend you contact them (see reference below).
NOTE: This version of Chamilo can only be used to upgrade from earlier versions of Chamilo or Dok€os. For example, you cannot use the normal upgrade scripts from Chamilo 1.9 to upgrade from Dok€os 2.0 (which was born after the split with Chamilo). If you need this, please contact one of the Chamilo Association's official providers)

3.1 Upgrading from Chamilo 1.10.x (minor upgrade)

As this is only a minor version change from previous 1.10.* versions of Chamilo, the only thing you need to do is:

3.2 Upgrading from Chamilo 1.8.x or 1.9.x


3.3 Upgrading from Dok€os 1.8.x

If you upgrade from Dok€os 1.8.x :  A bunch of Chamilo administrators have reported minor issues with the migration between versions considerably apart (like from Dok€os to Chamilo). This might include loosing some assignments or forum posts. To avoid any ugly effect on your users, we recommend you first establish a checklist of all the content that is critical to you, and that you keep a working copy of your previous site on the side. This way, it will be easier to manage the transition by letting your users get access to their contents from the previous site and making it easier for you to compare the two. If you are experiencing difficulties, consider asking for help from a PHP developer or hiring an official Chamilo provider. They will make sure you get the best our of your Chamilo migration.
* 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 Dok€os 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.4 Upgrading from Dok€os 1.6.x

If you upgrade from a lower version of Dok€os (1.6.x), the first and most important thing to do is to *move* your current directory to another place.
An easy way to do that is to create a subdirectory called "old_version" in your current Chamilo/Dok€os 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 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

WARNING:
Do not delete the previous Chamilo/Dok€os installation directory before installing the new one. When the update is successfully finished, you can remove the old path.

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

3.5 In both last 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 0777 command, but if you are unsure, we recommend you seek advice for your own OS on our forum. In Windows, you may need to check the properties of the folders.

3.6 Quick-upgrade from 1.9.x guide for Linux

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

4. Troubleshooting

If you have problems, go to the Chamilo website and ask a question on the support forum. Please read the previous messages first to see if there is already an answer to your question.

5. Administration section

To access the Chamilo administration section, open browser, go to your Chamilo 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 Chamilo, 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 Chamilo

Note: The LDAP mechanism has been changed in 1.9. As a result, some of the following information might not be correct. Please check the configuration settings inside Chamilo to learn the details.

In [Chamilo folder]/main/inc/conf/configuration.conf.php, around line 93, you'll find settings like the following:
// -> Uncomment the two lines below to activate LDAP AND edit main/inc/conf/auth.conf.php for configuration
// $extAuthSource["extldap"]["login"] = $_configuration['root_sys'].$_configuration['code_append']."auth/external_login/login.ldap.php";
// $extAuthSource["extldap"]["newUser"] = $_configuration['root_sys'].$_configuration['code_append']."auth/external_login/newUser.ldap.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 "Chamilo 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, Chamilo will check if the "employeenumber" field has a value. If it has, then Chamilo 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 Chamilo 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 Chamilo session. This, however, relies on a set of static choices in the LDAP contact attributes.
The fields used intensively by the Chamlio module are:

7. Mathematical formulas with LaTeX

This part is optional, only organisations planning to use mathematical formulas inside the online editor might want to read this.

You can enable mathematical equations writing inside the Chamilo online editor (FCKEditor) by applying the following steps:

As a result of this procedure, a new button becomes available in your Chamilo online editor, that gives you possibility to insert mathematical formulas into your documents.

8. Mathematical formulas with ASCIIMathML

Mathematical formulas may be rendered on web-pages using the script ASCIIMathML.js (a customized version for Chamilo). For more information about this script and about the ASCIIMath formula syntax see http://www1.chapman.edu/~jipsen/mathml/asciimath.html and http://dlippman.imathas.com/asciimathtex/AMT.html.

For writing ASCIIMath formulas in documents, a correspondent plugin for the online editor should be activated. For doing this, see the platform administration section and open the page "Administration > Configuration settings > Editor". Enable the setting "ASCIIMathML mathematical editor".

Inside documents, the script ASCIIMathML.js renders mathematical formulas in two altrnative ways:

For providing image-based fallback in a production system, you should pick up and install on your server software for TeX rendering, such as:

As an alternative, you may try to use some public services for TeX rendering, such as:

Open with a text editor the file .../chamilo/main/inc/lib/asciimath/ASCIIMathML.js. Find somewhere at the beginning the line that initializes the variable AMTcgiloc. You may need to alter the setting to be for example:

For testing how the variable AMTcgiloc may be set, there are some examples (as comments) inside the script.

9. Mathematical formulas with WIRIS

Installing this plugin you get WIRIS editor and WIRIS CAS.
This activation will not be completed unless you have previously downloaded the PHP plugin for FCKeditor WIRIS and unzipped its contents into the main/inc/lib/fckeditor/editor/plugins/fckeditor_wiris/ directory.
This is necessary because Wiris is proprietary software and its services are commercial. To make adjustments to the plugin, edit configuration.ini file or replace his content by configuration.ini.default Chamilo file.

Full-text indexation with Xapian

Note: This step will require a dedicated server or a virtual dedicated server as the packages involved are not available on most shared hosting solutions.
On Debian or Ubuntu 10.04 and superior, you will simply need to install the php5-xapian package and restart your web server: 

sudo apt-get install php5-xapian
sudo /etc/init.d/apache2 restart
Then go to your administration page -> Configuration settings -> Search and enable the search tool. Follow the recommendations on the page to get the complete indexing suite installed. Once you're done, all documents you import into your Chamilo portal in a recognized format will be indexed and searchable. Chamilo intermediate Administrators training (which you can ask any Chamilo's Official Provider for) include a full review of the full-text search feature.

Note: Xapian's licensing for the PHP extension is a bit different than what is necessary to enter the Debian repositories, so it has been excluded. You can, however, generate your own package by following the packaging instructions on Xapian's wiki.

Chamilo Rapid - PPT conversion system

Note: This step will require a dedicated server or a virtual dedicated server as the packages involved are not available on most shared hosting solutions.
On Debian or Ubuntu 11.10 and superior, install LibreOffice v3 (or v4) and start it as a headless server: 

sudo apt-get install libreoffice screen
sudo screen
su - www-data
soffice --accept="socket,host=127.0.0.1,port=2002,tcpNoDelay=1;urp;" --headless --nodefault --nofirststartwizard --nolockcheck --nologo --norestore
CTRL+a, CTRL+d
Please note that this will effectively launch LibreOffice in a "headless" mode (thanks to the --headless option), in a "headless" terminal (thanks to screen). You can later get back into your "headless" terminal by launching: 
sudo screen -r
You can then go to your administration page -> Chamilo Rapid and set the host to "localhost" and the port to "2002". Save. Go to your course, learning path tool and see the new icon appeared. Import your PPT. This should work. Note: Sometimes, this doesn't work out so easily. You can probably ask for the assistance of any system administrator around with a bit of Java and PHP experience, or you can always ask one of the Chamilo's Official Providers for assistance (ask for a guaranteed commercial contract). The above is *not* meant for production servers with a high load. You should get a real system administrator to look at it and develop init scripts, in a way that makes monitoring and relaunching feasable. If any sysadmin wants to contribute this, feel free to contribute it to Chamilo: send us an e-mail at info@chamilo.org. Note: If you use LibreOffice 4, please note that version 4.2 (available in Ubuntu 14.04) has demonstrated to be more successfull at converting documents than version 4.1, which tended to crash when sending a document for conversion.

Setting chronological tasks

Since Chamilo 1.8.8, a few tasks need to be executed regularly in order to get the best out of your server resources. One of such tasks (and the only one around at the time of Chamilo 1.8.8) is the sending of internal messaging notifications by e-mail, i.e. when you receive an e-mail from another person or from a group inside the internal messaging system of Chamilo, if all e-mails are sent immediately, then you might not have the chance to receive them at your pace, once a day or even once a week. For cases like this you, as a Chamilo administrator, should setup a cron process on the server to check the queue of e-mails and send is timely.

Setting up a cron task is easy and there are several ways to do it. We recommend you have a look at the Drupal documentation for setting up cron and define your own cron process as: 

35 * * * * wget -O - -q -t 1 http://campus.example.com/main/cron/run.php
Make sure you have a look into run.php as maybe you want to change a few settings there.

Changing the language's firstname/lastname order

As Chamilo becomes more popular and crosses many borders now, it frequently happens that administrators want to re-order the firstname and lastname fields in tables, and also on which field it is sorted first.

This can easily be modified by editing the main/inc/lib/internationalization_database/name_order_conventions.php file, finding your language and changing the fields. It is pretty self-explanatory and looks like this:

'simpl_chinese' => array( 'format' => 'title last_name first_name', 'sort_by' => 'last_name' ), // Eastern order

Feel free to change this to
'simpl_chinese' => array( 'format' => 'title first_name lastname', 'sort_by' => 'last_name' ), // Eastern order

for example. The effect should be immediate.

Improving files download efficiency

File download can be very slow when passing through a PHP script to control permissions. One solution to this is to use the X-Sendfile header, which depends on a module on the webserver. Check http://stackoverflow.com/a/3731639/1406662 for more details on implementing Sendfile. Chamilo LMS 1.9.8 (and following versions) supports the X-Sendfile headers, but requires a specific line of configuration to be added to configuration.php: 

$_configuration['enable_x_sendfile_headers'] = true;
If you have issues with files taking a long time to download, make sure you reconfigure your webserver and add this line. You should see an notable difference in download time.



Contact address
Mail: info@chamilo.org

Valid XHTML 1.0 Transitional Valid CSS