Getting started
MageProxy is a service designed to make your Magento 2 website faster. It does this by intelligently organizing and combining your website's JavaScript files. A faster website means a better experience for your customers and often leads to more sales. Our platform operates unobtrusively, tracking JavaScript files used by real user traffic, without requiring a build process or direct file writes on your infrastructure. We support Magento Open Source, Adobe Commerce, and Mage-OS.
This guide will walk you through the essential steps to integrate MageProxy with your Magento 2 store, from initial setup to continuous optimization.
Sign Up for a MageProxy Plan
To start using the MageProxy platform, the first step is to sign up for one of our plans. We are currently offering two different plans tailored to various Magento environments.
-
Open Source plan: This plan is ideal for users running Magento Open Source and Mage-OS. It covers one test instance and one production instance, and supports up to three store views per instance.
-
Enterprise Plan: This plan is specifically designed for Adobe Commerce (Cloud & OnPrem) users. It offers our priority support. It also covers one test instance and one production instance, and supports up to five store views per instance.
If you require more store views, you can reach out to [email protected] for details.
Upon signing up, you will be guided through a short onboarding process. This process is crucial so we can provision our services closest to your store for lowest latency, validate your domain for security, and provide you with the necessary Service ID and API keys.
Domain Validation
After signing up, you will be prompted to specify and validate the domains you intend to use with MageProxy, a critical security step to verify that you own these domains and prevent unauthorized use of our services. This involves adding a TXT record to your domain's DNS record, a standard security practice to confirm ownership, similar to how Google Analytics validates domains.
Due to changing DNS records being a technical task, you might need to reach out to your developer team or development agency for assistance.
Region Selection
Following domain validation, you will be prompted to choose a region for your MageProxy account. This selection is important for ensuring optimal performance because it determines the geographical location where your data will be stored and processed.
We highly recommend selecting the region that is geographically closest to your existing Magento origin server. This proximity helps reduce the time it takes for data to travel, leading to faster loading times for your customers. Currently, MageProxy operates data centers in both the United States and Europe.
Install extension
With your initial onboarding steps completed, the next phase is to install the MageProxy Magento 2 extension on your server. The MageProxy Magento 2 connector is open-source and its source code is available on GitHub. However, the recommended method is to install it via Composer.
Run the following command in Magento 2 root folder:
$ composer install mageproxy/connector-magento2:*
$ php bin/magento module:enable MageProxy_Connector
$ php bin/magento setup:upgrade
Please contact us if you need help with the installation process.
Configuration
With the extension installed and onboarding completed, you should now be able to configure the extension. You will need to use the Service ID and API key that you obtained during the onboarding.
Log in to the Magento admin, choose System > Tools > mageproxy.io > System Configuration, there you can expand the "Credentials" section and insert your Service ID and API key. Don't forget to save the configuration.