How to - Install a Module

Welcome to the installation guide for ERA's Magento 2 extensions. This guide will walk you through the process of installing a module on your Magento 2 store.

Pre-Installation Checklist

Before proceeding with the installation, ensure you have the following:

• Magento 2 installed on your server.
• Server access to run commands and upload files.
• The required dependencies as listed on the "About this module" page for the module you're installing.

Dependencies

Each module may require specific dependencies to function correctly. These dependencies are included in the package you receive. Refer to the "About this module" page associated with each module for a comprehensive list of required dependencies.

Installation

Composer

Composer is a tool for dependency management in PHP, allowing you to declare the libraries your project depends on and it will manage (install/update) them for you.

Obtain the Composer Key

Before you can install the module via Composer, you need an access key, which is a combination of a public and private key, associated with your user account.

1. Contact ERA support to request your Composer access keys for the Magento 2 extensions repository.
2. Once you have your keys, navigate to your Magento 2 root directory on your server.

Configure Authentication

You need to add the repository to your Magento project's composer.json file and provide your authentication keys.

3. Open the composer.json file in the Magento 2 root directory. In the repositories section add this code.

    {
        "type": "composer",
        "url": "https://repo.group-era.com"
    }

4. Open or create the auth.json file in the Magento 2 root directory.
5. Add the following configuration, replacing public-key and private-key with the keys provided by ERA support:

{
    "http-basic": {
        "repo.group-era.com": {
            "username": "public-key",
            "password": "private-key"
        }
    }
}

This file should be located in the same directory as your composer.json file.

Install the Module

6. Require the Magento 2 module using Composer with the following command:

composer require era/module-name

Replace era/module-name with the actual name of the module you wish to install.

Manual (app/code)

If you prefer or need to install the module manually, follow these steps:

1. Unzip the provided module file (e.g., ERA-eCommerce-BC-Live-Data-x.x.x.zip) onto your computer.
2. Connect to your server via FTP/SFTP or your preferred file management tool.
3. Navigate to the app/code directory within your Magento installation.
4. Upload the contents of the unzipped module folder to this directory.

Magento Setup Commands

After uploading the module files, run the following commands in the root directory of your Magento installation to register the module and deploy its components:

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

These commands will:

• Upgrade the database schema and data.
• Compile dependency injection configurations.
• Deploy static view files.
• Flush the Magento cache.

Post-Installation: Configuration and Verification

Once the installation process is complete:

1. Log in to the Magento Admin Panel.
2. Navigate to the ERA tab and look for the name-of-module section to verify the module is listed.
3. Configure the module as required for your store. Each module comes with a configuration guide under the module's settings.

Need Help?

Check our Support Page.