Installation¶
This document provides step by step instructions to install the PIM on development workstations based on Ubuntu 12.10, 13.10 or 14.04.
The following instructions have been tested on fresh installations of Ubuntu 12.10, 13.10 and 14.04. The main difference between the distribution is the PHP version used (PHP 5.4 for Ubuntu 12.10 and PHP 5.5 for Ubuntu 13.10 and 14.04).
Note
Even if the instructions apply to Ubuntu 12.10, 13.10 and 14.04, the same process and requirements can be used for any PHP 5.4 or PHP 5.5 based Linux distribution.
Note
The instructions below apply on all the aforementioned Ubuntu versions, except if specified otherwise.
Prerequisites¶
In order to install Akeneo PIM, you will have to download the Akeneo PIM Standard Edition archive file from http://www.akeneo.com/download/
System installation¶
Before installing requirements, update repositories information:
1 | $ sudo apt-get update
|
Installing MySQL¶
1 | $ sudo apt-get install mysql-server
|
Installing Apache¶
1 | $ sudo apt-get install apache2
|
Installing PHP¶
1 2 | $ sudo apt-get install libapache2-mod-php5 php5-cli
$ sudo apt-get install php5-mysql php5-intl php5-curl php5-gd php5-mcrypt
|
Ubuntu 13.10 only
1 2 | $ sudo apt-get install php5-json
$ sudo ln -s /etc/php5/conf.d/mcrypt.ini /etc/php5/mods-available/
|
Ubuntu 13.10 and 14.04 only
1 | $ sudo php5enmod mcrypt
|
Installing PHP opcode and data cache¶
Ubuntu 12.10 only
1 | $ sudo apt-get install php-apc
|
Ubuntu 13.10 and 14.04 only
1 | $ sudo apt-get install php5-apcu
|
Note
PHP 5.5 provided in Ubuntu 13.10 and 14.04 comes with the Zend OPcache opcode cache. Only the data cache provided by APCu is needed.
System configuration¶
MySQL¶
- Creating a MySQL database and a user for the application
1 2 3 4 | $ mysql -u root -p
mysql> CREATE DATABASE akeneo_pim;
mysql> GRANT ALL PRIVILEGES ON akeneo_pim.* TO akeneo_pim@localhost IDENTIFIED BY 'akeneo_pim';
mysql> EXIT
|
PHP¶
- Setting up PHP Apache configuration
1 2 3 | $ sudo gedit /etc/php5/apache2/php.ini
memory_limit = 512M
date.timezone = Etc/UTC
|
- Setting up PHP CLI configuration
1 2 3 | $ sudo gedit /etc/php5/cli/php.ini
memory_limit = 768M
date.timezone = Etc/UTC
|
Note
Use the time zone matching your location, for example America/Los_Angeles, Europe/Berlin. See http://www.php.net/timezones for the list of all available timezones.
Apache¶
To avoid spending too much time on permission problems between the CLI user and the Apache user, an easy configuration is to use the same user for both processes.
Get your identifiers¶
1 2 | $ id
uid=1000(my_user), gid=1000(my_group), ...
|
In this example, the user is my_user and the group is my_group.
Use your identifiers for Apache¶
1 2 3 4 5 | $ sudo service apache2 stop
$ sudo gedit /etc/apache2/envvars
export APACHE_RUN_USER=my_user
export APACHE_RUN_GROUP=my_group
$ sudo chown -R my_user /var/lock/apache2
|
Restart Apache¶
1 | $ sudo service apache2 start
|
Installing Akeneo PIM¶
Extracting the archive¶
1 2 | $ cd /path/to/installation
$ tar -xvzf /path/to/pim-community-standard-version.tar.gz
|
Note
Replace /path/to/installation by the path to the directory where you want to install the PIM.
Replace /path/to/pim-community-standard-version.tar.gz by the location and the name of the archive you have downloaded from http://www.akeneo.com/download.
Warning
After the extraction, a new directory usually called pim-community-standard-version is created inside the /path/to/installation directory.
This will be our PIM root directory and will be referred to as /path/to/pim/root in the following instructions.
Installing the vendors¶
- First, you need to get composer. Install it in /path/to/pim/root:
1 | $ curl -sS https://getcomposer.org/installer | php
|
- Then, install the vendors:
1 | $ php ./composer.phar install
|
Installing MongoDB and enabling it is as catalog storage¶
The following steps are optional. Follow them only if you want use the MongoDB catalog storage
Installing MongoDB¶
1 2 3 4 | $ sudo apt-key adv --keyserver keyserver.ubuntu.com --recv 7F0CEB10
$ sudo echo deb http://downloads-distro.mongodb.org/repo/debian-sysvinit dist 10gen | sudo tee /etc/apt/sources.list.d/mongodb-10gen.list > /dev/null
$ sudo apt-get update
$ sudo apt-get install mongodb-10gen=2.4.14
|
Note
Akeneo PIM may work with more recent versions of MongoDB, but we strongly advise you to use this one.
To avoid updates, you can freeze the version with, for apt/dpkg: sudo echo "mongodb-10gen hold" | sudo dpkg --set-selections or for aptitude: sudo aptitude hold mongodb-10gen
Installing MongoDB PHP driver¶
Ubuntu 12.10 & 13.10 only
1 2 3 | sudo apt-get install php-pear build-essential php5-dev
sudo pecl install mongo
sudo echo "extension=mongo.so" | sudo tee /etc/php5/conf.d/mongo.ini > /dev/null
|
Ubuntu 14.04 only
1 | $ sudo apt-get install php5-mongo
|
Installing and enabling MongoDB support in Akeneo¶
- Install the required dependency:
1 2 3 | $ cd /path/to/pim/root
$ php ./composer.phar --prefer-dist require doctrine/mongodb-odm v1.0.0-beta12@dev
$ php ./composer.phar --prefer-dist require doctrine/mongodb-odm-bundle v3.0.0-BETA6@dev
|
- In app/AppKernel.php, uncomment the following line (this will enable DoctrineMongoDBBundle and will load and enable the MongoDB configuration):
1 2 | $ gedit app/AppKernel.php
new Doctrine\Bundle\MongoDBBundle\DoctrineMongoDBBundle(),
|
- Set MongoDB server configuration at the end of the configuration file
1 2 3 4 5 6 | $ gedit app/config/pim_parameters.yml
pim_catalog_product_storage_driver: doctrine/mongodb-odm
mongodb_server: 'mongodb://localhost:27017'
mongodb_database: your_mongo_database
|
Initializing Akeneo¶
1 2 3 | $ cd /path/to/pim/root
$ php app/console cache:clear --env=prod
$ php app/console pim:install --env=prod
|
Configuring the virtual host¶
Enabling Apache mod_rewrite¶
1 | $ sudo a2enmod rewrite
|
Creating the vhost file¶
1 | $ sudo gedit /etc/apache2/sites-available/akeneo-pim.local.conf
|
Ubuntu 12.10 only
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | <VirtualHost *:80>
ServerName akeneo-pim.local
DocumentRoot /path/to/pim/root/web/
<Directory /path/to/pim/root/web/>
Options Indexes FollowSymLinks MultiViews
AllowOverride All
Order allow,deny
allow from all
</Directory>
ErrorLog ${APACHE_LOG_DIR}/akeneo-pim_error.log
LogLevel warn
CustomLog ${APACHE_LOG_DIR}/akeneo-pim_access.log combined
</VirtualHost>
|
Ubuntu 13.10 and 14.04 only
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | <VirtualHost *:80>
ServerName akeneo-pim.local
DocumentRoot /path/to/pim/root/web/
<Directory /path/to/pim/root/web/>
Options Indexes FollowSymLinks MultiViews
AllowOverride All
Require all granted
</Directory>
ErrorLog ${APACHE_LOG_DIR}/akeneo-pim_error.log
LogLevel warn
CustomLog ${APACHE_LOG_DIR}/akeneo-pim_access.log combined
</VirtualHost>
|
Note
The differences in Virtual Host configuration between Ubuntu 12.10 and Ubuntu 13.10/14.04 are the result of the switch from Apache 2.2 to Apache 2.4. See https://httpd.apache.org/docs/2.4/upgrading.html for more details.
Enabling the virtualhost¶
1 2 3 | $ sudo a2ensite akeneo-pim.local
$ sudo apache2ctl -t
$ sudo service apache2 restart
|
Adding the vhost name¶
1 2 | $ sudo gedit /etc/hosts
127.0.0.1 akeneo-pim.local
|
Configuring tasks via crontab¶
The application needs the following tasks to be executed in background on a regular basis:
1 2 3 4 5 6 | # for CE & EE
/path/to/php /path/to/pim/root/app/console pim:completeness:calculate --env=prod # recalculates the products completeness
/path/to/php /path/to/pim/root/app/console pim:versioning:refresh --env=prod # processes pending versions
# for EE only
/path/to/php /path/to/pim/root/app/console akeneo:rule:run --env=prod # executes rules on products
|
Edit your crontab with crontab -e and configure each task. For example, the following line will run the completeness calculation every 15 minutes:
1 2 | # m h dom mon dow command
*/15 * * * * /path/to/php /path/to/pim/root/app/console pim:completeness:calculate --env=prod > /path/to/pim/root/app/logs/calculate_completeness.log 2>&1
|
Note
> /path/to/pim/root/app/logs/calculate_completeness.log 2>&1 is to redirect both stdout and stderr to your log file.
Note
Remember that dev is the default environment when you launch a Symfony command, so always add --env=prod in prod environment to avoid useless logging and profiling.
Warning
Adapt the frequency according to your needs, your server capabilities and your catalog size as some tasks may have a long execution time.
Testing your installation¶
Go to http://akeneo-pim.local/ 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 on http://akeneo-pim.local/app_dev.php
If you have an error, 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
- some segmentation fault and zend_mm_heap corrupted error can be caused as well by the circular references collector. You can disable it with the following setting in your php.ini files: zend.enable_gc = 0
- When installing with php composer.phar create-project... command, error about Unable to parse file “<path>/Resources/config/web.xml”.. It seems an external issue related to libxml, you can downgrade to libxml2.x86_64 0:2.6.26-2.1.21.el5_9.1. Look at: http://www.akeneo.com/topic/erreur-with-php-composer-phar-beta4/ for more informations.
Generating a clean database (optional)¶
By default, when you install the PIM, the database is pre-configured with demo data.
If you want to get only the bare minimum of data to have a clean but functional PIM, just change the following config line in app/config/parameters.yml:
installer_data: PimInstallerBundle:minimal
Then clean the cache and relaunch the install with the db option:
php app/console pim:installer:db --env=prod
Add translation packs (optional)¶
Akeneo PIM UI is translated through Crowdin http://crowdin.net/project/akeneo (feel free to contribute!).
Each week, new translation keys are pushed to Crowdin, and new validated translations are pulled to our Github repository.
Akeneo PIM contains translation packs for all languages with more than 80% of translated keys.
When we tag a new minor or patch version, the new translations are available.
You can directly download translation packs from Crowdin.
The Akeneo PIM archive will contain a ‘Community’ and ‘Enterprise’ directories.
To add a pack you have to :
- rename the directories by following the rule ‘src/Pim/Bundle/EnrichBundle’ to ‘PimEnrichBundle’
- move this directory to app/Resources/
- run php app/console oro:translation:dump fr de en (if you use en, fr and de locales)