env.php reference

The env.php file contains the following sections:

Name Description
backend Settings for the Admin area
cache Configure redis page and default cache
cache_types Cache storage settings
consumers_wait_for_messages Configure how consumers process messages from the message queue
cron Enable or disable the cron jobs
crypt The encryption key for cryptographic functions
db Database connection settings
directories Commerce directories mapping settings
downloadable_domains List of downloadable domains
install The installation date
lock Lock provider settings
MAGE_MODE The application mode
queue Message queues settings
resource Mapping of resource name to a connection
session Session storage data
system Disables the field for editing in the admin
x-frame-options Setting for [x-frame-options][x-frame-options]

backend

Configure the frontName for the Commerce admin url using the backend node in env.php.

'backend' => [
  'frontName' => 'admin'
]

cache

Configure redis page and default caching by using cache node in the env.php file.

'cache' => [
    'frontend' => [
        'default' => [
            'backend' => 'Magento\\Framework\\Cache\\Backend\\Redis',
            'backend_options' => [
                'server' => '127.0.0.1',
                'database' => '0',
                'port' => '6379'
            ],
        ],
        'page_cache' => [
            'backend' => 'Magento\\Framework\\Cache\\Backend\\Redis',
            'backend_options' => [
                'server' => '127.0.0.1',
                'port' => '6379',
                'database' => '1',
                'compress_data' => '0'
            ]
        ]
    ]
]

Learn more in Redis Configuration.

cache_types

All the cache types configurations are available from this node.

'cache_types' => [
  'config' => 1,
  'layout' => 1,
  'block_html' => 1,
  'collections' => 1,
  'reflection' => 1,
  'db_ddl' => 1,
  'compiled_config' => 1,
  'eav' => 1,
  'customer_notification' => 1,
  'config_integration' => 1,
  'config_integration_api' => 1,
  'full_page' => 1,
  'config_webservice' => 1,
  'translate' => 1,
  'vertex' => 1
]

Learn more about different Cache Types.

consumers_wait_for_messages

Specify whether consumers should continue polling for messages if the number of processed messages is less than the max_messages value. The default value is 1.

'queue' => [
    'consumers_wait_for_messages' => 1
]

The following options are available:

  • 1—Consumers continue to process messages from the message queue until reaching the max_messages value specified in the env.php file before closing the TCP connection and terminating the consumer process. If the queue empties before reaching the max_messages value, the consumer waits for more messages to arrive.

    We recommend this setting for large merchants because a constant message flow is expected and delays in processing are undesirable.

  • 0—Consumers process available messages in the queue, close the TCP connection, and terminate. Consumers do not wait for additional messages to enter the queue, even if the number of processed messages is less than the max_messages value specified in the env.php file. This can help prevent issues with cron jobs caused by long delays in message queue processing.

    We recommend this setting for smaller merchants that do not expect a constant message flow and prefer to conserve computing resources in exchange for minor processing delays when there could be no messages for days.

cron

Enable or disable cron jobs for the Commerce application. By default, cron jobs are enabled. To disable them, add the cron configuration to the env.php file and set the value to 0.

'cron' => [
  'enabled' => 0
]
WARNING

Be careful when you disable cron jobs. When they are disabled, essential processes required by the Commerce application will not run.

Learn more about Crons.

crypt

Commerce uses an encryption key to protect passwords and other sensitive data. This key is generated during the installation process.

'crypt' => [
  'key' => '63d409380ccb1182bfb27c231b732f05'
]

Learn more about Encryption Key in the Commerce User guide.

db

All database configurations are available in this node.

'db' => [
  'table_prefix' => '',
  'connection' => [
    'default' => [
      'host' => 'localhost',
      'dbname' => 'magento_db',
      'username' => 'root',
      'password' => 'admin123',
      'model' => 'mysql4',
      'engine' => 'innodb',
      'initStatements' => 'SET NAMES utf8;',
      'active' => '1'
    ]
  ]
]

directories

Optional directory mapping options that need to be set when the web server is configured to serve Commerce app from the /pub directory for improved security.

'directories' => [
    'document_root_is_pub' => true
]

downloadable_domains

A list of downloadable domains available in this node. Additional domains can be added, removed, or listed using CLI commands.

'downloadable_domains' => [
    'local.vanilla.com'
]

Learn more about Downloadable Domains.

install

The installation date of Commerce application.

'install' => [
  'date' => 'Tue, 23 Apr 2019 09:31:07 +0000'
]

lock

Lock provider settings are configured using the lock node.

Learn more about Lock Provider Configuration.

MAGE_MODE

The deploy mode can be configured in this node.

'MAGE_MODE' => 'developer'

Learn more about application Modes.

queue

Message queue configurations are available in this node.

'queue' => [
  'topics' => [
    'customer.created' => [publisher="default-rabitmq"],
    'order.created' => [publisher="default-rabitmq"],
  ]
]

Learn more about Message Queue.

resource

Resource configuration settings are available in this node.

'resource' => [
  'default_setup' => [
    'connection' => 'default'
  ]
]

session

Session configurations are stored in the session node.

'session' => [
  'save' => 'files'
],

Learn more about Session.

x-frame-options

x-frame-options header can be configured using this node.

'x-frame-options' => 'SAMEORIGIN'

Learn more about x-frame-options.

system

Using this node, Commerce locks the configuration values in the env.php file and then disables the field in the admin.

'system' => [
  'default' => [
    'web' => [
      'secure' => [
          'base_url' => 'https://magento.test/'
      ]
    ]
  ]

Learn more in env-php-config-set.

On this page