• v2.0
    • Versions
    • master
    • v3.2
    • v3.1
    • v3.0
    • v2.3
    • v2.2
    • v2.1
    • v2.0
    • v1.7
    • v1.6
    • v1.5
    • v1.4
    • v1.3
    • v1.2
    • v1.1
    • v1.0
Caution! You are browsing the documentation for Akeneo in version 2.0, which is not maintained anymore.
Consider upgrading to the latest version.

 

  • Install Akeneo PIM
    • Install Akeneo PIM with Docker
    • Install Akeneo PIM manually
      • System Requirements
      • System installation on Debian 9 (Stretch)
      • System installation on Ubuntu 16.04 (Xenial Xerus)
      • Installing Akeneo PIM Community Edition (CE) with the Archive
      • Installing Akeneo PIM Enterprise Edition (EE) with the Archive
      • Setting up the job queue daemon
    • How to customize the Dataset
    • How to Add Translation Packs
  • Migrate Akeneo PIM projects
  • Import and Export data
    • How import works
    • Understanding the Product Import
    • Understanding the Product Export
    • Formats
      • Localized labels
      • Scopable labels
      • Association types data structure
      • Attribute data structure
      • Category data structure
      • Family data structure
      • Family variant data structure
      • Group data structure
      • Options data structure
      • Product data structure
      • Product model data structure
    • Akeneo Connectors
    • How to Customize Import / Export
      • How to create a new Connector
      • How to import Products from a XML file
      • How to clean a CSV file during a Product import
      • How to automate imports/exports
  • Manipulate the Akeneo PIM data
    • How to Customize Mass Edit Operations
      • How to register a new bulk action
      • How to Register a New Mass Edit Action on Products
      • How to Avoid Rules Execution on Mass Edit Actions
    • How to Manipulate Products
      • How to Query Products
      • How to Create Products
      • How to Update Products
      • How to Validate Products
      • How to Save Products
      • How to Remove Products
    • How to Manipulate Non-Product Objects
      • How to Query Non-Product Objects
      • How to Create Non-Product Objects
      • How to Update Non-Product Objects
      • How to Validate Non-Product Objects
      • How to Save Non-Product Objects
      • How to Remove Non-Product Objects
    • How to add a custom action rule
      • General information about rule format
      • How to add a custom action in the rule engine
    • How to Define Access Control List
    • How to Customize the Catalog Structure
      • How to Create a Reference Data
      • How to add a custom unit of measure
      • How to Add New Properties to a Category
    • How to Customize Product Assets
      • How to Add a New Transformation
      • How to Add a Default Thumbnail For Unknown File Types
      • How to connect to an external server for storage
      • How to change the validation rule to match a reference file to an asset
      • How to Mass Import Assets
    • How To Customize Teamwork Assistant (Enterprise Edition)
      • Customize notifications
      • Add a calculation step
      • How to log calculation step
      • Remove projects impacted by a custom catalog update
  • Design the user interfaces
    • How to customize any frontend part of the application
    • How to add an action button or meta data to the product edit form
    • How to add a tab to a form
    • How to add a new tab in System / Configuration
    • How to add custom information to a field
    • How to add a new field type
    • Create a custom product export builder filter
    • How to create the UI to manage a Reference Data
    • How to add a new page
    • How to customize the main menu
    • Styleguide
  • Maintain Akeneo PIM projects
    • First aid kit
    • Bug qualification
    • Common issues
    • Scalability Guide
      • Audit with 3 Representative Catalogs
      • More than 10k attributes?
      • More than 10k families?
      • More than 10k categories?
      • More than 500 attributes usable in the product grids?
      • More than 100k products to export?
      • More than 1GB of product media to export?
    • How to purge history
      • How to Purge jobs executions
      • How to adapt the version purger to your needs
  • Contribute to Akeneo PIM
    • How to report an issue?
    • How to translate the user interface?
    • How to enhance the documentation?
    • How to contribute to a Connector?
    • How to submit a patch to the PIM?
    • How behavior tests are architectured in the PIM?
      • Establishing Decorator Pattern
      • Using Spin In Behat
  • Technical overview
    • Product Information
    • Teamwork Assistant (Enterprise Edition)
      • Project creation
      • Project completeness
      • Project Completeness widget
      • Catalog update impact
      • Scalability guide
      • Users permission summary for Behat tests
    • Collaborative workflow
      • Simple workflow
      • Partial workflow
  • Technical architecture
    • Best Practices
      • Create a project
      • Create a reusable bundle
      • Setup Behat
      • Code Conventions
      • Coding Standards
    • Bundles
    • Components
    • How to implement your business logic using the event system
    • Events
      • Storage events
      • Workflow events (Enterprise Edition only)
    • How to Localize your data
      • How to change the PIM locale
      • How to Use Localizers
      • How to use Presenters
    • How to Add a Notification
    • Performances Guide
      • Memory usage of rules execution (Enterprise Edition)
      • Memory leak fix in Rules Engine (ORM)
      • More than 100 WYSIWYG editors in a page
      • PHP7 and HHVM Compatibility?
    • How to Use the Web REST API
    • Standard format
      • Products
      • Other entities
      • Usage
    • Application Technical Information
      • Application Technical Dependencies
      • Server side set up for hosting
      • System Requirements
      • Recommended configuration
      • Client side configuration and compatibilities
      • Operation processes
      • Flow Matrix
  • Akeneo Cloud Edition
    • Flexibility Mode
      • Overview
      • Partners Starterkit
      • Environments Access
      • Composer settings
      • Periodic tasks / Crontab settings
      • PIM Application
      • PIM Updates and Migrations
      • Data File Transfer
      • Backups management
      • Partners
      • Queue management
      • System Components
      • Disk Usage
    • Serenity Mode
      • Overview
      • PIM Updates and Migrations

