- Created by Dominika Kurek, last modified by André Rømcke on Nov 11, 2016
Introduction
Sessions are handled by the Symfony2 framework, specifically API and underlying session handlers provided by HTTP Foundation component. This is further enhanced in eZ Platform with support for siteaccess-aware session cookie configuration.
Use of Memcached (or experimentally using PDO) as session handler is a requirement in Cluster setup, for details see below. For an overview of clustering feature see Clustering.
Configuration
Symfony offers the possibility to change many session options at application level (i.e. in Symfony framework
configuration), such as:
cookie_domain
cookie_path
cookie_lifetime
cookie_secure
cookie_httponly
However as eZ Platform can be used for setting up several web sites within on Symfony application, session configuration is also possible to define per siteaccess and SiteGroup level.
Session options per siteaccess
All site-related session configuration can be defined per siteaccess and SiteGroup:
Session name per siteaccess
In 5.x versions prior to 5.3 / 2014.03 the following siteaccess aware session setting where available:
Usage
Session handlers
In Symfony, a session handler is configured using framework.session.handler_id.
Symfony can be configured to use custom handlers, or just fallback to what is configured in PHP by setting it to null (~
).
Default configuration
eZ Platform uses the same default configuration as recent versions of Symfony standard distribution. This makes sure you can configure sessions purely in PHP by default, and allows Debian/Ubuntu session file cleanup cronjob to work as intended.
Recommendations for production setup
Single server setup
For single server, default handler should be preferred.
Cluster setup
For Cluster setup we need to configure Sessions to use a backend that is shared between web servers and supports locking. Only options out of the box supporting this in Symfony are the native PHP memcached session save handler provided by the php-memcached extension, and Symfony session handler for PDO (database).
Storing sessions in Memcached using php-memcached
For setting up eZ Platform using memcached you'll need to configure the session save handler settings in php.ini as documented here, optionally tweak php-memcached session settings.
Storing sessions in Redis using pecl package redis
EXPERIMENTAL
For setting up eZ Platform using Redis pecl package you'll need to configure the session save handler settings in php.ini as documented here.
Alternative storing sessions in database using PDO
While not currently our recommendation from performance perspective, for setups where Database is preferred for storing Sessions, you may use Symfony's PdoSessionHandler.
Below is an configuration example for eZ Platform, but please refer to documented in Symfony Cookbook documentation for full documentation.