Upgrade Instructions for Open eClass 2.4

The new version of Open eClass (2.4) retains backward compatibility (with previous versions). For that reason, you can upgrade an already installed platform from prior versions to the current 2.4 easily and quickly, following the upgrade instructions provided below. Keeping a safety record of the course contents and the database before beginning to upgrade is recommended.

Then, follow the steps below.

1st Step
• For Unix / Linux computers (e.g. Solaris, Redhat, CentOS, Debian, Suse, Ubuntu etc)
• For Ms Windows computers (Windows2000, WindowsXP, Windows2003, Windows Vista, Windows 7, Windows2008)

2nd Step

• Database Upgrade

3rd Step

• Successful Upgrade Check

4th Step

• Optional Further Configuration

Upgrading from previous versions (<=0)

1st Step: Upgrading in Unix / Linux computers

All operations presuppose you have the administrator's rights (root) on your computer. The following example presumes that the eClass platform is already installed on directory /var/www/html.

Due to some changes introduced by the new version (2.4) you will have to delete the old and install the new one. To make sure that you old configuration remain intact you must do the following actions:

We consider that you have downloaded openeclass-2.4.tar.gz on the /tmp directory.

• Go to the directory you have installed in eClass. e.g.

  cd /var/www/html

• Move the configuration file (eclass/config/config.php) in another temporary directory (e.g. to directory /tmp)

  mv /var/www/html/eclass/config/config.php /tmp

• Delete all the directories except courses and config e.g.

  cd /var/www/html/eclass/
  rm -rf images/ include/ info/ install/ manuals/ template/ modules/ 

