Magento application environment variables

These sections list the environment variables for general Magento and deployment. You can add variables using the Project Web Interface or CLI commands.

Magento application variables

The following table lists variables that you can override using environment variables.

Variable name	Description	Default value
`ADMIN_USERNAME`	User name for a Magento administrative user. This user is an administrator and can create other users, including other administrative users.	admin
`ADMIN_FIRSTNAME`	Administrative user's first name.	John
`ADMIN_LASTNAME`	Administrative user's last name.	Doe
`ADMIN_EMAIL`	Administrative user's e-mail address. This value is required for upgrading and patching Magento Commerce (Cloud) and is used to send password reset emails. To set, see Add admin variables for Admin access.	Not set
`ADMIN_PASSWORD`	Administrative user's password. Initially, we generate a random password and provide an email directing the Project Owner to reset the password. You should immediately change this password.	Not set
`ADMIN_URL`	Enter the relative URL by which to access the Magento Admin. For security reasons, we recommend you choose a value other than `admin` or `backend` or another term that is easy to guess.	admin
`ADMIN_LOCALE`	Specifies the default locale used by the Magento Admin.	en_US

For additional variables, continue to the following sections.

Magento deploy variables

The following variables are available during the deploy process of build and deploy. To know what version the variable is available on, see the Magento Version in the table.

Variable name	Description	Default value
`UPDATE_URLS`	On deployment, replace Magento base URLs in the database with project URLs. This is useful for local development, where base URLs are set up for your local environment. When you deploy to a Cloud environment, we change the URLs so you can access your storefront and Magento Admin using project URLs. You should set this variable to `disabled` only in Staging or Production environments, where the base URLs can't change. For Pro, we already set this to `disabled` for you. This is available in versions 2.0.10 and later.	enabled
`CLEAN_STATIC_FILES`	The default value, `enabled`, cleans generated static view files when you perform an action like enabling or disabling a component. We recommend the default value in development. The supported values are `enabled` and `disabled`. Failure to clear static view files might result in issues if there are multiple files with the same name and you don't clear all of them. Because of static file fallback rules, if you do not clear static files and there is more than one file named `logo.gif` that are different, fallback might cause the wrong file to display. This is available in all versions.	enabled
`STATIC_CONTENT_EXCLUDE_THEMES`	Themes can include numerous files. If you want to skip copying over theme files during deployment, you can set this environment variable. For example, the Luma theme is included with Magento Commerce (Cloud). You may not need to constantly deploy this theme with your code updates and deployments. To exclude, you would add the theme, for example: `Magento/luma`. This is available in all versions.	not set
`ADMIN_LOCALE`	Specifies the default locale used by the Magento Admin. This is available in all versions.	en_US
`STATIC_CONTENT_THREADS`	Sets the number of threads for processing and deploying static content files. The higher amount of threads increasing the amount of files processed during the deployment. The lower the number of threads, the slower static files are processed increasing deployment time. For Starter plan environments and Pro Integration environments, the threads value is 1. This amount is fine for these environments. For Pro Staging and Production environments, the default threads is 3 to increase the speed of processing static content, especially for Production with three nodes and GlusterFS. To further reduce deployment time, we recommend using Configuration Management with the `scd-dump` command to move static deployment into the build phase. This is available in all versions.	1 for Starter environments and Pro Integration environments 3 for Pro Staging and Production environments
`DO_DEPLOY_STATIC_CONTENT`	You can forcefully enable or disable the deployment of static content during the deploy phase with this variable. If you already completed static content deployment in the build phase, and this variable is enabled, it will be overridden to ensure static content deployment occurs only once. We strongly recommend always deploying static content during the build phase. This is available in all versions.	disabled
`MAGENTO_CLOUD_MODE`	We manage the values and setting of this variable. It identifies the type of environment as part of Integration, Staging, or Production. For example, for Pro, this value may be `enterprise` indicating Staging and Production. For `enterprise`, it sets the `STATIC_CONTENT_THREADS` to 3, otherwise sets it to 1 for Integration. This is highly important for Pro plans Production, which has a three node high availability architecture with a very different technology stack. This is available in all versions.	enterprise
`VERBOSE_COMMANDS`	Enables or disables the Symfony debug verbosity level for your logs. Be aware, if you enable this verbosity, the logs will be deeply detailed. This is available in all versions.	disabled
`ADMIN_USERNAME`	User name for a Magento administrative user. This user is an administrator and can create other users, including other administrative users. This is available in all versions.	admin
`ADMIN_FIRSTNAME`	Administrative user's first name. This is available in all versions.	Not set, example: John
`ADMIN_LASTNAME`	Administrative user's last name. This is available in all versions.	Not set, example: Doe
`ADMIN_EMAIL`	Administrative user's e-mail address. This value is required for upgrading and patching Magento Commerce (Cloud) and is used to send password reset emails. To set, see Add admin variables for Admin access.	Not set
`ADMIN_PASSWORD`	Administrative user's password. Initially, we generate a random password and provide an email directing the Project Owner to reset the password. You should immediately change this password.	Not set
`ADMIN_URL`	Enter the relative URL by which to access the Magento Admin. For security reasons, we recommend you choose a value other than `admin` or `backend` or another term that is easy to guess. If you set this value through a variable and the Admin Panel in Starter environments, the variable overrides the Admin Panel (or database value). For Pro, the Admin Panel (database value) overrides the variable. The values are also managed by `UPDATE_URLS`. This is available in all versions.	admin
`STATIC_CONTENT_SYMLINK`	Generates symlinks for static content. By default, symlinks are always generated unless you disable it using this environment variable. This setting is vital for Pro Production environment for the three node cluster. If disabled, every file will be copied during deployment without automated symlinks generated. If disabled, this will increase deployment time. This is available in all versions.	enabled

For information on the build and deploy process, see Deployment process.

Add environment variables

You can add environment variables for active environments through the Project Web Interface and through the Magento Cloud CLI. To create variables through the Project Web Interface, see Set environment variables.

Every time you add or modify a variable using the web interface or the CLI, the branch will redeploy automatically.

To create a variable using the command line:

Login to the Magento Cloud CLI. Enter the command magento-cloud login and provide your credentials.
To set a variable for the project, use the command magento-cloud project:variable:set <name> <value>. The alias for this command is also pvset. For example, magento-cloud pvset example 123 creates a variable example with a string value of 123 for the project.
After creating these variables, you can list all project variables with the command magento-cloud project:variable:get or magento-cloud pvget.
To set a variable for the branch, use the command magento-cloud variable:set <name> <value>. The alias for this command is also vset. For example, magento-cloud vset example2 abc creates a variable example2 with a string value of abc for the branch.
After creating these variables, you can list all project variables with the command magento-cloud variable:get or magento-cloud vget.

Troubleshooting

In the event something goes wrong and you can not access your environment after it deploys, try the following:

SSH to the environment and make sure services are running.

Restore your snapshot:

magento-cloud snapshot:list
magento-cloud snapshot:restore <snapshot>

For more information on snapshots, see Snapshots and backup management.