Installation¶
Warning
Before starting the installation process, make sure you’ve fulfilled all the prerequisites
Add the extension dependency to your PIM¶
Execute the following composer commands to require the bundle:
composer config repositories.onboarder '{"type": "vcs", "url": "ssh://git@distribution.akeneo.com:443/pim-onboarder"}'
composer require "akeneo/pim-onboarder" "^4.1"
Enable the extension¶
Register the newly installed PIM Onboarder bundle in your config/bundles.php
return [
// Add your bundles here with the associated env.
// Ex:
// Acme\Bundle\AppBundle\AcmeAppBundle::class => ['dev' => true, 'test' => true, 'prod' => true]
Akeneo\Onboarder\Bundle\PimOnboarderBundle::class => ['all' => true],
];
Build the UI¶
Execute the following command to build the UI:
bin/console pim:installer:assets --clean --env=prod && yarn run webpack
Make the credential files accessible to Akeneo PIM software¶
In the parameters package the Akeneo team put a serviceAccount.json credential file used for Google Cloud PubSub and Google Cloud Storage authentication
Make sure this file is shipped to the server which is hosting your PIM.
This file must be accessible (read rights) by the system user that runs the pim (example: www-data).
Set the configuration values¶
To configure your PIM to work with the Onboarder, we use environment variables.
How to define environment variables
Here are two examples in order to define environment variables:
Warning
All the following variables must be set in order to configure the Onboarder correctly for all entrypoints, all processes that runs the PIM code source.
Variables provided by the Akeneo team
| GOOGLE_APPLICATION_CREDENTIALS | Absolute filesystem path to the serviceAccount.json file provided by the Akeneo team. We advise to use it only in production. |
| ONBOARDER_TOPIC_NAME_FOR_PUBLICATION_TO_MIDDLEWARE | Pub/Sub topic name to send messages to the middleware. |
| ONBOARDER_TOPIC_NAME_FOR_PUBLICATION_TO_ONBOARDER | Pub/Sub topic name to send messages to the supplier Onboarder. |
| ONBOARDER_TOPIC_NAME_FOR_CONSUMPTION | Pub/Sub topic name to receive messages from the middleware. |
| ONBOARDER_QUEUE_NAME | Pub/Sub queue name. |
| ONBOARDER_CLOUD_STORAGE_BUCKET_NAME | Identifier of the bucket used to share files between your PIM and the middleware. |
Optional variables
| PUBSUB_EMULATOR_HOST | Use this if you want to use a Pub/Sub emulator during development. In this case you don’t need the serviceAccount.json file neither set the GOOGLE_APPLICATION_CREDENTIALS variable. |
Setup database tables¶
Before setup the database, please run the following command to clear your cache and install new assets:
$ rm -rf var/cache; bin/console pim:install:asset --env=prod; yarn run webpack
The akeneo/pim-onboarder extension needs some extra tables. Please run the following command to install them:
$ php bin/console akeneo:onboarder:setup-database --env=prod
Warning
Once the installation done, please read the documentation about the synchronization.
Create Elasticsearch index for pre ref products¶
A new Elasticsearch index is needed for pre ref products. In order to create it, please run the following command:
$ bin/console akeneo:elasticsearch:reset-indexes --index pim_onboarder_pre_ref_product --env=prod
Warning
You do not need to reindex anything at this point, even if the reset-indexes command proposes you to do so.
Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!