From bb7ae0faa4c54a938fc558d7c3323fb9d4b1838d Mon Sep 17 00:00:00 2001 From: Julio Montoya Date: Mon, 17 Jun 2013 13:59:00 +0200 Subject: [PATCH] Updating installation guide --- documentation/installation_guide.html | 153 ++++++++++++-------------- 1 file changed, 72 insertions(+), 81 deletions(-) diff --git a/documentation/installation_guide.html b/documentation/installation_guide.html index 23da18f1ec..33712aa5f5 100644 --- a/documentation/installation_guide.html +++ b/documentation/installation_guide.html @@ -7,7 +7,6 @@ -
@@ -23,17 +22,17 @@ +
- + -
+

Chamilo - Installation Guide

Thank you for downloading Chamilo

@@ -44,9 +43,7 @@

Contents

-
    -
  1. Pre-requisites
  2. Installation of Chamilo LMS
  3. Upgrade from a previous version of Chamilo/Dok€os
    4. @@ -102,9 +99,9 @@ For instance, on a Ubuntu server, use Shell or Synaptic following the

    MySQL or MariaDB database server

    -You will need a login and password allowing to manage and create +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 +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.
    @@ -142,15 +139,13 @@ On the RewriteBase line, where it normally says "/", change it to whatever subdi values. Consider changing the admin password to remember it. 

-The following directories need to be readable, writeable and executable by your web server. +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):
    -
  • [chamilo]/main/inc/conf/
    • -
  • [chamilo]/main/upload/users/
    • -
  • [chamilo]/main/default_course_document/images/
    • -
  • [chamilo]/archive/
    • -
  • [chamilo]/courses/
    • -
  • [chamilo]/home/
    • +
  • [chamilo]/config/
    • +
  • [chamilo]/data/
    • +
  • [chamilo]/temp/
    • +
  • [chamilo]/logs/
