ibexa

Path

ez publish / technical manual / 4.3 / features / packages


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

Packages

From 3.8, the standard packages are not included in the eZ Publish distribution itself. They are distributed separately as ".ezpkg" files. The files can be downloaded automatically by the setup wizard from the remote repository or manually from packages download page.

A package is a collection of items grouped together and stored in the specific format for the purpose of easy installation and removal. The system makes it possible to create packages and export them to ".ezpkg" files. This is the common way of how the packages are distributed. When an ".ezpkg" file is imported, it will become available under the system repository part of the eZ Publish installation. Most of the packages can be installed and uninstalled. The following table reveals the complete list of package operations that can are supported in the administration interface.

Operation

Description

Create new package

It is possible to export your class definitions, content objects, settings, design styles etc. by creating new packages of different types. The newly created packages will be stored under the "Local" system repository.

Import new package

To import a new package, you need to select the desired ".ezpkg" file locally. The system will then upload the file, unpack it and place the resulting package under an appropriate internal repository within the installation.

Remove selected

You can remove packages from the system repository. Please note that the package itself will not be removed. Only the package files will be removed from the internal repository.

Install

It is possible to install packages that are located under internal repositories. When you install a package, the system will create content classes and content objects, apply the settings specified in it and so on. (Please note that installing site packages and design packages is not supported.)

Export to file

A package located under the system repository can be exported to ".ezpkg" file. The system will ask you where to store the newly created file.

Uninstall

When you uninstall a package, all the changes made during its installation will be reverted.

Remote repository

Packages from remote repository can be downloaded by the setup wizard during the system installation process. However, the administration interface is unable to download packages from this repository.

The system will use the eZ Systems packages repository as the default remote repository. If you wish to use another remote repository, you need to specify its corresponding address using the "RemotePackagesIndexURL" configuration setting located in the "[RepositorySettings]" section of the "settings/override/package.ini.append.php" file.

System / internal repository

The default behavior is that all packages are stored in the "var/storage/packages" directory. This directory is the main system repository and its sub-directories are called "system repositories" or "internal repositories". The name of a sub-directory also functions as the actual name of a repository. The packages are sorted by their vendor. For example, the packages downloaded from ez.no will be stored under the "ez_systems" internal repository (var/storage/packages/ez_systems). Packages that have no vendor and packages created locally will reside under the "Local" repository (var/storage/packages/local).

It is possible to choose another location of the main system repository inside the "var/storage" directory. The following example shows how to change "settings/override/package.ini.append.php" in order to force the system to use "var/storage/importedpackages" as the main system repository:

RepositoryDirectory=importedpackages

Svitlana Shatokhina (14/09/2010 12:14 pm)

Geir Arne Waaler (05/10/2010 7:43 am)

Balazs Halasy, Julia Shymova, Geir Arne Waaler


Comments

  • change a package

    I have created a package. How can I change this package? How can I add or remove some files to/from an existing package?
    • Re: change a package

      You can't, you need to import it somewhere and do the changes on that installation and then export it when you are done.
  • ezpm.php script

    For package operations that take too long and result in a web page timeout, use the ezpm.php command line script, available in the root dir of eZ Publish