Upgrade Instructions Open eClass 2.3

Upgrade Instructions of Open eClass 2.3

The Upgrade Process

The new Open eClass version 2.3 retains backward compatibility (with previous versions). For that reason, you can upgrade an already installed platform from prior versions (1.7, 2.0, 2.1.x, 2.2) to the current 2.3 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.

WARNING!

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
Also check the platform's version that is already installed in your server, by following the link 'Platform's Information' in the home page. In order to the upgrade process to be possible the already installed platform should be either version >=1.7. For previous versions (1.5, 1.6) you need to upgrade first in 1.7 following the instructions at the last section of this manual 'Upgrade to Open eClass 2.2 from older versions 1.5, 1.6'.
Before the upgrade procedure please backup both the eCourses files and the platform's Database.

Then, follow the steps below.

1st Step
For Unix / Linux computers (e.g. Solaris, Redhat, CentOS, Deliian, Suse, Uliuntu etc)
For Ms Windows computers (Windows2000, WindowsXP, Windows2003, Windows Vista, Windows 2007)

2nd Step
Dataliase Upgrade

3rd Step
Successful Upgrade Check

Optional Further Configuration
Optional Further Configuration

Upgrading from previous versions (1.5, 1.6)
For Unix / Linux computers
For Ms Windows computers

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 included by the new (2.3) Open eClass 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-2.2.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
```
If you have courses in which you have used the Chat subsystem then move the appropriate chat files as well. These are found in the directory eclass/modules/chat/ with the form course_code.chat.txt e.g.
```
mv /var/www/html/eclass/modules/chat/*.txt /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/

Untar openeclass-2.3.tar.gz in a temporary directory (/tmp) e.g.
```
tar xzvf /tmp/openeclass-2.2.tar.gz
```
Then copy from the temporary directory /tmp/openeclass21 all of its contents in the installation directory e.g.
```
cp -a /tmp/openeclass22/*  /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/
```

Move to the original place the chat files. e.g.

mv /tmp/*.txt /var/www/html/eclass/modules/chat/

Correct (if necessary) the files and sub-directories permissions: (supposing that the apache is running as 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.3) 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.3.zip.

Due to several changes included by the new (2.3) Open eClass 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 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\).
If you have courses in which you have used subsystem 'Chat' then move the appropriate chat files as well. These are found in the folder C:\Program Files\Apache\htdocs\eclass\modules\chat\ in files of the form course_tt.chat.txt
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.3.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.
Move to the original place the chat files. e.g. in C:\Program Files\Apache\htdocs\eclass\modules\chat\
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

Before running the database upgrade script, make sure that MySQL is not operating in strict mode. In order to establish that, check if the parameter --sql-mode (in file my.cnf ή my.ini for UNIX / Windows correspondingly) has been set. If it is set (e.g. --sql-mode=STRICT_TRANS_TABLES or --sql-mode=STRICT_ALL_TABLES) then you need to modify it to null (--sql-mode="").

For Unix/Linux systems only: 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).

Then 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 your personal details, 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.3 has to be indicated. You can alternatively click on the "Platform Information" link on the homepage. Version 2.3 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 regulations (HTTPS, Latex etc).

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"

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

Upgrading from Older Versions (1.5, 1.6)

For upgrading from older versions 1.5, 1.6 you have to do some changes manually. Starting from the course directories is now stored in a new directory named courses. Also the configurations file location (config.php) has changed, and is now included in a new directory named config. So, in order not to lose your previous configuration and all your eCourses files, please follow the instructions below.

For Unix / Linux Computers

Go to the directory you have installed in eClass. e.g.
```
cd /var/www/html
```
Move the configuration file (eclass/claroline/include/config.php) in another temporary directory (e.g. to directory /tmp)
```
mv /var/www/html/eclass/claroline/include/config.php /tmp
```
If you have courses in which you have used subsystem 'Chat' then move the appropriate chat files as well. These are found in directory eclass/claroline/chat/ with the form course_code.chat.txt e.g.
```
mv /var/www/html/eclass/claroline/chat/*.txt /tmp
```
Delete the directory claroline with all its subdirectories. e.g.
```
cd /var/www/html/eclass/
rm -rf claroline/
```
Unzip eclass-1.7.3.tar.gz to a temporary directory (/tmp) e.g.
```
tar xzvf /tmp/eclass-1.7.3.tar.gz
	
```
Then from the directory /tmp/eclass17 copy all of its contents to the installation directory e.g..
```
cp -a  /tmp/eclass17/*  /var/www/html/eclass/
```
That way, the eclass directory is substituted by the new version.
Go the installation directory of eClass and make the following directories config και courses. e.g.
```
cd /var/www/html/eclass
mkdir config
mkdir courses
```
Move file config.php to directory config. π.χ.
```
mv /tmp/config.php /var/www/html/eclass/config/
```
Move the course directories in directory courses. (e.g. in case there are courses with codes TMA100, TMA101)
```
cd /var/www/html/eclass
	mv TMA* ./courses/
```
Restore the chat files to their initial position. e.g.
```
mv /tmp/*.txt /var/www/html/eclass/modules/chat/
```

Correct (if needed) the permissions of files and directories (e.g. if apache user is www-data)

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

For Ms Windows Computers

Go to eClass folder e.g. C:\Program Files\Apache\htdocs
Move configuration file C:\Program Files\Apache\htdocs\eclass\claroline\include\config.php to another temporary folder in your desktop e.g. from C:\Program Files\Apache\htdocs\eclass\claroline\include\ to folder C:\Documents and Settings\Administrator\Desktop\
If you have courses in which you have used the Chat subsystem, then move the appropriate chat files as well. These are found in C:\Program Files\Apache\htdocs\eclass\claroline\chat\ with names in the form course_code.chat.txt
Go to folder of eclass C:\Program Files\Apache\htdocs\eclass\ and delete folder claroline with all of its subdirectories.
Unzip eclass-1.7.3.zip to a temporary folder in your desktop. e.g. C:\Documents and Settings\Administrator\Desktop\eclass17. Then rename temporary folder eclass17 to eclass and copy with all of its subfolders. Then go to folder of eclass, e.g. C:\Program Files\Apache\htdocs\ and paste them. With that way eclass folder is replaced with the new version.
Go to folder of eClass and make two new folders config and courses.
Move config.php file, in newly created folder config e.g. C:\Program Files\Apache\htdocs\eclass\config\
Move courses directories to newly created folder courses e.g. C:\Program Files\Apache\htdocs\eclass\courses\
Restore previous chat files in its initial folder C:\Program Files\Apache\htdocs\eclass\modules\chat\
Finally delete from your desktop the temporary created folder.