Magento Integration

Magento module for Katalys integration. This is required only when doing the first installation.

Installation

Step 1

Run the following command to install the package using https://getcomposer.org/ :

CODE

composer require katalys/magento-bridge-module
php bin/magento module:enable Katalys_Shop
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

Here is the result:

If the installation requests the token, click on the link and GitHub will create the token for you; else, continue with the installation process.

Step 2

Enable your module:

JS

www-data@katalys-magento243-php-fpm:/var/www/html$ bin/magento module:enable Katalys_Shop
No modules were changed.
www-data@katalys-magento243-php-fpm:/var/www/html$ |

Step 3

Execute the command below:

CODE

www-data@katalys-magento243-php-fpm:/var/www/html$bin/magento setup:upgrade

Here is the result:

Step 4

Execute the command below to compile Magento:

JS

www-data@katalys-magento243-php-fpm:/var/www/html$ php bin/magento setup:di:compile

Here is the result:

Step 5

Execute the command below to compile the theme of the Magento:

JS

www-data@katalys-magento243-php-fpm:/var/www/html$ php bin/magento setup:static-content:deploy -f

Here is the result:

Next Steps:

Proceed to the next required step Katalys Integration to install and customize the Katalys plugin.

How to Update

To update this module, run the following command:

CODE

composer update katalys/magento-bridge-module

Note that this will also update any other packages in the project according to composer definition. Depending on the nature of the update, the following commands may also be required:

CODE

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

Version Rollback

If you experience an error with the newly installed plugin, you can revert to the last version. If you install version 1.0.1 and need to rollback to the last version that worked 1.0.0, reference the example below:

CODE

composer require katalys/magento-bridge-module:1.0.0
bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
php bin/magento setup:di:compile

If after rolling back to the prior version you experience an error, please send an email describing the issue. In the email, please provide the below information:

Magento version
Module Version
PHP version
Description the error
Step-by-step instructions that led to the error
Screenshots ( and on-screen recording, if possible )

Send the email to techsupport@katalys.com

Removal

Run the following command to remove the package using Composer:

CODE

php bin/magento module:disable Katalys_Shop
composer remove katalys/magento-bridge-module
php bin/magento setup:static-content:deploy
php bin/magento setup:di:compile