Global navigation

   Documentation Center
   eZ Studio & eZ Platform
     User Manual
     Technical Manual
   eZ Publish 4.x / legacy

eZ Publish (5.x)

eZ Publish 5.x | For eZ Platform & eZ Studio topics see Technical manual and User manual, for eZ Publish 4.x and Legacy topics see eZ Publish legacy

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Cleaned up text a bit to make it more understandable - a lot still remains to be done


Keeping your system up-to-date is important, to make sure your it is running optimally and securely. The update mechanism in eZ Publish Platform is using the de facto standard PHP packaging system called Composer for this. This makes it easy to adapt package installs and updates to your workflow, allowing you to test new/updated packages in a development environment, put the changes in your version control system (git, Subversion, Mercurial, etc.), pull in those changes on a staging environment and, when approved, put it in production.


Out of the box composer uses a packaging system repository called for to find all open source packages and their updates, in eZ Publish Platform additional . Additional commercial packages are available for the eZ Publish Platform at (which is password protected, you 'll will need to setup set up authentication tokens as described below to get access).

To get access to these updates go log in to your service portal on, . If your project will need to be is configured for eZ Publish Platform 5.3 or higher and , you will have access to see the following on the "Maintenance and Support agreement details" screen:

  1. Click "Create token"
  2. Fill in a label describing the use of the token. This will allow you to revoke access later
    • Example, if you need to provide access to updates to a third party a good to example would be "53-upgrade-project-by-partner-x", this will allow you to revoke access later.
  3. Copy the password, you will not get access to this again!

For login When running composer to get updates, use you will be asked for a Username and Password. Use:

as Username: your Installation key found higher up on the same page, and the password you retrieved and saved "Maintenance and Support agreement details" page in the support portal

as Password: the token password you retrieved in step 3. 

Optional: Save authentication token in auth.json to avoid repeatedly typing

To avoid having to always fill your credentials, bundled with eZ Publish Platform is a Composer extension which makes it possible to put this informations in a auth.json file.Short: Add add an auth.json file at your project root, aside next composer.json, or in your COMPOSER_HOME directory for machine-wide use, the . The file looks like the following:

Code Block
    "config": {
        "basic-auth": {
            "": {
                "username": "<installation-key>",
                "password": "<password>"

The fine print: bundled with eZ Publish Platform is a Composer extension which makes it possible to store authentication information in that file.

Installing Composer

This step is only needed once per machine (per project by default, but installing globally on the machine is also possible, for . For alternatives see:
Composer is a command line tool, so the main way to install it is via command-line, example with only requirement on PHP being installed:

Code Block
titlecomposer download in current folder:
php -r "readfile('');" | php