Type
magento2-module
Dev composer package for Ometria Extension
magento2-module
None
None
None
None
None
None
None
While you're free to manually install the Ometria extension (and the use of the app/code
folder structure supports this), we recommend using Magento's PHP composer integration to install the extension. All Magento 2 systems have a composer.json
file, and this file is how developers and Magento Marketplace users get new packages in and out of their system.
Installing the extension is a X step process
ometria/magento2
composer package to your projectIf you have concerns or questions, please send an email to [email protected] with all relevant details that are needed to investigate or resolve an issue.
After backing up your composer.json file
cp composer.json composer.json.bak
Run
composer.phar config repositories.ometria vcs https://github.com/Ometria/magento2-extension
composer require ometria/magento2 --no-update
composer update ometria/magento2
php bin/magento module:enable Ometria_AbandonedCarts Ometria_Api Ometria_Core
php bin/magento setup:upgrade
After running the above, the Ometria extension will be installed, ready for configuration.
The first composer command
composer.phar config repositories.foo vcs https://github.com/Ometria/magento2-extension
add this GitHub repository as a composer repository
#File: composer.json
//...
"repositories": {
"ometria": {
"type": "vcs",
"url": "https://github.com/Ometria/magento2-extension"
}
},
//...
This tells composer it should look for additional packages in this GitHub repository.
The second command
composer require ometria/magento2 --no-update
add the latest stable version of ometria/magento2
to your composer.json
file's require
section.
#File: composer.json
//...
"require": {
//...
"ometria/magento2": "^1.3"
},
//...
The third command
composer update ometria/magento2
Updates any composer packages that match the string ometria/magento2
. This is what triggers the download of the Ometria extension source code to vendor/ometria
.
The final two commands are Magento commands. This command enables the three modules that make up the Ometria extension
php bin/magento module:enable Ometria_AbandonedCarts Ometria_Api Ometria_Core
Once a module is enabled, the rest of Magento can "see" it. The last command tells Magento to actually install the module.
php bin/magento setup:upgrade
Important: Changing a Magento system running in production is not a recommended practice. Depending on your system software, or other running extensions, running setup:upgrade
may trigger undesired behaviors. As will installing any new software on your system, don't forget to take appropriate backup steps, and to test your new module in a development or staging environment before deploying to production.