ez-publish-community-project-2011-05

Upgrade Notes

Upgrading from eZ Publish Community Project 4.2011 to 2011.5

This section describes how to upgrade your existing eZ Publish Community Project 4.2011 installation to build 2011.5. Make sure that you have a working backup of the site before you do the actual upgrade, and make sure the installation you are performing the upgrade on is offline.

Important upgrade notes:

The procedure for upgrading directly from eZ Publish Community Project build 4.2011 to build 2011.5 consists of the following steps:

• Upgrading the distribution files to 2011.5
• Upgrading custom extensions
• Upgrading the database to 2011.5
• Regenerate the autoload array for extensions
• Clearing the caches

Check for requirements

eZ Publish Community Project 4.5 is compatible with PHP version 5.3 and above. For more information regarding system requirements check out http://ez.no/ezpublish/requirements

Step 1: Upgrading the distribution files

The easiest way to upgrade the distribution files is to unpack eZ Publish 2011.5 to a separate directory and then copy the directories that contain site-specific files from the existing installation. Make sure that you copy the following directories:

• design/example
• design/example_admin
• var
• settings/siteaccess
• settings/override

Replace "example" and "example_admin" with the actual names of your site accesses.

Important note: Because the new directory has replaced the original directory, the directory permissions need to be fixed. Use the following commands to do this.

(You have the choice between Shell commands or Alternative shell commands):

• Shell commands

These shell commands will give proper permission to the web server:

cd </path/to/your/eZ/Publish/directory>chmod -R a+rwx design extension settings var 

• Alternative shell commands

 These commands will setup the permission more correctly, but require knowledge about the running web server.

chmod -R og+rwx design extension settings varchown -R nouser:nouser design extension settings var 

Step 2: Custom extensions

If you are using custom extensions, the sub-directories inside the "extension" directory will also have to be copied. However, make sure that you do not overwrite any extensions that are included in the eZ Publish 2011.5 tarball. Note that upgrading the distribution files will overwrite the autoload arrays for extensions. You will need to re-generate the autoload arrays for active extensions later.

eZ Find now embeds Solr 3.1, this requires a full re-indexing of the content.

Step 3: Upgrading the database

MySQL

Run the following against your MySQL database :

<span>CREATE</span> <span>TABLE</span> ezorder_nr_incr <span>(</span>  id int<span>(</span><span>11</span><span>)</span> <span>NOT</span> <span>NULL</span> <span>AUTO_INCREMENT</span>,  <span>PRIMARY</span> <span>KEY</span>  <span>(</span>id<span>)</span><span>)</span> ENGINE<span>=</span>InnoDB;

Postgresql

<span>CREATE</span> SEQUENCE ezorder_nr_incr_s    START <span>1</span>    INCREMENT <span>1</span>    MAXVALUE <span>9223372036854775807</span>    MINVALUE <span>1</span>    CACHE <span>1</span>; <span>CREATE</span> <span>TABLE</span> ezorder_nr_incr <span>(</span>    id integer <span>DEFAULT</span> <span>NEXTVAL</span><span>(</span><span>'ezorder_nr_incr_s'</span>::text<span>)</span> <span>NOT</span> <span>NULL</span><span>)</span>;  <span>ALTER</span> <span>TABLE</span> ONLY ezorder_nr_incr    <span>ADD</span> CONSTRAINT ezorder_nr_incr_pkey <span>PRIMARY</span> <span>KEY</span> <span>(</span>id<span>)</span>;

Step 4: Regenerate the autoload array for extensions

The autoload system also has some changes, for example the autoload array for extensions is now placed in var/autoload of your eZ Publish installation (along the class changes in extensions itself).

To regenerate the autoload array, execute the following script from the root of your eZ Publish directory:

php bin/php/ezpgenerateautoloads.php --extension

Step 5: Clearing the caches

Whenever an eZ Publish solution is upgraded, all caches must be cleared in a proper way. This should be done from within a system shell:

1. Navigate into the eZ Publish 2011.5 directory.
2. Run the script using the following shell command:

php bin/php/ezcache.php --clear-all --purge 

Purging ensures that the caches are physically removed. When the "--purge" parameter is not specified, the caches will be expired but not removed.

Sometimes the script is unable to clear all cache files because of restrictive file/directory permission settings. Make sure that all cache files have been cleared by inspecting the contents of the various cache sub-directories within the "var" directory (typically the "var/cache/" and "var/<name_of_siteaccess>/cache/" directories). If there are any cache files left, you need to remove them manually.