Optionally, you can do the same to the following directories if you want to enable CSS styles package upload and sub-language definition: @@ -158,15 +153,15 @@ enable CSS styles package upload and sub-language definition:
  • [chamilo]/main/css/
  • [chamilo]/main/lang/
    • -Since 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: +Since 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 searchdb directory:
      -
    • [chamilo]/searchdb
      • -
    -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. +
  • [chamilo]/data/searchdb
    • + +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 @@ -177,7 +172,7 @@ right-clicking on them).

    The following directory needs to be readable and writeable for the web browser only during the installation process:

      -
    • chamilo/main/inc/conf/ (if present)
      • +
    • chamilo/config/ (if present)

    On Linux, Mac OS X and BSD operating systems you can use the chmod @@ -192,40 +187,36 @@ folders (by right-clicking on them).

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

    -

    Windows : with all-in-one packages +

    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

    -
      -
    • Protect your configuration directory: -make sure no one (but you) can overwrite it. You can find the config directory in +make sure no one (but you) can overwrite it. You can find the config directory in (chamilo folder)/main/inc/conf. Make it read-only (windows/xwindows: right-click the file to edit the properties. linux/bsd/macosx: use the chmod 0555 command). The config -file is created by your web server (Apache + PHP, usually) so you may +file is created by your web server (Apache + PHP, usually) so you may need to be root user to change its permissions.
    • Protect your installation folder: if the (chamilo folder)/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, -delete it completely or edit its properties so no one can read or +out of the web directories so it is not accessible, change its name, +delete it completely or edit its properties so no one can read or execute it.
    • For better security: making the files world-writeable will help you install, and it solves many issues for people without much admin experience. However, it's more -secure to make a distinct user owner of all the chamilo files and folders, -and only give read access to the web server to all files, and write access -only to the directories previously mentioned. This way, these files need -only be readable and writeable by the Apache process owner, not by the +secure to make a distinct user owner of all the chamilo files and folders, +and only give read access to the web server to all files, and write access +only to the directories previously mentioned. This way, these files need +only be readable and writeable by the Apache process owner, not by the entire world. It would also be adviseable to make all writeable directory refuse the interpretation of PHP files (except for the root of the courses directories). Don't hesitate to hire an experienced administrator to do that, @@ -238,7 +229,7 @@ in the administration section of Chamilo, you can use the Chamilo Configuration
    • Configure Chamilo mail: most of Chamilo uses the mail settings from the php.ini file. However, if you use a distinct e-mail server, you might need to adjust the -e-mail setting in (chamilo folder)/main/inc/conf/mail.conf.php.
      • +e-mail setting in (chamilo folder)/config/mail.conf.php.
    • Check our new security guide for more
    @@ -253,21 +244,21 @@ To get the best out of Chamilo, you need to finetune your PHP settings. Consider
      -
    • Editing php.ini file (on windows can be located at - C:\xampp\php\php.ini, - on Ubuntu Linux : +
    • Editing php.ini file (on windows can be located at + C:\xampp\php\php.ini, + on Ubuntu Linux : /etc/php5/apache2/php.ini
    • search the word "_max" and increase the two values to optimise the server
    • we recommend the following values :
    -
    - 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
    -
    +
    +    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:

    @@ -281,12 +272,12 @@ 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. +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 +

    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 +For example, if your server is in the 'America/New_York' timezone, set this in your php.ini:

    @@ -323,7 +314,7 @@ date.timezone = 'America/New_York'
    -

    3. Upgrade from a +

    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 @@ -336,9 +327,9 @@ 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: This version of Chamilo can only be used to upgrade from -smaller 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. If you need this, +
    NOTE: This version of Chamilo can only be used to upgrade from +smaller 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. If you need this, please contact one of the Chamilo Association's official providers )

    @@ -377,12 +368,12 @@ As this is only a minor version change from previous 1.9.* versions of Chamilo,
  • point your browser on your portal URL + main/install/
  • choose your language and click Upgrade from 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). +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 +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. +you get the best our of your Chamilo migration.
    * Styles and images are located in the main/css or main/img @@ -553,7 +544,7 @@ 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 +

    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.

    @@ -683,8 +674,8 @@ Here is an example:   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:

    @@ -696,22 +687,22 @@ Here is an example: - +
  • 5. Make sure that the file mimetex.cgi (or mimetex.exe) has right to be executed by the web-server process. For example, on a Ubuntu Linux system you may write a command like the following:
    sudo chmod a+x mimetex.cgi
  • 6. Make sure that the file mimetex.cgi (or mimetex.exe) has been uploaded in BINARY format. - - This is another common problem; the fix is just to re-upload the file in ASCII format. + + This is another common problem; the fix is just to re-upload the file in ASCII format. You'll need to consult your FTP program's documentation to figure out how to switch modes. - BINARY mode is used for non-text items, such as executables (*.exe), zip files (*.zip), image files (*.jpg, *.gif) and the like. + BINARY mode is used for non-text items, such as executables (*.exe), zip files (*.zip), image files (*.jpg, *.gif) and the like. ASCII mode needs to be used for text only documents, which includes *.txt, *.cgi, *.pl *.css, *.html, etc.
    - You can also try to re upload the mimetex file using the "Upload file" in the "Filemanager" tool in CPanel/Plesk + You can also try to re upload the mimetex file using the "Upload file" in the "Filemanager" tool in CPanel/Plesk
    • - +

    As a result of this procedure, a new button becomes available in your Chamilo online editor, that gives you possibility @@ -782,11 +773,11 @@ 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 +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 Administrators training (which you can ask any Chamilo's Official +Chamilo Administrators training (which you can ask any Chamilo's Official Provider for) include a full review of the full-text search feature.

    @@ -806,23 +797,23 @@ Then go to your administration page -> Chamilo Rapid and set the host

    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 +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 +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 +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 +Make sure you have a look into run.php as maybe you want to change a few settings there.