• v4.0
    • Versions
    • master

 

  • Install Akeneo PIM
    • Install Akeneo PIM for development with Docker
    • Install Akeneo PIM manually
      • System Requirements
      • System installation on Debian 10 (Buster)
      • System installation on Ubuntu 18.04 (Bionic Beaver)
      • Installing Akeneo PIM Community Edition (CE)
      • 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
    • How to apply a patch?
      • How to apply a patch - Community Edition
      • How to apply a patch - Enterprise Edition - Flexibility Cloud offer
      • How to apply a patch - Enterprise Edition - On Premise offer
    • Where is the Changelog?
    • How to upgrade to a minor version?
    • How to upgrade to a major version?
      • Upgrade from 3.2 to 4.0
  • 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 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 Teamwork Assistant (Enterprise Edition)
      • Customize notifications
      • Add a calculation step
      • How to log calculation step
      • Remove projects impacted by a custom catalog update
    • How to store assets externally
  • 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 to contribute to the frontend part of the application
    • How behavior tests are architectured in the PIM?
      • Establishing Decorator Pattern
      • Using Spin In Behat
  • Use SSO authentication locally
  • Reference Entities (beta)
    • Configure Entity Limits
    • Create a new Reference Entity Attribute type
    • Enrich Records with a new Reference Entity Attribute type
    • Add a Custom Property to Your Custom Attribute Type
    • Refresh records completeness
  • 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
    • 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?
      • Job product batch size
    • 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
      • Environment accesses
      • System Administration & Services Management
      • Periodic tasks & Crontab configuration
      • Composer settings
      • Queue Management & Workers
      • Disk Usage Management
    • Serenity
  • Akeneo Onboarder
    • Prerequisites
    • How to install the Onboarder bundle
    • Migrate Akeneo Onboarder projects
      • How to update a minor version or to apply a patch?
        • How to update the Onboarder bundle - Enterprise Edition - Flexibility Cloud offer
        • How to update the Onboarder bundle - Enterprise Edition - On Premise offer
      • How to upgrade to a major version?
    • Synchronization
    • Troubleshooting
    • Environment variables
      • Using the DotEnv file
      • Using environment variables

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) ≥ 10 (64 bits)
Ubuntu (Linux) ≥ 18.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.3
php7.3-apcu apc.enable_cli=1
php7.3-bcmath No specific configuration
php7.3-curl No specific configuration
php7.3-fpm No specific configuration
php7.3-intl No specific configuration
php7.3-mysql No specific configuration
php7.3-xml No specific configuration
php7.3-zip No specific configuration
php7.3-exif No specific configuration
php7.3-imagick No specific configuration
php7.3-cli No specific configuration
php7.3-opcache No specific configuration
php7.3-zip No specific configuration
php7.3-mbstring No specific configuration
php-memcached 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.3/cli/php.ini
$ sudo vim /etc/php/7.3/cli/php.ini
memory_limit = 1024M
date.timezone = 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.3/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.3/fpm/php.ini
memory_limit = 512M
date.timezone = 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.3-fpm stop
  • Open the file /etc/php/7.3/fpm/pool.d/www.conf with your favorite text editor:
$ sudo vi /etc/php/7.3/fpm/pool.d/www.conf
# replace these environment variables:
user = my_user
group = my_group
listen = /run/php/php7.3-fpm.sock
listen.owner = www-data
listen.group = www-data

Note

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

  • Restart FPM
$ sudo service php7.3-fpm restart

Extra dependencies

Image magick ≥ 6.8
aspell ≥ 0.60.7
aspell-en  
aspell-fr  
aspell-de  
aspell-es  

Optional dependencies

MagickCore extra codecs ≥ libmagickcore-6.q16-2-extra Image magick extra codecs to handle SVG

Javascript (required only for development purposes)

nodejs ≥ 10.15.0
yarn ≥ 1.0.0
JQuery 3.4

Database server

MySQL (SQL) ≥ 8.0.18

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

mysql-server Required

and the following PHP modules:

php7.3-mysql Required

Warning

Please note that if you’re using a managed MySQL service (GCP, AWS, or Azure for example), make sure they provide the a MySQL version compatible with the above requirements.

Search engine

Elasticsearch 7.5

Elasticsearch is bundled with its own JDK version, but if you want to use the no JDK version <https://www.elastic.co/downloads/elasticsearch-no-jdk>_, please make sure to install the right JDK for Elasticsearch.

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

Warning

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

URL root path

We do not support Akeneo PIM in a non-root configuration. For example http://example.com/pim/ is not supported whereas http://example.com/ or http://pim.example.com/ are supported. We strongly recommend to access the PIM through a root URL. Some parts of the application may misbehave when accessed through a subpath.


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