ez-publish-community-project-2014.05

Upgrade Notes

Upgrading from eZ Publish Community Project 2014.03 to 2014.05

Important Information Before You Start

• This is the 12th "eZ Publish 5" build, that comprises an eZ Publish 4.x build, under the 'ezpublish_legacy' folder, at the root of your eZ Publish 5 installation,
• The upgrade procedure below must be applied to the latter, then the normal installation procedure for the eZ Publish 5 stack must be followed, 
• Make sure to follow the Virtual Host based installation procedure in the latter to initiate the setup wizard.

Upgrading from 2014.03 to 2014.05

This section describes how to upgrade your existing eZ Publish Community Project 2014.03 installation to build 2014.05. 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 from eZ Publish Community Project build 2014.03 to build 2014.05 consists of the following steps:

• Backing up the website
• Putting the website offline (optional)
• Upgrading the distribution files to 2014.05
• Upgrading custom extensions
• Regenerate the autoload array for extensions
• Running the upgrade scripts
• Updating your YAML configuration
• Clearing the caches
• Putting the website online (optional)

Check for requirements

It is recommended to always verify the requirements for the new version of eZ Publish before attempting an upgrade. eZ Publish Community Project 2014.03 is compatible with PHP version 5.3.3 and above. So is eZ Publish Community Project 2014.05. For more information regarding system requirements check out "Requirements for doing a normal installation".

Step 1: Backing up the website

• Filesystem set: the extension and settings folders, plus any other folder where you have put your custom developments in (e.g. design/mydesign)
• Content set: the var/storage, var/<vardir>/storage folders, and a dump of the database (nb: for ezdb cluster mode, a dump of the storage database is needed instead of the storage folders; for ezdfs cluster mode both a dump of the storage database and a backup of the shared var folder on nfs)
• Optional: the complete installation directory of eZ Publish, except for the var directory and for the eZFind index directory. This is mandatory if you have customized the .htaccess or config.php files

Tip: if you have many user sessions, and the session data is stored in the database, it might be a good idea to remove all data from the session table before backing it up
Tip: in ezdb and ezdfs cluster modes, it is a good idea to clear all caches before dumping the storage database, as it is not easy to only backup storage and not caches

Step 2: Putting the website offline (optional)

This step is recommended but not mandatory

• Put the public website offline and set up a courtesy page to prevent end users from accessing the website while you upgrade. This involves generally modifying the webserver configuration. Make sure you have a different vhost available to access the public website using a private IP address or hostname during the upgrade process
• Disable execution of eZ Publish cronjobs

Step 3: Upgrading the distribution files

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

• design/<mydesign>
• design/<mydesign_admin>
• var
• settings/siteaccess
• settings/override

Replace "mydesign" and "mydesign_admin" with the actual names of your designs.

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>cd ezpublish_legacychmod -R a+rwx design extension settings var 

• Alternative shell commands

 These commands will setup the permission more correctly, but require knowledge about the user account used for running the web server process.cd </path/to/your/eZ/Publish/directory>

cd </path/to/your/eZ/Publish/directory>cd ezpublish_legacychmod -R og+rwx design extension settings varchown -R <webuser>:<webusergroup> design extension settings var 

Step 4: 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 2014.05 tarball, which are currently:

Bundled and enabled

• ezautosave-5.3.0-beta1
• ezcomments-5.3.0-beta1
• ezformtoken-5.3.0-beta1
• ezie-5.3.0-beta1
• ezjscore-5.3.0-beta1
• ezmultiupload-5.3.0-beta1
• ezodf-5.3.0-beta1
• ezoe-5.3.0-beta1
• ezprestapiprovider-5.3.0-beta1
• eztags-1.3.0-dev

Bundled but not enabled

• ezfind-5.3.0-beta1
• ezscriptmonitor-5.3.0-beta1

Optional installation (depending on the package chosen during the installation wizard)

• ezdemo-5.3.0-beta1
• ezdemodesign-5.3.0-beta1
• ezflow-5.3.0-beta1
• ezgmaplocation-5.3.0-beta1
• ezstarrating-5.3.0-beta1
• ezwebin-5.3.0-beta1
• ezwt-5.3.0-beta1

Step 5: Regenerate the autoload array for extensions

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

cd </path/to/your/eZ/Publish/directory>cd ezpublish_legacyphp bin/php/ezpgenerateautoloads.php --extension

Step 7: Running the upgrade scripts

Run the two following scripts:

cd </path/to/your/eZ/Publish/directory>cd ezpublish_legacyphp update/common/scripts/5.3/recreateimagesreferences.php -s<siteaccess>php update/common/scripts/5.3/updatenodeassignmentparentremoteids.php -s<siteaccess><span style="font-size: 1.1em;"> </span>

Step 8: Updating your YAML configuration

Please refer to these upgrade instructions: https://github.com/ezsystems/ezpublish-kernel/blob/master/doc/upgrade/5.3.md

Step 6: Clearing the caches

Whenever an eZ Publish website is upgraded, all caches must be cleared in a proper way. This should be done from the root directory of your eZ Publish installation:

cd </path/to/your/eZ/Publish/directory>cd ezpublish_legacyphp bin/php/ezcache.php --clear-all --purge 

Tip : 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.

Step 9: Putting the website back online

This step is optional, and is only needed if you put the website offline at step 2

• warm up the template cache by pre-compiling template files. This should be done from the root directory of your eZ Publish installation:

cd </path/to/your/eZ/Publish/directory>cd ezpublish_legacyphp bin/php/eztc.php --wwwdir=<value> --index-file=<value> 

• re-enable the cronjobs
• warm up the content cache: use a tool such as curl or wget that will navigate the website to force eZPublish to generate the view cache for all content
• change the webserver / firewall configuration to allow public access to your website again

• Backing up the website
• Putting the website offline (optional)
• Upgrading the database
• Upgrading the distribution files to 2014.05
• Upgrading custom extensions
• Regenerate the autoload array for extensions
• Clearing the caches
• Putting the website online (optional)

Step 8 (optional): Authentication through Symfony

• In ezpublish/config/security.yml, you must remove ezpublish: true from ezpublish_front firewall.
• In ezpublish/config/routing.yml, you must add login, login_check and logout routes (see above in [Configuration][])
• In your templates, change your links pointing to /user/login and /user/logout to appropriate login/login_check/logout routes:

Before:

<span><a href="{{ path( 'ez_legacy', {'module_uri': '/user/login'} ) }}"></span>Login<span></a></span><span><form action="{{ path( 'ez_legacy', {'module_uri': '/user/login'} ) }}" method="post"></span><span><a href="{{ path( 'ez_legacy', {'module_uri': '/user/logout'} ) }}"></span>Logout<span></a></span>

After:

<span><a href="{{ path( 'login' ) }}"></span>Login<span></a></span><span><form action="{{ path( 'login_check' ) }}" method="post"></span><span><a href="{{ path( 'logout' ) }}"></span>Logout<span></a></span>

For more information: https://github.com/ezsystems/ezpublish-kernel/blob/master/doc/specifications/security/authentication_symfony.md#upgrade-notes