Installing Modules via Composer

Thank you for choosing our Magento 2 extensions. To streamline the installation process, we recommend using Composer, a dependency management tool for PHP. Here are the steps to install our modules:

Step 1: Obtain Your Composer Access Credentials

After purchasing an extension, you will receive access credentials specific to that extension. These credentials are linked to your customer account and grant you access to the private Composer repository for the purchased module.

Your credentials consist of:

  • Username: Your unique Gitea username
  • Password: Your Gitea password (you can reset it if needed)

Step 2: Configure Composer Authentication

Create or edit the file auth.json in your Magento 2 project root directory with the following content:

{
    "http-basic": {
        "gitea.magefine.com": {
            "username": "your-username",
            "password": "your-password"
        }
    }
}

Important: Replace your-username and your-password with the credentials provided after your purchase.

Step 3: Add Our Composer Repository

In your terminal, navigate to your Magento 2 project's root directory and run the following command:

composer config repositories.magefine composer https://composer.magefine.com

Step 4: Require the Module

Run the following command to require the module you wish to install. Replace magefine/module-name with the actual package name provided in your purchase confirmation:

composer require magefine/module-name

Note: Composer will automatically use the credentials from your auth.json file to authenticate with our private repository.

Step 5: Enable the Module

After successfully requiring the module, enable it by running the following commands:

php bin/magento module:enable Magefine_ModuleName
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:clean

Step 6: Configure the Module

Access the Magento Admin Panel and configure the module as needed. Configuration options are typically found under Stores > Configuration > Magefine Extensions.

Step 7: Clear Cache and Reindex

Finally, clear the cache and reindex your Magento store to ensure the module functions correctly:

php bin/magento cache:flush
php bin/magento indexer:reindex

Troubleshooting

If you encounter authentication errors during installation, please verify:

  • Your auth.json file is in the correct location (Magento root directory)
  • Your username and password are correctly entered (case-sensitive)
  • You have active access to the module you're trying to install

Need Help? If you encounter any issues during installation or have any questions, please contact our support team. We're here to help!