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:

$ composer create-project akeneo/pim-community-standard /srv/pim "6.0.*@stable"

or download an archive containing Akeneo PIM and its PHP dependencies: https://download.akeneo.com/pim-community-standard-v6.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¶

Note

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

To run the PIM EE in dev mode without docker, you will need to change some configuration files:

$ cp vendor/akeneo/pim-enterprise-dev/config/packages/prod_onprem/oneup_flysystem.yml config/packages/dev/
$ cp vendor/akeneo/pim-enterprise-dev/config/packages/prod_onprem/messenger.yml config/packages/dev/

You can then launch the install with the following command:

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

Warning

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:connectivity-connection:purge-error`	10 * * * *	Every hour
`akeneo:batch:purge-job-execution`	20 0 1 * *	At 12:20 AM, every first day of the month
`akeneo:connectivity-audit:purge-error-count`	40 12 * * *	At 12:40 AM
`pim:volume:aggregate`	30 4 * * *	At 04:30 AM
`pim:data-quality-insights:schedule-periodic-tasks`	15 0 * * *	At 00:15 AM
`pim:data-quality-insights:prepare-evaluations`	/10 * * *	Every 10 minutes
`pim:data-quality-insights:evaluations`	/30 * * *	Every 30 minutes
`akeneo:messenger:doctrine:purge-messages messenger_messages default`	0 /2 * *	Every 2 hours
`akeneo:connectivity-connection:purge-events-api-logs`	5 * * * *	Every hour
`akeneo:connectivity-connection:openid-keys:create`	0 0 * * 0	Every week

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`	0 23 * * *	At 11:00 PM
`pimee:sso:rotate-log 30`	30 2 * * *	At 02:30 AM

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