Installing packages

This part of the 4.x documentation is for eZ Publish 4.0, only reference section is common for all eZ Publish 4.x versions as well as eZ Publish 5.x "LegacyStack", please select the version you are using for the most up to date documentation!

It is possible to install packages that are located under internal repositories. Note that this is not true for site packages and design packages. When you install a package, the system will create content classes and content objects, apply configuration settings and so on. Please note that from eZ Publish 3.8, information about installed packages is stored in the "ezpackage" table within the database.

The following subsections explain how to install packages of different types.

Content class packages

The following example demonstrates how to install a content class package.

  1. Go to "Setup - Packages" in your administration interface, select the internal repository containing the package you wish to install and click the "Change repository" button. Find the desired package and click on its name. The system will display the package summary as shown in the following screenshot.

    The content class package summary.


    Click the "Install" button.
  2. The system starts by showing a list of items that will be created during the package installation (look at the next screenshot).

    The content class package installation wizard, step 1.


    Read this information carefully and click the "Install package" button to continue. Use the "Skip installation" button to abort the operation.
  3. If some of the classes being installed already exist, the system will ask the user how this installation conflict should be handled (as shown in the screenshot below).

    The content class package installation wizard, step 2.


    If you wish to replace the existing class with the new one, note that all the content objects of the existing class will be removed as well. Use this option only if you know what you're doing. The remaining options make it possible to skip installing the class or create a new one (in both cases, the existing class and its objects will stay untouched).
    After clicking the "Continue" button, the system will install the package and display a summary.

Content object packages

The following example demonstrates how to install a content object package. (Since handling the class installation conflicts is already described in the previous subsection, let's suppose that no class definitions are included in the package that is being installed.)

  1. Go to "Setup - Packages" in your administration interface, select the internal repository containing the package you wish to install and click the "Change repository" button. Find the package you wish to install, click on its name and then click the "Install" button.
  2. The system will display a list of items that will be created during the package installation (look at the next screenshot).

    The content object package installation wizard, step 1.


    Read this information carefully click the "Install package" button. Use the "Skip installation" to abort the operation.
  3. If the package contains not only actual content objects but also templates related to these objects, the system will ask which siteaccess these templates should be added to (look at the next screenshot).

    The content object package installation wizard, step 2.


    Make your choice and click the "Next" button.
  4. The next dialog reveals where the installed objects will be located and allow to choose another location if needed.

    The content object package installation wizard, step 3.


    Choose the desired location and click the "Continue" button.
  5. If some of the objects being installed already exist (i.e. there is another object with the same remote_id), the system will ask how this installation conflict should be handled (see the screenshot below).

    The content object package installation wizard, step 4.


    After clicking the "Continue" button, the system will install the package and display a summary.

Extension packages

The following example demonstrates how to install an extension package.

  1. Go to "Setup - Packages" in your administration interface, select the internal repository containing the package you wish to install and click the "Change repository" button. Find the package you wish to install, click on its name and then click the "Install" button.
  2. The system will show a list of items that will be created during the package installation (look at the next screenshot).

    The extension package installation wizard, step 1.


    Click the "Install package" button to continue. Use the "Skip installation" button to abort the operation.
  3. If some of the items being installed already exist, the system will ask how this installation conflict should be handled as shown in the screenshot below.

    The extension package installation wizard, step 2.


    After clicking the "Continue" button, the system will install the package and display a summary.
Powered by eZ Publish™ CMS Open Source Web Content Management. Copyright © 1999-2013 eZ Systems AS (except where otherwise noted). All rights reserved.