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.

...

Note
The requirements for doing a normal installation must be met, read the "Requirements for doing a normal installation" section first!
Info
titleInstalling eZ Platform?

This page covers install of eZ Publish 5.x (including community versions like v2014.11), for eZ Platform see own installation documentation.

 

This section will guide you through the following steps:

  • Setting up / creating a database
  • Downloading a packaged eZ Publish distribution
  • Unpacking the eZ Publish distribution
  • Prepare the extracted files
    • Setup folder permissions
    • Link your assets
  • (Optional) Configure a VirtualHost
  • Initiating and going through the web based setup wizard at http://<your-host-name>/ezsetup
  • (Optional) Set up cronjobs

Setting up a database

Table of Contents
outlinetrue

Info
Follow the status labels for the right version :
Status
colourYellow
title5.x
Status
colourGrey
title5.0
Status
colourGrey
title5.1
Status
colourGreen
title5.2
 
Status
colourRed
title>= 5.3 / 2014.05

Setting up a database
Status
colourYellow
title5.x

A database must be created before running the setup wizard. The following text explains how to set up a database using either MySQL or PostgreSQL.

MySQL

  1. Log in as the root user (or any other MySQL user that has the CREATE, CREATE USER and GRANT OPTION privileges):

    $
    No Format
    Code Block
    languagebash
    # mysql --host=<mysql_host> --port=<port> -u <mysql_user> -p<mysql_password>
    Note

    Note that if MySQL is installed on the same server, the "--host" parameter can be omitted. If the "--port" parameter is omitted, the default port for MySQL traffic will be used (port 3306).

     

    The MySQL client should display a "mysql>" prompt.

  2. Create a new database:

    No Format
    mysql> CREATE DATABASE <database> CHARACTER SET utf8;
  3. Grant access permissions:

    No Format
    mysql> GRANT ALL ON <database>.* TO <user>@<ezp_host> IDENTIFIED BY '<password>';
    Note

    Note that if the specified user account does not exist, it will be created.

    ReferenceDescription
    <mysql_host>The hostname of the MySQL database server.
    <port>The port number that will be used to connect to the MySQL database server.
    <mysql_user>The MySQL user (if no user is set up, use "root").
    <mysql_password>The password that belongs to the <mysql_user>.
    <database>The name of the database, for example "my_new_database".
    <user>The username that will be used to access the database.
    <ezp_host>The hostname of the server on which eZ Publish will be running. (may be "localhost" if MySQL is installed on the same server).
    <password>The password you wish to set in order to limit access to the database.

PostgreSQL

  1. Log in as the postgres user (or any other PostgreSQL user that has sufficient privileges to create roles and databases):

    No Format
    $ psql -h <psql_host> -p <port> -U <psql_user> -W
    Note

    Note that if PostgreSQL is installed on the same server, the "-h" parameter can be omitted. If the "-p" parameter is omitted, the default port for PostgreSQL traffic will be used (in most cases, port 5432).

    The PostgreSQL client will ask you to specify the password that belongs to the <psql_user>. If the password is correct, the client should display a "<psql_user>=#" prompt.

  2. Create a new database:

    No Format
    postgres=# CREATE DATABASE <database> ENCODING='utf8';
  3. Create a new user:

    No Format
    postgres=# CREATE USER <user> PASSWORD '<password>';
  4. Grant access permissions:

    No Format
    postgres=# GRANT ALL PRIVILEGES ON DATABASE <database> TO <user>;

     

    Import the "pgcrypto" module into the new database:

    No Format
    postgres=# \c <database>
    <database>=# \i '<path_to_pgcrypto>'
    ReferenceDescription
    <psql_host>The hostname of the PostgreSQL database server.
    <port>The port number that will be used to connect to the PostgreSQL database server.
    <psql_user>The PostgreSQL user (if no user is set up, use "postgresql").
    <database>The name of the database, for example "my_new_database".
    <user>The username that will be used to access the database.
    <password>The password you wish to set in order to limit access to the database.
    <path_to_pgcrypto>The path to the "pgcrypto.sql" file, for example "/usr/share/pgsql/contrib/pgcrypto.sql".

    Note for version 9.1+ of PostgreSQL users:
    The following changes might be necessary for these users:
    No Format
    postgres=# \c <database>
    <database>=# CREATE EXTENSION pgcrypto;

Downloading eZ Publish
Status
colourYellow
title5.x

