ez publish / upgrading / upgrading to 3.1 / from 3.0-2 to 3.1.0 rel1

Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.

from 3.0-2 to 3.1.0 rel1

This section describes how to upgrade your existing eZ Publish 3.0-2 installation to version 3.1.0 rel1. If you are upgrading from a version prior to eZ Publish 3.0-2, you need to first upgrade to 3.0-2 before you can upgrade to 3.1.0 rel1.

Please make sure that you have a working backup of the site before you do the actual upgrade. The upgrade procedure consists of the following steps:

  1. Upgrading the distribution files to 3.1.0 rel1
  2. Upgrading the database to 3.1.0 rel1
  3. Generating override settings
  4. Updating the system configuration
  5. Clearing the caches

Step 1: Upgrading the distribution files

The easiest way to upgrade the distribution files is to unpack eZ Publish 3.1.0 rel1 to a 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 actual names used by your siteaccesses.

Custom extensions

If you are using custom extensions then the subdirectories inside the "extension" directory will also have to be copied. However, make sure that you do not overwrite any extensions that come with eZ Publish (for example the "PayPal" extension).

Step 2: Upgrading the database

The following text describes how a 3.0-2 database can be upgraded to 3.1.0 rel1.


  1. Navigate into the eZ Publish 3.1.0 rel1 directory.
  2. Run the database upgrade script:
    mysql -u<username> -p<password> <database> < update/database/mysql/3.1/dbupdate-3.0-2-to-3.1.0-1.sql


  1. Navigate into the eZ Publish 3.1.0 rel1 directory.
  2. Run the database upgrade script:
    psql -d <database> -U <dbowner> < update/database/postgresql/3.1/dbupdate-3.0-2-to-3.1.0-1.sql

Step 3: Generating override settings

In eZ Publish 3.1.0 rel1, the new template override subsystem that allows to use custom templates instead of the default/standard ones has been implemented (see the 3.1.0 rel1 changelog for more information). The template overrides must be defined in the "override.ini.append.php" file of a siteaccess. In order to be compatible with this possibility, you will need to run the "generateoverridesettings.php" script for each of your siteaccesses (replace "example" with the actual name of your siteaccess):

php update/common/scripts/generateoverridesettings.php -s example

The script will output a suggestion for the siteaccess "override.ini.append.php" file that needs to be created for the specified siteaccess. You should create a new file called "override.ini.append.php" in the "settings/siteaccess/example" directory (replace "example" by the actual name of your siteaccess) and copy the output provided by the script to this file.

Step 4: Updating the system configuration

You are not required to do any configuration changes when upgrading from 3.0-2 to 3.1.0 rel1.

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 3.1.0 rel1 directory.
  2. Run the clear cache script:
    bin/shell/clearcache.sh --clear-all

Please make sure that all caches are cleared. Sometimes the script is unable to clear caches because of restrictive file/directory permission settings. Make sure that all caches have been cleared by inspecting the contents of the various cache subdirectories within the "var" directory.

Svitlana Shatokhina (19/09/2006 9:21 am)

Svitlana Shatokhina (20/09/2006 3:24 pm)


There are no comments.