How to download and install the connector?

Summary

Where can I get Akeneo Connector for Adobe Commerce?

There are 2 different versions of Akeneo Connector for Adobe Commerce:

Please note that this free open source version of Akeneo Connector for Adobe Commerce won't give you access to official support and maintenance from Akeneo.

 

This version is available directly from our Public Github repository.

Please contact us to get access to our Private Github repository where the supported version of the connector is hosted.

Akeneo teams will get back to you with the process to install your connector via our Partner Portal and how to benefit from Akeneo Support.

How to install the connector?

Install "Akeneo Connector for Adobe Commerce Enterprise Edition"

Pre-requisites:

Because the Akeneo Connector for Adobe Commerce is hosted on the Project Console of the Akeneo portal, as Project manager, you need to check that:

  1. You have access to the connector (if you have not already done so).
  2. You have created your developer in your organization (The person who will install the connector) and have given him access to the project Console.
  3. This developer has declared his SSH key on his profile and that you have given him the access rights to the Enterprise Repository.
  4. Because the connector is an Adobe Commerce module and is available in our Enterprise Repository, be sure that your developer connects to your Adobe Commerce server with his SSH key (the same SSH key you configured in our Akeneo portal) before starting to type the following commands.

Please read the Adobe Commerce documentation on how to configure your SSH key in Adobe Commerce.

Install the module with Composer as follows:


 composer config repositories.magento2-connector-enterprise '{"type": "vcs", "url": "ssh://git@distribution.akeneo.com:443/magento2-connector-enterprise"}'
 

Then:


 composer require "akeneo/magento2-connector-enterprise" "103.*"
 

Enable the module in Adobe Commerce:


 php bin/magento module:enable Akeneo_Connector
 

Check and update database setup:


 php bin/magento setup:db:status
 

 php bin/magento setup:upgrade
 

Flush Adobe Commerce caches:


 php bin/magento cache:flush
 

Upgrade "Akeneo Connector for Adobe Commerce Enterprise Edition"

In order to upgrade your connector version, you can either:

  • Upgrade to a specific version:

 composer require "akeneo/magento2-connector-enterprise" "103.*"
 
  • Or upgrade directly to the latest version:

 composer update akeneo/magento2-connector-enterprise
 

Then, update database setup:


 php bin/magento setup:upgrade
 

And finally flush Adobe Commerce caches:


 php bin/magento cache:flush
 

Install "Akeneo Connector for Adobe Commerce Community Edition"

Because the connector is a module for Adobe Commerce, you must connect with SSH and have the correct access to your Adobe Commerce server to install the connector.

Install the module with Composer as follows:


 composer require akeneo/module-magento2-connector-community
 

Enable the module in Adobe Commerce:


 php bin/magento module:enable Akeneo_Connector
 

Check and update database setup:


 php bin/magento setup:db:status
 

 php bin/magento setup:upgrade
 

Flush Adobe Commerce caches:


 php bin/magento cache:flush
 

Upgrade "Akeneo Connector for Adobe Commerce Community Edition"

In order to upgrade your connector version, you can either:

  • Upgrade to a specific version:

 composer require "akeneo/module-magento2-connector-community" "103.*"
 
  • Or upgrade directly to the latest version:

 composer update akeneo/module-magento2-connector-community
 

Then, update database setup:


 php bin/magento setup:upgrade
 

And finally flush Adobe Commerce caches:


 php bin/magento cache:flush
 

How to install the connector on an Adobe Commerce cloud environment?

As Akeneo Connector for Adobe Commerce is an extension installed on Adobe Commerce, you just need to follow Adobe Commerce documentation on how to install an extension on a Adobe Commerce cloud environment.

Also, make sure to enable the deploy key of your Adobe Commerce Cloud environment inside the Akeneo Portal. To get your Adobe Commerce Cloud environment deploy key, go to your Adobe Commerce Cloud account under:

  • Configure environment (with the gear icon)
  • Then, go in the Deploy key tab
  • And copy the deploy key under SSH key to access external private code repositories pulled during the build process.
  • Once you have the key, follow this guide to enable the key in the Akeneo portal

What can I do if I have a question to ask, a bug to report or a suggestion to make about the Connector?

On "Akeneo Connector for Adobe Commerce Enterprise Edition"

Please use our Helpdesk platform to contact us.

In the case of a "bug" report, please install the latest version of the Connector, also please disable all customisations and try to reproduce the bug again before reporting it.

If the problem occurs with the latest version of Akeneo Connector for Adobe Commerce, feel free to report the bug to us.

Please make sure you have all this information before you open a ticket on our Helpdesk:

  • The exact version of your PIM (x.x.x) (System -> System information)
  • The exact version of your Adobe Commerce (x.x.x) (At the bottom right of your Adobe Commerce Dashboard Homepage)
  • The version of the installed Connector (which you can find on the connector configuration page)
  • Steps to reproduce the bug (be as precise as possible).
  • A screenshot of the whole connector configuration page.
  • A screenshot of the issue.

And if it's possible for you:

  • Add the following Adobe Commerce log files too:
    • var/log/system.log and var/log/exception.log
    • var/report : any file in this directory might be useful

For our Support team to be able to take this issue into account, steps to reproduce should be performed in a non-customized environment on both Akeneo and Adobe Commerce sides, with a vanilla connector (without customizations).

 

On "Akeneo Connector for Adobe Commerce Community Edition"

Please note that we do not offer SLA-backed support on the Community Edition of Akeneo Connector for Adobe Commerce but you can use our Public Github repository to request help from our Community of users.