Info
The latest community version of eZ Publish can be downloaded from http://share.ez.no/

...

downloads

Enterprise version is available in your support portal or via partner portal.

Unpacking eZ Publish
Status
colourYellow
title5.x

Use your favorite tool to unpack the downloaded eZ Publish distribution to a web-served directory (a directory that is reachable using a web browser), or in case of virtual host mode it can be any folder.
The following example shows how to do this using the tar utility (to unpack a tar.gz file, assuming that the "tar" and the "gzip" utilities are installed on the system):

...

The extraction utility will unpack eZ Publish into a sub-directory called "ezpublish-<version_number>". Feel free to rename this directory to something more meaningful, for example "my_site".

Setting up folder permission
Status
colourYellow
title5.x

Note
titleImportant

In the 3 first folder permission setup options, always ensure to run application scripts and the web server with the appropriate UNIX user (must be same as you setup rights for below).

As for Apache you can control which user to use in your Apache configuration. Using PHP-FPM or SuExec module, you can even specify a user per virtual host.

Several cache, log and config folders must be writable both by the web server and the command line user, use one of the following two alternatives to do this:

 

Install Composer
Status
colourYellow
title>=5.3 / 2014.05

If you use a version control system, take care of versioning the composer.lock file.

Install Composer by running one of the following command from you eZ Publish root folder :

If you have curl installed:

No Format
curl -sS https://getcomposer.org/installer | php

If you don't have curl installed:

No Format
php -r "eval('?>'.file_get_contents('https://getcomposer.org/installer'));"


When Composer is installed, run composer update to get latest versions of packages before you continue with installation.

Info
Learn more on how to keep system further up to date  Using Composer
Note
titlePure legacy setup

If you are running a pure legacy setup, then commands such as composer install should be done within the legacy root folder, this will take care about installing latest versions of Zeta Components and defined eZ Publish (legacy) extension dependencies.

Optional : Link assets 

Info
The download file should already have generated these assets for you as of 5.2 / 2013.07 during composer install, but in case file has been extracted on Windows, make sure to run these commands.

To be able to run eZ Publish 5 correctly, assets need to be exposed in the public "web" folder, this is automatically done for you when you install / update vendors via composer which you did a few steps up. However during development you will need to execute these (especially last one) to get assets to be updated in prod environment, so they are kept here for reference.

The following commands will first symlink eZ Publish 5 assets in "Bundles" and the second will symlink assets (design files like images, scripts and css, and files in var folder)  from eZ Publish Legacy

No Format
cd /<ezp5-root>
php ezpublish/console assets:install --relative --symlink web
php ezpublish/console ezpublish:legacy:assets_install --relative --symlink web

# For 5.1 / 2013.4 and higher, also:
php ezpublish/console assetic:dump --env=prod web
Note

Note: In both cases "web" is the default folder and can be skipped from the command. For symlinks on the first two commands you can either use --relative, --symlink, or none to get the command to copy assets. However make sure to also update "symfony-assets-install" in composer.json if you prefer something else then --relative which is the default.

Further information about alternative options is available with -h on each command, just like it is with the console itself using "php ezpublish/console -h".

Warning
titleWarning regarding APC usercache

If you are planning to use APC to speed up your siteusercache for eZ Publish Persistence cache, please be sure to check the available notes here, before entering the setup wizard chapter.

Initiating the setup wizard
Status
colourYellow
title5.x

The setup wizard can be started using a web browser immediately after the previous steps (described in this section) are completed. It will be automatically run the first time someone tries to access/browse the "/ezsetup" url. Let's assume that we are using a server with the host name "www.example.com" and that after unpacking, the eZ Publish directory was renamed to "my_site".

Document root example

If eZ Publish was unpacked into a directory called "my_site" under the document root, the setup wizard can be initiated by browsing the following URL: http://www.example.com/my_site/web/index.php/ezsetup.

Home directory example

If eZ Publish was unpacked to a web-served directory located inside the home directory of a user with the user name "peter", (usually called "public_html", "www", "http", "html" or "web"), the setup wizard can be initiated by browsing the following URL: http://www.example.com/~peter/my_site/web/index.php/ezsetup.

Virtual host example

If you have setup the host name www.example.com to point to the web folder of eZ Publish using rewrite rules, then you should access it at: http://www.example.com/ezsetup.

Refer to the "The setup wizard" section for a detailed description of the web based setup wizard.