• Unzip and untar openeclass-2.4.tar.gz in a temporary directory (/tmp) e.g.

  tar xzvf /tmp/openeclass-2.4.tar.gz

  Then copy from the temporary directory /tmp/openeclass-2.4 all of its contents in the installation directory e.g.

  cp -a /tmp/openeclass-2.4/*  /var/www/html/eclass/

  So with the above steps you have replaced directory eclass, with the new one.
• Then move file config.php to directory config. e.g.

  mv /tmp/config.php /var/www/html/eclass/config/

• Correct (if necessary) the files and sub-directories permissions: (supposing that the apache is running as user www-data)

  cd /opt/eclass
  chown -R www-data *
  find ./ -type f -exec chmod 664 {} \;
  find ./ -type d -exec chmod 775 {} \;
  

Having completed the previous steps, you will have installed the new eClass version (eClass 2.4) files successfully. Then, move on to the second step in order to upgrade the platform databases.

1st Step: Upgrading in Ms Windows Computers

The following example presupposes that eClass has already been installed to directory C:\Program Files\Apache\htdocs\ and that you have downloaded openeclass-2.4.zip.

Due to several changes included by the new version (2.4) you will have to delete the old and install the new one. To make sure that you old configuration remain intact you must do the following actions:

• Move to the eClass installed folder. e.g.C:\Program Files\Apache\htdocs
• Move the configuration file (C:\Program Files\Apache\htdocs\eclass\config\config.php) into another temporary folder in your desktop (e.g. from C:\Program Files\Apache\htdocs\eclass\config\ to C:\Documents and Settings\Administrator\Desktop\).
• Go to the eclass folder (e.g.C:\Program Files\Apache\htdocs\eclass\) and delete all folders except courses, video and config.
• Unzip openeclass-2.4.zip to a temporary folder on the desktop. e.g. C:\Documents and Settings\Administrator\Desktop\eclass17 After that rename the temporary folder eclass21 to eclass and copy it along with its contents (files and documents). Then, open the file that includes eClass installation, e.g. C:\Program Files\Apache\htdocs\ and paste it. In that way, the eclass files is replaced by the new ones.
• Delete the desktop temporary folder.

As soon as the above have been completed, you will have installed the new eClass version files (eClass 2.3) successfully. Then, follow the second step so as to upgrade the platform database.

2nd Step: Database Upgrade

Enter the following URL on your browser:

http://(url of eclass)/upgrade/

You will be prompted for the username and password of the platform administrator. After providing them, you will be asked to change/correct contact details, as well as students' registration mode on the platform (free or applied registration). The database upgrade will begin afterwards. You will see several messages concerning your working progress. Probably you will not see any false messages. Note that depending on the number and content of courses, it is possible that the process will last for a long time.

In the opposite case (namely if error messages occur), then it is possible for a course not to be operating properly. Such error messages may occur if you have altered the structure of an eclass database table. Note (if possible) the accurate error message you saw.

If you face any problems with any course after the upgrade, contact us (mailto:info@openeclass.org).

3rd Step: Successful Upgrade Check

In order to make sure that the platform has been upgraded, login as administrator and click to "Admin tools". Among other things, version 2.4 has to be indicated. You can alternatively click on the "Platform Identity" link on the homepage. Version 2.4 of the platform will be indicated.

You are ready! The upgrade process has been completed successfully.

If you want to see the new features of the new version, go to CHANGES.txt text file. Read forward for further additional configuration options.

4th Step: Optional Further Configurations

• In the config.php file, the close_user_registration variable, which is FALSE by definition, will be defined. Changing the value to TRUE, registration of users with 'student' rights will not be free anymore. Users will have to follow a process similar to the teacher account creation process, namely filling in a student account application form, in order to obtain a platform account. The application will be examined by the administrator who either approves of it and opens an account, or rejects it.

• If you want to modify any message of platform then proceed with the following actions: Create a file of type .php with name english.inc.php (or greek.inc.php) and place it in directory (eclass path)/config/. Find the varible name which contains the message you wish to change and assing it the new message. e.g. If you want to change message $langAboutText = "The platform version is"; create the file english.inc.php in the directory (eclass path)/config/ with the following contents:

  <?php
  $langAboutText = "Version is";
  

  This way, you will preserve custom messages in future upgrades of the platform.

  You can modify the names of the basic roles of the users of the platform by redefining in these files the message variables found in (eClass_path)/modules/lang/greek/common.inc.php.

  You can add text (e.g. information, links, etc.) to the left and right sidebars of the platform homepage by assigning the variables $langExtrasLeft and $langExtrasRight respectively.

• Open eClass supports mathematical symbols in the Exercises, Forums and Announcements subsystems. In Exercises you can add math symbols in the "Exercise Description" field when creating or modyfying a new exercise, and in "Comment" when adding or modifying a question, in Forums when you compose a new message or reply to an existing one, and in Announcements when a new announcement is created. Math symbols must be enclosed in [m] and [/m] tags. E.g. when you type

  [m]sqrt{x-1}[/m]
  

  the square root of x-1 will appear. Mathematical symbols syntax can be found in the PhpMathPublisher help file. Older versions used the <m> and </m> which are still supported, although using the newer tags in brackets is recommended.
• To use the platform with a web server with SSL support (e.g. https://eclass.gunet.gr), you define the urlSecure variable in config.php. For example: $urlSecure = "https://eclass.gunet.gr"

• The default theme of platform is 'classic'. You can change it later from the admin tool to 'modern'. Note the change will be visible to users after next login to platform.

During installation of eClass table config is created. Each row of table is a (optional) setting of platform. Installation program asks for these settings. If you don't know what to do, leave it as they are. All of them have a default value. You can change them later in via the admin tool. These settings are:

• email_required: During user registration, email is required.
• am_required: During user registration student ID is required.
• dropbox_allow_student_to_student: In dropbox module, users can send files to each other.
• dont_display_login_form: Login form will not be visible in home page. A link to it, will be appeared.
• block_username_change: Users will not be able to change their usernames.
• display_captcha: Display a `captcha` code during users registration.
• insert_xml_metadata: Allow teachers to upload metadata in files in 'Documents'.

By default none of them is enabled.

• doc_quota: Defines the default quota in 'Documents'.
• video_quota: Defines the default quota in 'Video'.
• dropbox_quota: Defines the default quota in 'Dropbox'.
• group_quota: Defines the default quota in 'Groups'.

Note that, administrator can modify these settings per course from the admin tool.

Further information for these actions can be found in the Administrator's manual (linked from the platform Admin Tool).

Upgrading from older versions (<= 2.0)

• If platform version is <= 1.7 then you have to first upgrade it to version 1.7 following the instructions here and then upgrade it to version 2.0.
• If platform version is 1.7 then you have to upgrade id first in version 2.0 following the instructions here.