Server side set up for hosting¶

Hardware¶

Here is the minimum server configuration to run Akeneo PIM application:

CPU Quad-core, type Intel Xeon 1220 or above
Memory 8GB minimum
Hard drive SAS HDD 15k RPM, 20GB minimum (RAID 1 minimum recommended)

Warning

Should you use VCPu, keep in mind that VCPus do not provide same level of performance as real CPUs. Amazon servers, for instance, offer only 10 to 25% of performances of a real CPU.

Software¶

System Requirements¶

Here is the list of system requirements that should be fulfilled to be able to install Akeneo PIM.

Operating Systems

Akeneo PIM only works on Linux servers. The application’s behaviour has been tested on several operating systems. We cannot guarantee the behaviour of the application on servers different from:

Debian (Linux) ≥ 9 (64 bits)
Ubuntu (Linux) ≥ 16.04 (64 bits)
CentOS / RHEL* (Linux) ≥ 7
  • RHEL stands for Red Hat Enterprise Linux.

Web server and configuration

We can only guarantee the behaviour on the following web server:

Apache web server ≥ 2.4

The web server will also need the following libraries and modules:

mod rewrite Required
mod-fastcgi Required (no CGI nor libmod-php)

PHP required modules and configuration

PHP 7.1
php-apcu apc.enable_cli=1
php7.1-bcmath No specific configuration
php7.1-curl No specific configuration
php7.1-fpm No specific configuration
php7.1-gd No specific configuration
php7.1-intl No specific configuration
php7.1-mcrypt No specific configuration
php7.1-mysql No specific configuration
php7.1-soap No specific configuration
php7.1-xml No specific configuration
php7.1-zip No specific configuration
php-exif No specific configuration
php7.1-imagick No specific configuration

Warning

function exec() is required in order to handle data import/export, check if it hasn’t been disabled in your php.ini.

Besides these modules, the following configuration is the minimal configuration required:

  • Setup CLI php.ini file /etc/php/7.1/cli/php.ini
$ sudo vim /etc/php/7.1/cli/php.ini
memory_limit = 1024M
date.timezone = Etc/UTC

Note

Use the time zone matching your location, for example America/Los_Angeles or Europe/Berlin. See https://www.php.net/timezones for the list of all available timezones.

  • Setup FPM php.ini file /etc/php/7.1/fpm/php.ini

Note

If you have several PHP versions on your server, these files can be located in /etc/php/x.x/fpm/php.ini and /etc/php/x.x/cli/php.ini.

$ sudo vim /etc/php/7.1/fpm/php.ini
memory_limit = 512M
date.timezone = Etc/UTC

To avoid spending too much time on permission problems between the CLI user and the FPM user, a good practice is to use the same user for both of them.

Warning

This configuration is aimed to easily set up a development machine. It is absolutely not suited for a production environment.

  • Get your identifiers
$ id
uid=1000(my_user), gid=1000(my_group), ...

In this example, the user is my_user and the group is my_group.

  • Stop FPM
$ sudo service php7.1-fpm stop
  • Open the file /etc/php/7.1/fpm/pool.d/www.conf with your favorite text editor:
$ sudo vi /etc/php/7.1/fpm/pool.d/www.conf
# replace these environment variables:
user = my_user
group = my_group
listen = /run/php/php7.1-fpm.sock
listen.user = www-data
listen.group = www-data

Note

On the default installation, FPM user and group are www-data. listen.user and listen.group must be set on the same user than your Apache server. /run/php/php7.1-fpm.sock is the default socket path. If you changed it in /etc/php/7.1/fpm/pool.d/www.conf, change it in the Apache virtual host too.

  • Restart FPM
$ sudo systemctl restart php7.1-fpm

Extra dependencies

Image magick ≥ 6.8

Javascript

nodejs ≥ 6.11.0 - 8.2.1
yarn ≥ 1.0.0

Database server

MySQL (SQL) >= 5.7.8

To use this database you will also require the distribution package:

mysql-server Required

and the following PHP modules:

php7.1-mysql Required

Search engine

Elasticsearch 5.5 or 5.6

and the following Java Runtime Environment version

openjdk-8-jre-headless Required

Network

The following ports should be opened on the server host for the PIM to work properly:

HTTP or HTTPS 80 or 443 Required
MySQL unix socket or 3306 (if MySQL server on a different host) Required
Elasticsearch 9200 Required
SSH 22 Required (for deployment)

Files and folders access rights

Most of the application folders and files require only read access. Here is a list of folders that also need write access for the FPM user:

var/cache Contains application cache files
var/logs Contains application log files
var/uploads Contains files uploaded to the application by users or during import processes
web Contains the web assets required by the application

These permissions are the ones required by the Symfony Framework (see its official documentation for more information).

Akeneo PIM application uses an abstraction layer called Flysystem to store media and files uploaded from the application. By default, Flysystem is configured to store these files on the application server, but this configuration can easily be changed in favor of, for example, a distributed remote storage system (see Flysystem documentation for more information).

The var/uploads folder could be located elsewhere depending on the configuration you defined in the parameters.yml of your Akeneo PIM application instance.

Warning

Please note that neither the Apache user or the CLI should be the root user of the system.


Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!