Skip to main content

Environment Changes

Description

The component is responsible for configuring the application to talk to the appropriate services, as well as configuring other parts to work correctly.
Because this component has different settings and updates/manages different files depending on the platform we have broken this page down into platform specific parts.

 

Magento 2

Settings

  • Override Robots.txt - If enabled /robots.txt will be overridden with a file that stops search engines from indexing the instance.
  • SQL Changes - SQL statements to be ran against the database, when creating an instance. (This can be used for setting payment methods to sandbox mode for example).

Source controlled configuration

When synchronizing/creating this component MDOQ will look for the file mdoq/env.php.mustache if this file exists it will be as the template for app/etc/env.php. If one isn't found MDOQ will continue as normal.
The file will be processed with the mustache template engine.
The variables passed in are:

  • INSTANCE_ID - the ID of the current instance.
  • INSTANCE_TYPE - the type of the current instance.
  • INSTANCE_TICKET_NUMBER - the ticket number of the current instance.

After processing the template, the output must be valid PHP

The output file will then be processed as the normal.

 

Vuestorefront Frontend

Settings

  • Custom Variables - These values that should be changed in the mdoq/default.json file, before it is translated to config/local.json . The Path must be a valid JSON path.
  • Theme Name- This is the name of the theme you are using

 

Vuestorefront Backend

Settings

  • Custom Variables - These values that should be changed in the mdoq/default.json file, before it is translated to config/local.json . The Path must be a valid JSON path.
  • Stores - These are stores that should be add to the mdoq/default.json file, before it is translated to config/local.json.
 

Common Errors

A few common error messages that may be resolved by changing configuration within MDOQ.

Error in JSONPath

Exception: Error in JSONPath near 'XXXXXX'
Error: Error in JSONPath near 'XXXXXX'

This suggests that one of the Custom Variables configured has an invalid value for the Path, to fix the issue find the offending path value and either correct or remove from the Custom Variables list and then sync the instance.

 

 

 

Powered by Zendesk