Installing Akeneo PIM with Docker¶

Akeneo maintains its own Docker images in https://github.com/akeneo/Dockerfiles. This document provides step by step instructions to install the PIM with Docker, using these images.

Warning

These images are built for development and testing purposes only, and are not intended for production.

Note

These instructions are valid for community edition as well as the enterprise edition.

Note

These instructions assume you already have Docker and Docker Compose installed, in their most recent version. If not, please refer to this documentation.

Getting Akeneo PIM¶

You first need to download Akeneo PIM. This can be done by downloading the archive from our download page https://www.akeneo.com/download, or from our partner portal if you have access to the enterprise edition. It can also be by cloning it from GitHub (https://github.com/akeneo/pim-community-standard for projects or https://github.com/akeneo/pim-community-dev to contribute).

Using the Docker images¶

Every flavor (dev or standard, community or enterprise) come with a Docker Compose file template docker-compose.yml.dist, ready to be used. Copy it as docker-compose.yml and keep it at the root of your project. You may modify it at your convenience, to change the mapping of the ports if you want Apache to be accessible from port other that 8080, for instance).

If you intend to run behat tests, create on your host a folder /tmp/behat/screenshots (or anywhere else according to your compose file) with full read/write access to your user. Otherwise docker-compose will create it, but only with root accesses. Then failing behats will be unable to create reports and screenshots.

Run and stop the containers¶

All “docker-compose” commands are to be ran from the folder containing the compose file.

To start your containers, just run:

$ docker-compose up -d

To stop the containers, run:

$ docker-compose stop

but if you want to completely remove everything (containers, networks and volumes), then run:

$ docker-compose down -v

This, of course, will not delete the Akeneo application you cloned on your machine, only the Docker containers. However, it will destroy the database and everything it contains.

Install and run Akeneo¶

Configure Akeneo¶

First, make sure that Akeneo database settings are as the containers expect. As you can see below, the database_host is the name of your MySQL service in the compose file. For Elasticsearch, index_hosts is the association of the login and password (elastic and changeme, respectively) of the container, the service name in the compose file (elasticsearch) and the output port of Elasticsearch (9200).

# /host/path/to/you/pim/app/config/parameters.yml
parameters:
    database_driver: pdo_mysql
    database_host: mysql
    database_port: null
    database_name: akeneo_pim
    database_user: akeneo_pim
    database_password: akeneo_pim
    locale: en
    secret: ThisTokenIsNotSoSecretChangeIt
    product_index_name: akeneo_pim_product
    product_model_index_name: akeneo_pim_product_model
    product_and_product_model_index_name: akeneo_pim_product_and_product_model
    index_hosts: 'elastic:changeme@elasticsearch:9200'

# /host/path/to/you/pim/app/config/parameters_test.yml
parameters:
    database_driver: pdo_mysql
    database_host: mysql-behat
    database_port: null
    database_name: akeneo_pim
    database_user: akeneo_pim
    database_password: akeneo_pim
    locale: en
    secret: ThisTokenIsNotSoSecretChangeIt
    installer_data: PimInstallerBundle:minimal
    product_index_name: behat_akeneo_pim_product
    product_model_index_name: behat_pim_product_model
    product_and_product_model_index_name: behat_pim_product_and_product_model
    index_hosts: 'elastic:changeme@elasticsearch:9200'

Note

You only need to set parameters_test.yml if you are using akeneo/pim-community-dev or akeneo/pim-enterprise-dev. It is not mandatory for using the standard edition.

Install Akeneo¶

Now, you can initialize Akeneo by running:

$ bin/docker/pim-dependencies.sh
$ bin/docker/pim-initialize.sh

Those two bash scripts are just helpers placed in the PIM, in the folder bin/docker. They execute the following commands (you could do so too if you prefer):

pim-dependencies.sh

$ docker-compose exec fpm composer update
$ docker-compose run --rm node yarn install

pim-initialize.sh

This is what the script contains in akeneo/pim-community-dev or akeneo/pim-enterprise-dev:

$ docker-compose exec fpm bin/console --env=prod cache:clear --no-warmup    # Those 4 commands clears all the caches of Symfony 3
$ docker-compose exec fpm bin/console --env=dev cache:clear --no-warmup     # You could also just perform a "rm -rf var/cache/*"
$ docker-compose exec fpm bin/console --env=behat cache:clear --no-warmup
$ docker-compose exec fpm bin/console --env=test cache:clear --no-warmup

$ docker-compose exec fpm bin/console --env=prod pim:install --force --symlink --clean
$ docker-compose exec fpm bin/console --env=behat pim:installer:db          # Run this command only if you want to run behat or integration tests

$ docker-compose run --rm node yarn run webpack

The version in akeneo/pim-community-standard or akeneo/pim-enterprise-standard is simpler as it is not intended to run tests:

$ docker-compose exec fpm bin/console --env=prod cache:clear --no-warmup

$ docker-compose exec fpm bin/console --env=prod pim:install --force --symlink --clean

$ docker-compose run --rm node yarn run webpack

Xdebug¶

Xdebug is deactivated by default. If you want to activate it, you can turn the environment variable PHP_XDEBUG_ENABLED to 1. Then you just have to run docker-compose up -d again.

Also, you can configure two things on Xdebug through environment variables on akeneo/fpm image. These environment variables are all optional. - PHP_XDEBUG_IDE_KEY: the IDE KEY you want to use (by default XDEBUG_IDE_KEY) - PHP_XDEBUG_REMOTE_HOST: your host IP address (by default it allows all IPs)

You should now be able to access Akeneo development environment from your host through http://localhost:8080/ and behat environment through http://localhost:8081/ (of course, you can change the host port in the compose file).

Run behat tests¶

The tests are to be run inside the containers. Start by configuring Behat as follows:

# /host/path/to/your/pim/behat.yml
default:
    paths:
        features: features
    context:
        class:  Context\FeatureContext
        parameters:
            base_url: 'http://httpd-behat/'
            timeout: 10000
            window_width: 1280
            window_height: 1024
    extensions:
        Behat\MinkExtension\Extension:
            default_session: symfony2
            show_cmd: chromium-browser %s
            selenium2:
                wd_host: 'http://selenium:4444/wd/hub'
            base_url: 'http://httpd-behat/'
            files_path: 'features/Context/fixtures/'
        Behat\Symfony2Extension\Extension:
            kernel:
                env: behat
                debug: false
        SensioLabs\Behat\PageObjectExtension\Extension: ~

You are now able to run behat tests.

$ docker-compose exec fpm vendor/bin/behat features/path/to/scenario

What if?¶

I want to see my tests running¶

The docker image selenium/standalone-firefox-debug comes with a VNC server in it. You need a VNC client, and to connect to localhost:5900. You will then be able to see you browser and your tests running in it!

I never want to see my tests running¶

In this case, you don’t need to have a VNC server in your selenium container.

You can achieve that simply by replacing the image selenium/standalone-firefox-debug by selenium/standalone-firefox. The first is based on the second, simply adding the VNC server.

Don’t forget to also remove the binding on port 5900, now useless as selenium/standalone-firefox does not expose it.

I want to run my tests in Chrome instead of Firefox¶

Then all you need to do is to replace the image selenium/standalone-firefox-debug by selenium/standalone-chrome-debug (or selenium/standalone-chrome if you don’t want to see the browser in action).