Skip to main content

MDOQ Connector Installation

How to install the MDOQ connector module.

The installation of the MDOQ Connector is a very straight forward process. Depending on the platform you are using, you install a module/extension. Then configure MDOQ to talk to it. That's it!

 

Magento 2

  1. The best/recommended way to install the MDOQ connector is via composer, alternatively you can install via a tgz
    If you are struggling to install the connector please get in touch, initial setup is included free with all new subscriptions.
  2. After installing the module you will need to run the Magento setup commands.
  3. You can then proceed to configuring your newly installed connector.
  4. Once this is done and validated you can head over to live connector initial setup
 

Composer Install

  • Magento 2.3.xx 
    composer require mdoq/module-connector:~1.4
  • Magento 2.2.xx and lower 
    composer require mdoq/module-connector:~1.3
 

Tgz Install

  1. Download the correct package here
  • For Magento 2.3.xx, select the latest 1.4.xx package
  • For Magento 2.2.xx and lower, select the latest 1.3.xx package
  1. You will then need to make the director app/code/Mdoq/Connector
  2. Extract the downloaded package into this directory. (If done correctly there should now be a file called app/code/Mdoq/Connector/composer.json)
 

Magento Setup Commands

There are many methods of installing a module and running the Magento build/deploy commands, we would recommend you stick with your current deployment strategy, so long as this includes the following. (As well as enabling maintenance mode before doing any of this is you are doing this on a live site)

 
php bin/magento setup:upgrade \
    && php bin/magento deploy:mode:set production \
    && php bin/magento cache:flush
 
 

Configure Connector

Depending on your hosting set up the process for configuring the connector differs slightly.
If you only have 1 physical server that hosts your website then you should follow single server setup
If you have multiple webservers, you will need to follow multi-server-setup. If you have a multi-server setup you may need to tie MDOQ's release process into your current deployment strategy. This can be done quite easily with MDOQ Webhooks. If you are unsure, please get in touch.

 

Configure Connector For A Single Server

  1. Log into your Magento admin and navigate to "Stores" > "Configuration" > "Services" > "MDOQ Connector"
    mdoq_connector_settings_location__1_.jpgmdoq_connector_settings__1_.jpg

  2. Change "Enable MDOQ Connector" to "Yes"
  3. Click "Regenerate Endpoint"
  4. Click "Save Config"
  5. Validation

Configure Connector For Multi Server

The steps here are the same as the single server setup but you need to change the setting "Enable Access For Admin" to yes.
 

Validating Installation

To validate that this is setup and working correctly.

  1. Open a new tab in you web browser and go to the homepage of your site.
  2. Append the generated endpoint to the url.
    e.g https://www.mysite.com/GENERATED_ENDPOINT
  3. You should see the message "Post variables missing"

That's it the connector is ready to be connected to via MDOQ, head over to Live Connector Setup to finish the process.

 

Vue Storefront Frontend

For Vue Storefront Frontend you do not need to install any connector, MDOQ builds everything from your source control repository.
You can head straight over to live connector setup

 

Vue Storefront Backend

For Vue Storefront Backend you do not need to install any connector, MDOQ build everything from your source control repository.
You can head straight over to live connector setup

 

Magento 1

If you are still using Magento 1, please contact us and we will gladly help you through the setup process.

Related articles

Powered by Zendesk