• 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

Installing Akeneo PIM Enterprise Edition (EE) with the Archive¶

This document provides step by step instructions to install the PIM with the archive on an environment that fulfills the expected System Requirements.

By default Composer uses packagist.org to retrieve all open source packages and their updates. To download Akeneo PIM Enterprise Edition, you have to get access to our private enterprise edition repository by sending your SSH public key to our system.

Getting Akeneo PIM¶

This document provides step by step instructions to obtain an archive of the PIM Enterprise Edition.

Get PIM Enterprise Edition (EE) archive¶

Get the PIM Enterprise Edition (EE) archive from the Portal.

Extracting the archive¶

1
2
$ mkdir -p /path/to/installation
$ tar -xvzf pim-enterprise-standard-v2.0.tar.gz -C /path/to/installation/

Note

Replace /path/to/installation by the path to the directory where you want to install the PIM.

Note

Replace pim-enterprise-standard-v2.0.tar.gz by the location and the name of the archive you have downloaded from the Portal. Instructions on how to download this archive are available from the Help Center

Note

The PIM will be extracted in the folder /path/to/installation/pim-enterprise-standard.

Initializing Akeneo¶

Note

Remember that dev is the default and slowness environment. So when you launch a Symfony command, always add --env=prod in prod environment to avoid useless logging and profiling.

1
$ cd /path/to/installation/pim-enterprise-standard

Dependencies,

1
2
$ php -d memory_limit=3G ../composer.phar install --optimize-autoloader --prefer-dist
$ yarn install

Frontend,

1
2
$ php bin/console cache:clear --no-warmup --env=prod
$ php bin/console pim:installer:assets --symlink --clean --env=prod

Installation,

1
2
$ bin/console pim:install --force --symlink --clean --env=prod
$ yarn run webpack

Note

The ../composer.phar install command writes the database configuration to app/config/parameters.yml

Configuring tasks via crontab¶

The application needs the following tasks to be executed in background on a regular basis. The frequency has to be adapted according to your data volume.

Edit your crontab with crontab -e and configure your tasks.

Warning

Be sure to update the cron of the user used to install the PIM, to be able to run the command

You have to add these 6 commands to your local installation:

1
2
3
4
5
6
php /path/to/installation/pim-enterprise-standard/bin/console pim:completeness:calculate --env=prod              # recalculates the products completeness
php /path/to/installation/pim-enterprise-standard/bin/console pim:versioning:refresh --env=prod                  # processes pending versions
php /path/to/installation/pim-enterprise-standard/bin/console akeneo:rule:run --env=prod                         # executes rules on products
php /path/to/installation/pim-enterprise-standard/bin/console pimee:project:notify-before-due-date --env=prod    # check and send notifications (TeamWork Assistant)
php /path/to/installation/pim-enterprise-standard/bin/console pim:asset:send-expiration-notification --env=prod  # check and send notifications for asset date delay
php /path/to/installation/pim-enterprise-standard/bin/console pimee:project:recalculate --env=prod               # recalculate project completeness (TeamWork Assistant)

In the following example, these lines will run the completeness calculation at 11pm, the versioning calculation at 5am and the rules calculation at 6pm every day:

1
2
3
4
# m  h  dom  mon  dow  command
0 23  *    *    *    php /path/to/installation/pim-enterprise-standard/bin/console pim:completeness:calculate --env=prod > /path/to/installation/pim-enterprise-standard/var/logs/calculate_completeness.log 2>&1
0 5  *    *    *    php /path/to/installation/pim-enterprise-standard/bin/console pim:versioning:refresh --env=prod > /path/to/installation/pim-enterprise-standard/var/logs/refresh_versioning.log 2>&1
0 18  *    *    *    php /path/to/installation/pim-enterprise-standard/bin/console akeneo:rule:run --env=prod > /path/to/installation/pim-enterprise-standard/var/logs/rule_run.log 2>&1

Note

> /path/to/installation/pim-enterprise-standard/var/logs/calculate_completeness.log 2>&1 is to redirect both stdout and stderr to your log file.

Note

The completeness is already recalculated automatically after an import, a mass action, after the rules are executed, after a family edition and after a product is saved.

Warning

Since some tasks may take a long time to be executed, adapt the frequency of these tasks according to your needs, to your server capabilities and to your catalog size.

Launching the daemon for job execution¶

Launch a daemon in order to execute the jobs. Please follow this documentation: Setting up the job queue daemon.

Testing your installation¶

Access the web folder using your favorite web browser and log in with admin/admin. If you see the dashboard, congratulations, you have successfully installed Akeneo PIM! You can also access the dev environment using app_dev.php as index.

If an error occurs, it means that something went wrong in one of the previous steps. Please check error outputs of all the steps.

Known issues¶

  • with XDebug on, the default value of max_nesting_level (100) is too low and can make the ACL loading fail (which causes 403 HTTP response code on every application screen, even the login screen). A working value is 500: xdebug.max_nesting_level=500
  • not enough memory can cause the JS routing bundle to fail with a segmentation fault. Please check with php -i | grep memory that you have enough memory according to the requirements
  • If you do install the PIM twice, ensure all the PIM cron tasks are stopped before the installation of the database, to avoid Base table or view not found errors.

What’s next?¶

Now you have an Akeneo PIM up and running. But maybe you want more! What about these topics?

  • You can switch to the minimal dataset or import your own data by following How to customize the Dataset.
  • You can add additional translations by following How to Add Translation Packs.

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