Thank you for choosing a Magearmy Magento 2 Extension! To ensure proper installation and functionality, please follow the steps below carefully.

Steps to Install an Extension Purchased from Our Website

1. Requirements

Before starting the installation, make sure your system meets the following requirements:

• Magento Open Source or Adobe Commerce 2.4.x
• PHP 8.1 or higher
• Composer 2.x
• Access to your Magento file system (SSH or FTP)

2. Install Core Module Dependency

All Magearmy extensions depend on the Magearmy Core Module. You must install this module first before installing any other Magearmy extensions.

Download the Core Module: https://github.com/themagearmy/magento2-module-core

You can install it via Composer or manually.

3. Install Actual Module

• Download the extension as a .zip file from your Magearmy Customer Account
• Use an FTP/SFTP client (e.g., FileZilla, WinSCP) or connect via SSH to access your server.
• In your Magento installation root, navigate to the app/code/ directory and create the necessary vendor and module folders.
  
  
  • The path will be app/code/Magearmy/[ExtensionName]
  • For example, if the extension name is Faq, you would create mkdir -p app/code/Magearmy/Faq
  • You can find the correct [ExtensionName] (e.g., Faq, GiftCard, ProductLabels) in the registration.php file included in your extension package.
    
    
• Upload the downloaded .zip file to a temporary directory on your server (for example /tmp/), or directly to app/code/Magearmy/[ExtensionName]
• Then extract its contents into that directory. Ensure the file structure looks like this app/code/Magearmy/[ExtensionName]/etc/module.xml
• Run Magento CLI Commands
  
  
  • php bin/magento module:enable Magearmy_[ExtensionName]
  • php bin/magento setup:upgrade
  • php bin/magento setup:di:compile
  • php bin/magento setup:static-content:deploy -f
  • php bin/magento cache:flush

4. Verify Installation

Check that both modules are enabled

php bin/magento module:status

You should see both

Magearmy_Core
Magearmy_[ExtensionName]

Please note that this is a general installation guide for installing the MageArmy extension in your Magento 2 store. For a guide specific to the extension, please refer to the README.md file included with the extension.

Steps to Install an Extension Purchased from Adobe Commerce Marketplace

1. Requirements

Before starting the installation, make sure your system meets the following requirements:

• Magento Open Source or Adobe Commerce 2.4.x
• PHP 8.1 or higher
• Composer 2.x
• Access to the Marketplace account

2. Get your Marketplace Access Keys

• Log in to your marketplace account with the same credentials you used while purchasing the extension.
• Go to My Profile from the top right corner.
• Go to Access Keys page.
• On that screen, you will find your access keys. If you haven't previously purchased or installed any extensions, you might need to create a new access key.

3. Retrieve the name of your purchased Extension Composer package

• Go to My Purchases page.
• On that screen, you will find your purchased extension. Below the component name, you will see your composer name. You need to provide the composer name and the access keys to your webmaster or developer to install the extension.

4. Install Extension using Composer

Once you have the composer component name, run the following commands in the same order to install the extension.

• To install a specific version of a package, use the command composer require followed by the package name and version. For example, if your package name is themagearmy/module-order-success-page, you should run
• composer require themagearmy/module-order-success-page:1.0.1
• If you encounter an error about themagearmy/module-core not being found or a related issue, install Magearmy's core module explicitly using the composer command, then run the command again.
• composer require themagearmy/module-core
• composer require themagearmy/module-order-success-page:1.0.1
• It will prompt you for a username and password. The username is your public key, and the password is your private key. If these keys are already stored on your application server, it won't ask and will install the extension directly.
• php bin/magento module:enable Magearmy_[ExtensionName]
• php bin/magento setup:upgrade
• php bin/magento setup:di:compile
• php bin/magento setup:static-content:deploy -f
• php bin/magento cache:flush

5. Verify Installation

Check that both modules are enabled

• php bin/magento module:status

You should see both

• Magearmy_Core
• Magearmy_[ExtensionName]

Need Help with Installation?

If you encounter any issues or difficulties while installing our extension, please don't hesitate to contact our support. We are happy to help you get the extension working smoothly. When submitting a support request, please provide as many details as possible, including any error messages you are receiving.