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.

...

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 (optional)

Info

This is a procedure to be done for the case you need to set up several multiple environments for development purposes.

Environment configuration as provided by Symfony was enhanced as of eZ Publish 5.2 and eZ Publish Community Project 2013.06 to allow specifying this in the virtual host configuration.
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:

No Format
    # 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:

No Format
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).