Global variables
The following global variables control actions across each phase: build, deploy, and post-deploy. Because global variables impact every phase, you must set them in the global
stage of the .magento.env.yaml
file:
1
2
3
stage:
global:
GLOBAL_VARIABLE_NAME: value
For more information about customizing the build and deploy process:
MIN_LOGGING_LEVEL
- Default—Not set
- Version—Magento 2.1.4 and later
Overrides the minimum logging level for all output streams without making changes to the code. This helps when troubleshooting problems with deployment. For example, if your deployment fails, you can use this variable to increase the logging granularity globally. See Log levels. The min_level
value in Logging handlers overwrites this setting.
1
2
3
stage:
global:
MIN_LOGGING_LEVEL: debug
The setting for the MIN_LOGGING_LEVEL
variable does not change the log level configuration for the file handler, which is set to debug
by default.
SCD_ON_DEMAND
- Default—Not set
- Version—Magento 2.1.4 and later
Enable generation of static content when requested by a user (SCD). This is ideal for the development and testing workflow, because it decreases the deployment time.
Pre-loading the cache using the post_deploy
hook reduces site downtime. The cache warming is available only for Pro projects that contain Staging and Production environments in the Project Web UI and for Starter projects. Add the SCD_ON_DEMAND
environment variable to the global
stage in the .magento.env.yaml
file:
1
2
3
stage:
global:
SCD_ON_DEMAND: true
The SCD_ON_DEMAND
variable skips the SCD in both phases (build and deploy), clears the pub/static
and var/view_preprocessed
folders, and writes the following to the app/etc/env.php
file:
1
2
3
4
5
return array(
...
'static_content_on_demand_in_production' => 1,
...
);
SCD_MAX_EXECUTION_TIME
- Default—Not set
- Version—Magento 2.2.0 and later
Allows you to increase the maximum expected execution time for static content deployment.
By default, Magento Commerce sets the maximum expected execution to 400 seconds, but in some scenarios you might need more time to complete the static content deployment for a Cloud project.
1
2
3
stage:
global:
SCD_MAX_EXECUTION_TIME: 3600
SCD_USE_BALER
- Default—Not set
- Version—Magento 2.3.0 and later
Baler is a Magento module that scans your generated JavaScript code and creates an optimized JavaScript bundle. Deploying the optimized bundle to your site can reduce the number of network requests when loading your site and improve page load times.
Set to true
to run Baler after performing static content deployment.
1
2
3
stage:
build:
SCD_USE_BALER: true
You must install and configure the Baler module before using this feature. Because Baler is currently in alpha release, enable this option only on Staging environments.
SKIP_HTML_MINIFICATION
- Default:
true
—forece-tools
2002.0.13 and laterfalse
—for earlier versions ofece-tools
- Version—Magento 2.1.4 and later
Enables or disables copying static view files to the <magento_root>/init/
directory at the end of the build stage. If set to true
files are not copied and HTML minification is available on request. Set this value to true
to reduce downtime when deploying to Staging and Production environments.
false
—Copies theview_preprocessed
directory to the<magento_root>/init/
directory at the end of the build phase, and restores the directory in the<magento_root>/var
directory at the beginning of the deploy phase.true
—Enables on-demand HTML minification; does not copy the<magento_root>var/view_preprocessed
to the<magento_root>/init/
directory at the end of the build phase.
Add the SKIP_HTML_MINIFICATION
environment variable to the global
stage in the .magento.env.yaml
file:
1
2
3
stage:
global:
SKIP_HTML_MINIFICATION: true
X_FRAME_CONFIGURATION
- Default—Not set
- Version—Magento 2.1.4 and later
Use the X_FRAME_CONFIGURATION
variable to change the X-Frame-Options
header configuration for your Magento Commerce site. This configuration controls how the browser renders a page in a <frame>
, <iframe>
, or <object>
. Use one of the following options:
DENY
—Page cannot be displayed in a frame.SAMEORIGIN
—(The default Magento setting.) Page can be displayed only in a frame on the same origin as the page itself.ALLOW-FROM
<uri>
—Page can be displayed only in a frame on the specified origin.
Add the X_FRAME_CONFIGURATION
environment variable to the global
stage in the .magento.env.yaml
file:
1
2
3
stage:
global:
X_FRAME_CONFIGURATION: SAMEORIGIN