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.
Getting your Akeneo Partners Portal or Customers Portal Access¶
Akeneo Portals login credentials are sent to you by email. If you haven’t received it you can request one at: http://helpdesk.akeneo.com/
- If you are a customer, you will use the Customers Portal
- If you are a system integrator or a partner, you will use the Partners Portal
Once connected, it’s important to know that portal users can be members of two types of roles:
- Supervisor: to manage the project and give access to developers
- Developers: to request a bootstrap archive, and have access to the enterprise source code distribution
Only Supervisors can create new Developers (user assigned to Developer group) by going to My Company > Contacts > Add Contact > Saving > Activating it (by clicking on the red X).
Adding Permissions into the Project¶
Supervisor user has to add the allowed user to get the bootstrap into the Permission Box under the Project.
- Go to Activities menu, Projects
- Choose the corresponding project
- Edit the permission box with the white pen in a blue button
- Add contact
- Save (it will send an email to the given users letting them know that their access to the project is ready)
Only Users created under the account, with a Supervisor or a Developer profile are going to be listed.
If you are not a Supervisor, you should contact that person to be added under the permissions. You can check who the Supervisor is in your company by going in My Company > General Information and under the section Supervisors you will see them listed.
Requesting an Archive on the Portal¶
Once the users are authorized under the Permissions in the project, they will be able to see the download button on the project.
- Go to Projects under Activities menu.
- Choose the corresponding project.
- Look for the Version button on the right side of the screen.
- Click on it, you’ll be prompted to select one PIM EE version.
Once this is done, you should see a completeness message. Bootstrap archive will be send to your email in the following 5 minutes. Sometimes it could take a bit more, but always check your Spam folder before requesting the bootstrap again.
We strongly recommend you to choose the latest version.
Extracting the archive¶
$ mkdir -p /path/to/installation $ tar -xvzf pim-enterprise-standard-v2.0.tar.gz -C /path/to/installation/
Replace /path/to/installation by the path to the directory where you want to install the PIM.
Replace pim-enterprise-standard-v2.0.tar.gz by the location and the name of the archive you have downloaded from Partner portal
The PIM will be extracted in the folder /path/to/installation/pim-enterprise-standard.
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.
$ cd /path/to/installation/pim-enterprise-standard
$ php -d memory_limit=3G ../composer.phar install --optimize-autoloader --prefer-dist $ yarn install
$ php bin/console cache:clear --no-warmup --env=prod $ php bin/console pim:installer:assets --symlink --clean --env=prod
$ bin/console pim:install --force --symlink --clean --env=prod $ yarn run webpack
../composer.phar install command writes the database configuration to
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.
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 3 commands to your local installation:
1 2 3
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
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
> /path/to/installation/pim-enterprise-standard/var/logs/calculate_completeness.log 2>&1 is to redirect both stdout and stderr to your log file.
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.
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.
- 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:
- not enough memory can cause the JS routing bundle to fail with a segmentation fault. Please check with
php -i | grep memorythat 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.
Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!