Global navigation

   Documentation Center
   eZ Studio & eZ Platform
     User Manual
     Technical Manual
     Glossary
   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

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

Prerequisite to using composer

...

Setting up Authentication tokens for access to commercial updates

Out of the box composer uses a packaging system called packagist.org for all open source packages and their updates, in eZ Publish Platform additional commercial updates are available at updates.ez.no/bul/ (password protected, you'll need to setup authentication tokens to get access).

...

  1. Click "Create token"
  2. Fill in a unique label describing the use of the token
    1. 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!
Optional: Save authentication token in auth.json to avoid repeatedly typing

To avoid having to always type your credentials, bunded with eZ Publish Platform is a composer extension which makes it possible to put this in a auth.json file.

...

Code Block
languagejs
titleauth.json
{
    "config": {
        "basic-auth": {
            "updates.ez.no": {
                "username": "<login/label>",
                "password": "<password>"
            }
        }
    }
}

...

Installing Composer

This step is only needed once per machine (per project by default, but globally on machine also possible), for how see: https://getcomposer.org/download/

...

Updating via composer

1. Running composer update and version changes

Updating eZ Publish Platform via composer is nothing different then updating other projects via composer, but for illustration here is how you update your project locally:

...

Tip2: In large development teams make sure people don't blindly update and install third party components, this might easily lead to version conflicts on this file and can be tiring to fix-up if happening frequently. A workflow involving composer install and unit test execution on proposed changes can help avoid most of this, like available via Github/Bitbucket Pull Request workflow.

...

2.

...

Installing versioned updates on other development machines and/or staging

Again, installing eZ Publish Platform packages via composer is nothing different then installing vanilla packages via composer, but for illustration here is how you install versioned updates:

...