Install Akeneo PIM

#Installing Akeneo PIM Community Edition (CE)

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

#Getting Akeneo PIM

You can either use composer to create your project:

$ php -d memory_limit=4G /usr/local/bin/composer create-project --prefer-dist \
     akeneo/pim-community-standard /srv/pim "4.0.*@stable"

or download an archive containing Akeneo PIM and its PHP dependencies: https://download.akeneo.com/pim-community-standard-v4.0-latest-icecat.tar.gz

#Initializing Akeneo

Configure the PIM via the .env file:

APP_ENV=prod
APP_DATABASE_HOST=localhost
APP_DATABASE_PORT=null
APP_DATABASE_NAME=akeneo_pim
APP_DATABASE_USER=akeneo_pim
APP_DATABASE_PASSWORD=akeneo_pim
APP_INDEX_HOSTS='localhost:9200'

#Launching the PIM in dev mode

All make commands must be run from the PIM root directory, either created by the archive or from the composer create project above.

$ NO_DOCKER=true make dev

Once this command is finished, the PIM is accessible at http://localhost:8080/

#Launching the PIM in prod mode

$ NO_DOCKER=true make prod

Once this command is finished, the PIM is accessible at http://localhost:8080/

#Setup Akeneo

#Configuring Akeneo

Akeneo PIM is configured with environment variables. The Symfony documentation explains how to use them.

#Running jobs

Akeneo PIM implements a queue for the jobs, as a PHP daemon. This daemon is a Symfony command, that can only execute one job at a time. It does not consume any other job until the job is finished.

You can launch several daemons to allow the execution of several jobs in parallel. A daemon checks every 5 seconds the queue and executes the next job from the queue.

Follow the job queue daemon set up in this dedicated section.

#Cron jobs

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.

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

Community Edition and Enterprise Edition cron jobs:

Symfony console command Crontab frequency Human frequency
pim:versioning:refresh 30 1 * * * At 01:30 AM
pim:versioning:purge –more-than-days 90 30 2 * * * At 02:30 AM
akeneo:connectivity-audit:update-data 1 * * * * Every hour
akeneo:batch:purge-job-execution 20 0 1 * * At 12:20 AM, every first day of the month
pim:volume:aggregate 30 4 * * * At 04:30 AM

Additional Enterprise Edition cron jobs:

Symfony console command Crontab frequency Human frequency
akeneo:rule:run 0 5 * * * At 05:00 AM
pimee:project:notify-before-due-date 20 0 * * * At 12:20 AM
pimee:project:recalculate 0 2 * * * At 02:00 AM
akeneo:reference-entity:refresh-records –all 0 23 * * * At 11:00 PM
pimee:sso:rotate-log 10 30 2 * * * At 02:30 AM
pimee:data-quality-insights:schedule-periodic-tasks 15 0 * * * At 00:15 AM
pimee:data-quality-insights:evaluate-products */30 * * * * Every 30 minutes

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