How to install Adobe Commerce Connector on Cloud

This guide will walk you through the process of installing StreamX Adobe Commerce Connector on your Adobe Commerce Cloud instance.

Prerequisites

Ensure you have the following before proceeding:

  • Running Adobe Commerce Cloud instance

  • Administrator account on the Adobe Commerce Cloud server

  • The magento-cloud command line tool installed and available in your system’s PATH

  • Administrator account on the Adobe Commerce Cloud web interface

  • A web browser of your choice

Step 1: Connect to your Adobe Commerce Cloud server and verify access

On your local machine, open a terminal and connect to your Adobe Commerce Cloud by running the following command:

magento-cloud ssh

After logging in to the server, ensure that you’re in the root directory of Adobe Commerce Cloud installation. The directory should contain the composer.json file and the bin/magento folder, among other files. If you’re in a different directory, browse to the correct one by using the cd command.

If you use a different method to log in to your Adobe Commerce Cloud server instead of magento-cloud ssh - that’s perfectly fine, provided you have access to the root directory described above.

Step 2: Install the streamx/magento-connector module on your Adobe Commerce Cloud instance

The StreamX Adobe Commerce Connector is a public package available on Packagist. It contains a Magento 2 module with internal name streamx/magento-connector. This means you can install the Connector on your Adobe Commerce Cloud instance simply by running the following command:

bin/composer require streamx/magento-connector
If the command prompts you for a GitHub access token, simply press ENTER - the source GitHub repository is public and does not require authentication.

The command will:

  • Update the composer.json file in your Adobe Commerce Cloud installation by adding streamx/magento-connector to the require section

  • Install the Connector and all its dependencies on your Adobe Commerce Cloud instance.

The command downloads the latest version of the Connector from Packagist, but you can also choose to install a previous version, for example: 
bin/composer require streamx/magento-connector:1.0.16

Step 3: Enable the Connector modules on your Adobe Commerce Cloud instance

The StreamX Adobe Commerce Connector, like any Magento 2 module, requires performing additional steps to be registered. The below commands enable the module, clear and refresh caches, apply database updates, and recompile the code for production readiness.

bin/magento module:enable StreamX_ConnectorCore
bin/magento module:enable StreamX_ConnectorCatalog
bin/magento cache:clean
bin/magento cache:flush
bin/magento setup:upgrade
bin/magento setup:di:compile
The Connector internally consists of two modules, which is why two separate module:enable commands are required.

Step 4: Verify installation

To verify if the installation was successful, follow these steps:

  1. Open your web browser and log in to the Adobe Commerce Cloud web interface with an administrator account

  2. Go to Stores → Configuration

  3. Verify if the left column contains a STREAMX / Connector configuration section

  4. Expand the Connector’s General Settings area and verify that the Connector is disabled.

The Connector is disabled by default because it requires additional configuration to establish a connection with StreamX. For more details, refer to the Related Content section.

Summary

Congratulations!
The StreamX Adobe Commerce Connector is now successfully set up and ready to use on your Adobe Commerce Cloud instance.

Related content