Open eClass Documentation
You are here: start » en » upgrade

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
en:upgrade [2019/04/03 16:37] – [3. Successfully Upgrade Check] adminen:upgrade [Unknown date] (current) – external edit (Unknown date) 127.0.0.1
Line 1: Line 1:
 ===== Upgrade Guide ===== ===== Upgrade Guide =====
-Open eClass 3.7+Open eClass 3.14
  
 The new version of Open eClass retains backward compatibility (with previous versions). That is, you can upgrade an already installed platform from prior versions to the current one easily and quickly, following the upgrade instructions provided below.  The new version of Open eClass retains backward compatibility (with previous versions). That is, you can upgrade an already installed platform from prior versions to the current one easily and quickly, following the upgrade instructions provided below. 
  
-  * Please ensure that during the platform's upgrade process there is no access to Open eClass courses by the platform's users and the platform's database is not accessible by anyone +<html><div class='admonition caution'> 
-  * Backup platform's database. +<p>Please ensure that during the platform's upgrade process there is no access to Open eClass courses by the platform's users and the platform's database is not accessible by anyone.</p> 
-  * Also check the platform's version that is already installed in your server, by following the link 'Platform Identity' in the home page. In order to the upgrade process (which is described below) to be possible, the already installed platform should be either version >= 3.x. +</div> 
-  * Keep in mind that there is no support for upgrading from versions 2.x+</html> 
 + 
 +<html><div class='admonition caution'> 
 +<p>Also check the platform's version that is already installed in your server, by following the link 'Platform Identity' in the home page. In order to the upgrade process (which is described below) to be possible, the already installed platform should be either version >= 3.0.</p> 
 +</div> 
 +</html> 
 + 
  
  
 ---- ----
  
-===== 1. Upgrade platform's software =====+==== 1. Upgrade platform's software ====
  
-==== 1.1 Unix / Linux Systems ==== +==== 1.1 Linux Systems ==== 
-(e.g. Solaris, Redhat, CentOS, Debian, Suse, Ubuntu etc)+(e.g. Redhat, CentOS, Debian, Suse, Ubuntu etc)
  
 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''. 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 changes introduced by the new version (3.7) 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:+Due to changes introduced by the new version 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-3.7.tar.gz on the /tmp directory.+We consider that you have downloaded ''openeclass-3.14.tar.gz'' on the /tmp directory.
  
 Go to the directory you have installed in eClass. e.g. Go to the directory you have installed in eClass. e.g.
Line 36: Line 43:
   rm -rf images/ include/ info/ install/ manuals/ template/ modules/    rm -rf images/ include/ info/ install/ manuals/ template/ modules/ 
  
-Unzip and untar openeclass-3.7.tar.gz in a temporary directory (/tmp) e.g.+Unzip and untar ''openeclass-3.14.tar.gz'' in a temporary directory (/tmp) e.g.
  
-  tar xzvf /tmp/openeclass-3.7.tar.gz+  tar xzvf /tmp/openeclass-3.14.tar.gz
  
-Then copy from the temporary directory /tmp/openeclass-3.7 all of its contents in the installation directory e.g.+Then copy from the temporary directory /tmp/openeclass-3.14 all of its contents in the installation directory e.g.
  
-  cp -a /tmp/openeclass-3.7/*  /var/www/html/eclass/+  cp -a /tmp/openeclass-3.14/*  /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. So with the above steps you have replaced directory eclass, with the new one. Then move file config.php to directory config. e.g.
Line 55: Line 62:
   find ./ -type d -exec chmod 775 {} \;   find ./ -type d -exec chmod 775 {} \;
  
-Having completed the previous steps, you will have installed the new eClass version (eClass 3.7) files successfully. Then, move on to the second step in order to upgrade the platform databases.+Having completed the previous steps, you will have installed the new eClass version files successfully. Then, move on to the second step in order to upgrade the platform databases. 
 ==== 1.2 MS Windows Systems ==== ==== 1.2 MS Windows Systems ====
  
-The following example assumes that eClass has already been installed to directory ''C:\Program Files\Apache\htdocs\'' and that you have downloaded openeclass-3.7.zip.+The following example assumes that eClass has already been installed to directory ''C:\Program Files\Apache\htdocs\'' and that you have downloaded ''openeclass-3.14.zip''
  
  
-Due to changes introduced by the new version (3.7) 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:+Due to changes introduced by the new version 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 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\'').   * 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''.   * Go to the eclass folder (e.g. ''C:\Program Files\Apache\htdocs\eclass\'') and delete all folders except ''courses'', ''video'' and ''config''.
-  * Unzip openeclass-3.7.zip to a temporary folder on the desktop. e.g. ''C:\Documents and Settings\Administrator\Desktop\eclass37''. After that, rename the temporary folder ''eclass37'' 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.+  * Unzip openeclass-3.14.zip to a temporary folder on the desktop. e.g. ''C:\Documents and Settings\Administrator\Desktop\eclass314''. After that, rename the temporary folder ''eclass314'' 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.   * Delete the desktop temporary folder.
  
-As soon as the above have been completed, you will have installed the new eClass version files (eClass 3.7) successfully. Then, follow the second step so as to upgrade the platform database.  +As soon as the above have been completed, you will have installed the new eClass version files successfully. Then, follow the second step so as to upgrade the platform database. 
-===== 2. Database Upgrade =====+
  
-  For Unix/Linux systems only:  +==== 2. Database Upgrade ====
-  The process of platform database upgrade includes changes to config.php.  +
-  As a result, you will temporarily need to change your access rights  +
-  on the config.php file and the /config directory to read-write (chmod 664). +
      
 Enter the following URL on your browser: Enter the following URL on your browser:
Line 84: Line 88:
 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. 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). +If you face any problems with any course after the upgrade, contact us (mailto:''info@openeclass.org'').
-===== 3. Successfully 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 3.7 has to be indicated. You can alternatively click on the "Platform Identity" link on the homepage. Version 3.7 of the platform will be indicated.+==== 3. Successfully 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 //3.14// has to be indicated. You can alternatively click on the "Platform Identity" link on the homepage. Version //3.14// of the platform will be indicated.
  
 You are ready! The upgrade process has been completed successfully. You are ready! The upgrade process has been completed successfully.
  
 Keep on reading for further additional configuration options! Keep on reading for further additional configuration options!
-===== 4. Optional Further Configuration =====+ 
 +==== 4. Optional Further Configuration ====
  
 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: 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:
Line 103: Line 109:
 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 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. +  *   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. +
- +
-You can configure several options of platform. After logging as admin user, click in "Admin Tools" and after that, click in "Configuration". Among other, you can select another theme of creating a new one, the available languages (e.g. greek, german, italian) etc.+
  
-By default platform supports uploading of all the usual text, audio, video and image file types. If you desire to add a new file type, type its extension in 'Teacher while list' or 'Student while list' textarea correspondingly. +  *    You can configure several options of platform. After logging as admin user, click in "Admin Tools" and after that, click in "Configuration". Among other, you can select another theme of creating a new one, the available languages (e.g. greek, german, italian) etc.
  
 +  *    By default platform supports uploading of all the usual text, audio, video and image file types. If you desire to add a new file type, type its extension in 'Teacher while list' or 'Student while list' textarea correspondingly.  
Open eClass Documentation

Table of Contents