Page History

...

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

Setting up a database

Status
colour Yellow title 5.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
   language bash
   # 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.

   Reference	Description
   <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>'

   Reference	Description
   <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
colour Yellow title 5.x

...

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

Unpacking eZ Publish

Status
colour Yellow title 5.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
colour Yellow title 5.x

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

• Using ACL on a system that supports chmod +a
  These shell commands will give proper permission to the web server and command line users.

  5.3 / 2014.05 and higher:

  Status
  colour Red title >= 5.3 / 2014.05

  
  

  No Format
  $ cd /<ezp5-root>/ $ sudo chmod +a "www-data allow delete,write,append,file_inherit,directory_inherit" \ ezpublish/{cache,logs,config,sessions} ezpublish_legacy/{design,extension,settings,var} web $ sudo chmod +a "`whoami` allow delete,write,append,file_inherit,directory_inherit" \ ezpublish/{cache,logs,config,sessions} ezpublish_legacy/{design,extension,settings,var} web

  5.0, 5.1 and 5.2:

  Status
  colour Grey title 5.0

  Status
  colour Grey title 5.1

  Status
  colour Green title 5.2

  
  

  No Format
  $ cd /<ezp5-root>/ $ sudo chmod +a "www-data allow delete,write,append,file_inherit,directory_inherit" \ ezpublish/{cache,logs,config} ezpublish_legacy/{design,extension,settings,var} web $ sudo chmod +a "`whoami` allow delete,write,append,file_inherit,directory_inherit" \ ezpublish/{cache,logs,config} ezpublish_legacy/{design,extension,settings,var} web

  
  

• Using ACL on a system that does not support chmod +a
  Some systems don't support chmod +a, but do support another utility called setfacl. You may need to enable ACL support on your partition and install setfacl before using it (as is the case with Ubuntu), like so:.
  5.3 / 2014.05 and higher:

  Status
  colour Red title >= 5.3 / 2014.05

  
  

  No Format
  $ cd /<ezp5-root>/ $ sudo setfacl -R -m u:www-data:rwx -m u:www-data:rwx \ ezpublish/{cache,logs,config,sessions} ezpublish_legacy/{design,extension,settings,var} web $ sudo setfacl -dR -m u:www-data:rwx -m u:`whoami`:rwx \ ezpublish/{cache,logs,config,sessions} ezpublish_legacy/{design,extension,settings,var} web

  5.0, 5.1 and 5.2:

  Status
  colour Grey title 5.0

  Status
  colour Grey title 5.1

  Status
  colour Green title 5.2

  
  

  No Format
  $ cd /<ezp5-root>/ $ sudo setfacl -R -m u:www-data:rwx -m u:www-data:rwx \ ezpublish/{cache,logs,config} ezpublish_legacy/{design,extension,settings,var} web $ sudo setfacl -dR -m u:www-data:rwx -m u:`whoami`:rwx \ ezpublish/{cache,logs,config} ezpublish_legacy/{design,extension,settings,var} web

• Using chown on systems that don't support ACL
  Some systems don't support ACL at all. You will either need to set your web server's user as the owner of the required directories.
  5.3 / 2014.05 and higher:

  Status
  colour Red title >= 5.3 / 2014.05

  
  

  No Format

  $ cd /<ezp5-root>/ $ sudo chown -R www-data:www-data ezpublish/{cache,logs,config,sessions} ezpublish_legacy/{design,extension,settings,var} web $ sudo find {ezpublish/{cache,logs,config,sessions},ezpublish_legacy/{design,extension,settings,var},web} -type d | xargs sudo xargs chmod -R 775 $ sudo find {ezpublish/{cache,logs,config,sessions},ezpublish_legacy/{design,extension,settings,var},web} -type f | xargs sudo chmod -R 664

  5.0, 5.1 and 5.2:

  Status
  colour Grey title 5.0

  Status
  colour Grey title 5.1

  Status
  colour Green title 5.2

  
  

  No Format
  $ cd /<ezp5-root>/ $ sudo chown -R www-data:www-data ezpublish/{cache,logs,config} ezpublish_legacy/{design,extension,settings,var} web $ sudo find {ezpublish/{cache,logs,config},ezpublish_legacy/{design,extension,settings,var},web} -type d | xargs sudo chmod -R 775 $ sudo find {ezpublish/{cache,logs,config},ezpublish_legacy/{design,extension,settings,var},web} -type f | xargs sudo chmod -R 664

• Using chmod
  If you can't use ACL and aren't allowed to change owner, you can use chmod, making the files writable by everybody. Note that this method really isn't recommended as it allows any user to do anything.
  5.3 / 2014.05 and higher:

  Status
  colour Red title >= 5.3 / 2014.05

  
  

  No Format
  $ cd /<ezp5-root>/ $ sudo find {ezpublish/{cache,logs,config,sessions},ezpublish_legacy/{design,extension,settings,var},web} -type d | xargs sudo xargs chmod -R 777 $ sudo find {ezpublish/{cache,logs,config,sessions},ezpublish_legacy/{design,extension,settings,var},web} -type f | xargs sudo chmod -R 666

  5.0, 5.1 and 5.2:

  Status
  colour Grey title 5.0

  Status
  colour Grey title 5.1

  Status
  colour Green title 5.2

  
  

  No Format
  $ cd /<ezp5-root>/ $ sudo find {ezpublish/{cache,logs,config},ezpublish_legacy/{design,extension,settings,var},web} -type d | xargs sudo chmod -R 666

Updating Zetacomponents

...

• 777 $ sudo find {ezpublish/{cache,logs,config},ezpublish_legacy/{design,extension,settings,var},web} -type f | xargs sudo chmod -R 666

Install Composer

Status
colour Yellow 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:

...

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

If you don't have curl installed:

...

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

...

When Composer is installed

...

php composer.phar install

...

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

Optional : Link assets 

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

cd /<ezp5-root>
php ezpublish/console assets:install --relative --symlink web
php ezpublish/console ezpublish:legacy:assets_install --relative --symlink web
php ezpublish/console assetic:dump --env=prod web

Initiating the setup wizard

Status
colour Yellow title 5.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.

Defining the desired environment

Environment configuration is a new feature introduced as of eZ Publish 5.2 and eZ Publish Community Project 2013.06.
You can configure several environments, from production, development or staging, even if for each one of them you need require using different configurations sets.

In the VirtualHost example in the Virtual host setup chapter the required VirtualHost configurations have been already included. You can switch to the desired environment by setting the ENVIRONMENT environment variable to "prod", "dev" or other custom value, as you can see in the following example:

    # Environment.
    # Possible values: "prod" and "dev" out-of-the-box, other values possible with proper configuration (described below)
    # Defaults to "prod" if omitted
    SetEnv ENVIRONMENT "prod"

If you want to use a custom environment (something else then "prod" and "dev") the next step is to create the dedicated configuration files for your environment:

• ezpublish/config/config_<env_name>.yml
• ezpublish/config/ezpublish_<env_name>.yml

The name used as <env_name> will be the one that can be used as value of the ENVIRONMENT environment variable.

Those files must import the main configuration file, just like the default config_dev.yml already does. Here's an example:

imports:
    - { resource: config.yml }

This allows you to override settings defined in the main configuration file, depending on your environment (like the DB settings or any other setting you may want to override).