Skip to content

Install eZ Platform

Note

Installation for production is only supported on Linux.

To install eZ Platform for development on macOS or Windows, see Install on macOS or Windows.

Prepare work environment

To install eZ Platform you need a stack with your operating system, MySQL and PHP.

You can install it by following your favorite tutorial, for example: Install LAMP stack on Ubuntu.

Additionally, you need Node.js and Yarn for asset management.

For production you also need Apache or nginx as the HTTP server (Apache is used as an example below). For development, you can use the built-in PHP server instead.

You also need git for version control.

Before getting started, make sure you review the requirements page to see the systems we support and use for testing.

Get Composer

Install a recent stable version of Composer, the PHP command line dependency manager. Use the package manager for your Linux distribution. For example on Ubuntu:

1
apt-get install composer

To verify you got a recent stable version of Composer, you can run:

1
composer -V

Install Composer locally

If you want to install Composer inside your project root directory only, run the following command in the terminal:

1
php -r "readfile('https://getcomposer.org/installer');" | php

After this you need to replace composer with php -d memory_limit=-1 composer.phar in all commands below.

Get eZ Platform

There are two ways to get eZ Platform. The result is the same, so you can use the way you prefer:

Authentication tokens for eZ Enterprise

If you are installing eZ Enterprise, from this point refer to Install eZ Enterprise.

A. Download eZ Platform

You can download eZ Platform from two sources:

1. Download an archive

Extract the archive into the location where you want your project root directory to be.

2. Clone GitHub repository

You can also clone the GitHub repository.

1
git clone https://github.com/ezsystems/ezplatform .

Check out a tag (e.g. git checkout v1.13.4) for use in a project. Use branches (e.g. master or 1.13) only when contributing.

Install dependencies with Composer

Composer will look inside the composer.json file and install all of the packages required to run eZ Platform.

From the folder into which you downloaded eZ Platform, run:

1
composer install

B. Create project with Composer

You can also use Composer to instantly create a project in the current folder with all the dependencies:

1
composer create-project --keep-vcs ezsystems/ezplatform .

Tip

You can set different version constraints: specific tag (v2.2.0), version range (~1.13.0), stability (^2.3@rc), etc. For example if you want to get the latest stable 2.x release, with a minimum of v2.3.1, use:

1
composer create-project --keep-vcs ezsystems/ezplatform . ^2.3.1

Change installation parameters

At this point you can configure your database via the DATABASE_URL in the .env file: DATABASE_URL=mysql://user:password@host:port/name.

Choose a secret and provide it in the APP_SECRET parameter in .env. It should be a random string, made up of up to 32 characters, numbers, and symbols. This is used by Symfony when generating CSRF tokens, encrypting cookies, and for creating signed URIs when using ESI (Edge Side Includes).

Alternatively, you can also change individual installation parameters in .env.

Tip

It is recommended to store the database credentials in your .env.local file and not commit it to the Version Control System.

The configuration requires providing the following parameters:

  • DATABASE_USER
  • DATABASE_PASSWORD
  • DATABASE_NAME
  • DATABASE_HOST
  • DATABASE_PORT
  • DATABASE_PLATFORM — prefix for distinguishing the database you are connecting to (e.g. mysql or pgsql)
  • DATABASE_DRIVER — driver used by Doctrine to connect to the database (e.g. pdo_mysql or pdo_pgsql)
  • DATABASE_VERSION - database server version (for a MariaDB database, prefix the value with mariadb-)

Caution

When using the .env.local file with the DATABASE_* parameters mentioned above, the DATABASE_URL parameter needs to be re-defined for interpolation after overriding those parameters:

1
DATABASE_URL=${DATABASE_PLATFORM}://${DATABASE_USER}:${DATABASE_PASSWORD}@${DATABASE_HOST}:${DATABASE_PORT}/${DATABASE_NAME}

Using PostgreSQL

If you want an installation with PostgreSQL instead of MySQL, refer to Using PostgreSQL.

Create database

Tip

You can omit this step. If you do not create a database now, it will be created automatically in the next step.

To manually create a database, ensure that you changed the installation parameters, then run the following Symfony command:

1
php ./bin/console doctrine:database:create

Install eZ Platform

Install eZ Platform with:

1
composer ezplatform-install

This command will also create a database, if you had not created it earlier. Before executing it make sure that the database user has sufficient permissions.

If Composer asks for your token, you must log in to your GitHub account and generate a new token (edit your profile, go to Developer settings > Personal access tokens and Generate new token with default settings). This operation is performed only once when you install eZ Platform Enterprise Edition for the first time.

Enabling Link manager

To make use of Link Manager, you need to set up cron.

Prepare installation for production

To use eZ Platform with an HTTP server, you need to set up directory permissions and prepare a virtual host.

Set up permissions

For development needs, the web user can be made the owner of all your files (for example with the www-data web user):

1
chown -R www-data:www-data <your installation directory>

Directories var and public/var need to be writable by CLI and web server user. Future files and directories created by these two users will need to inherit those permissions.

Caution

For security reasons, in production web server should not have write access to other directories than var. Skip the step above and follow the link below for production needs instead.

You must also make sure that the web server cannot interpret files in the var directory through PHP. To do so, follow the instructions on setting up a virtual host below.

To set up permissions for production, it is recommended to use an ACL (Access Control List). See Setting up or Fixing File Permissions in Symfony documentation for information on how to do it on different systems.

Set up virtual host

Option A: Scripted configuration

Use the included shell script: /<your installation directory>/bin/vhost.sh to generate a ready to use .conf file. Check out the source of vhost.sh to see the options provided.

Option B: Manual configuration

Copy /<your installation directory>/doc/apache2/vhost.template to /etc/apache2/sites-available as a .conf file.

Modify it to fit your project.

Specify /<your installation directory>/public as the DocumentRoot and Directory. Uncomment the line that starts with #if [SYMFONY_ENV] and set the value to prod or dev, depending on the environment you want:

1
SetEnvIf Request_URI ".*" SYMFONY_ENV=prod

Enable virtual host

When the virtual host file is ready, enable the virtual host and disable the default:

1
2
a2ensite ezplatform
a2dissite 000-default.conf

Finally, restart the Apache server. The command may vary depending on your Linux distribution. For example of Ubuntu use:

1
service apache2 restart

Open your project in the browser and you should see the welcome page.

Enterprise

If you are installing eZ Enterprise, take a look at Installing eZ Enterprise for additional steps.

eZ Launchpad for quick deployment

If you want to get your eZ Platform installation up and running quickly, you can use Docker-based eZ Launchpad, supported by the eZ Community, which takes care of the whole setup for you.

Read the Docs