Readme.md

Apache 2.2 / 2.4 configuration

For recommended versions of Apache, see online eZ requirements.

Prerequisites

• Some general knowledge of how to install and configure Apache
• Apache 2.x must be installed using Apache MPM prefork, aka in "prefork mode".
• Apache modules installed and enabled:
• required: mod_php, mod_rewrite, mod_env
• recommended: mod_setenvif, mod_expires

Configure

These examples are simplified to get you up and running, see Virtual host template for more options and details on best practice.

Virtual Host

1. Place virtualhost config (example below) in a suitable Apache config folder, typically:
   • Debian/Ubuntu: /etc/apache2/sites-enabled/<yoursite>.conf
   • RHEL/CentOS/Amazon-Linux: /etc/httpd/conf.d/<yoursite>.conf
2. Adjust the basics to your setup:
   • VirtualHost: IP and port number to listen to.
   • ServerName: Your host name, example ez.no.
   • Or for local dev for instance ezinstall.localhost, with corresponding entry in your hosts file.
   • ServerAlias: Optional host alias list, example www.ez.no login.ez.no, or *.ez.no.
   • DocumentRoot: Point this and Directory to web directory of eZ installation.
   • If you can't install mod_setenvif, adjust the "Environment" section like described inline.
3. Restart Apache, as follows:
   • Debian/Ubuntu: sudo service apache2 restart
   • RHEL/CentOS/Amazon-Linux: sudo service httpd restart

Example config for Apache 2.4 in prefork mode:

<VirtualHost *:80>
    ServerName localhost
    #ServerAlias *.localhost
    DocumentRoot /var/www/ezinstall/web
    DirectoryIndex app.php

    # Set default timeout to 90s, and max upload to 48mb
    TimeOut 90
    LimitRequestBody 50331648

    <Directory /var/www/ezinstall/web>
        Options FollowSymLinks
        AllowOverride None
        # Depending on your global Apache settings, you may need to comment this:
        Require all granted
    </Directory>

    # As we require ´mod_rewrite´  this is on purpose not placed in a <IfModule mod_rewrite.c> block
    RewriteEngine On

    # Environment.
    # Possible values: "prod" and "dev" out-of-the-box, other values possible with proper configuration
    # Defaults to "prod" if omitted. If Apache complains about this line and you can't install `mod_setenvif` then
    # comment out "%{ENV:SYMFONY_ENV}" line below, and comment this out or set via: SetEnv SYMFONY_ENV "prod"
    SetEnvIf Request_URI ".*" SYMFONY_ENV=prod

    # Sets the HTTP_AUTHORIZATION header sometimes removed by Apache
    RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

    # Access to repository images in single server setup
    RewriteRule ^/var/([^/]+/)?storage/images(-versioned)?/.* - [L]

    # Makes it possible to placed your favicon and robots.txt at the root of your web folder
    RewriteRule ^/favicon\.ico - [L]
    RewriteRule ^/robots\.txt - [L]

    # The following rules are needed to correctly display bundle and project assets
    RewriteRule ^/bundles/ - [L]
    RewriteRule ^/assets/ - [L]

    # Additional Assetic rules for environments different from dev,
    # remember to run php bin/console assetic:dump --env=prod
    RewriteCond %{ENV:SYMFONY_ENV} !^(dev)
    RewriteRule ^/(css|js|fonts?)/.*\.(css|js|otf|eot|ttf|svg|woff) - [L]

    RewriteRule .* /app.php
</VirtualHost>

.htaccess

If you do not have an access to use virtualhost config, use the .htaccess file in a simplified form. It must be placed in the web/ folder to make it running. This will not work if Apache is configured with the AllowOverride None for this directory.

DirectoryIndex app.php

# Set default timeout to 90s, and max upload to 48mb
TimeOut 90
LimitRequestBody 50331648

# Disabling MultiViews prevents unwanted negotiation, e.g. "/app" should not resolve
# to the front controller "/app.php" but be rewritten to "/app.php/app".
<IfModule mod_negotiation.c>
    Options -MultiViews
</IfModule>

# As we require ´mod_rewrite´  this is on purpose not placed in a <IfModule mod_rewrite.c> block
RewriteEngine On

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

# Sets the HTTP_AUTHORIZATION header sometimes removed by Apache
RewriteCond %{HTTP:Authorization} .
RewriteRule ^ - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

# Makes it possible to placed your favicon and robots.txt at the root of your web folder
RewriteRule ^favicon\.ico - [L]
RewriteRule ^robots\.txt - [L]

# To display assets from eZ / Symfony bundles
RewriteRule ^bundles/ - [L]

# Access to repository images in single server setup
RewriteRule ^var/([^/]+/)?storage/images(-versioned)?/.* - [L]

# Additional Assetic rules for prod environments
# ! Remember to run php ezpublish/console assetic:dump --env=prod on changes
# ! Or if SYMFONY_ENV is set to "dev", comment this out!
RewriteRule ^(css|js|fonts?)/.*\.(css|js|otf|eot|ttf|svg|woff) - [L]

# Rewrite all other queries to the front controller.
RewriteRule .* app.php

Virtual host template

This folder contains vhost.template for Apache 2.4, and vhost.2.2.template for Apache 2.2, both which provides more features you can enable in your virtual host configuration. You may also use this file as a .htaccess config. However, you will need to adjust rewrite rules to remove / like in the example above.

Note: vhost.template uses mod_setenvif, adapt it as indicated inline if you can't install it.

Bash script (Unix/Linux/OS X) exists to be able to generate the configuration. To display help text, execute the following from the eZ installation root:

./bin/vhost.sh -h

Common issues

NameVirtualHost conflicts

The NameVirtualHost setting might already exist in the default configuration. Defining a new one will result in a conflict. If Apache reports errors such as NameVirtualHost [IP_ADDRESS] has no VirtualHosts or Mixing * ports and non-* ports with a NameVirtualHost address is not supported, try removing the NameVirtualHost line. For more details, see NameVirtualHost directive section on the Apache documentation.