Required PHP settings

This topic discusses how to set required PHP options.

Requirements and recommendations

  • Set the system time zone for PHP; otherwise, errors like the following display during the installation and time-related operations like cron might not work:

    PHP Warning:  date(): It is not safe to rely on the system's timezone settings. [more messages follow]
    
  • Set the PHP memory limit.

    Our detailed recommendations are:

    • Compiling code or deploying static assets, 756M
    • Installing and updating Magento components from Magento Marketplace, 2G
    • Testing, ~3-4G
  • Disable asp_tags

    If asp_tags are enabled, errors display when accessing PHTML templates.

    asp_tags were removed in PHP 7.

  • Enable opcache.save_comments, which is required for Magento 2.1 and later.

    We recommend you enable the PHP OpCache for performance reasons. The OPcache is enabled in many PHP distributions.

    Magento 2.1 and later use PHP code comments for code generation.

To avoid issues during installation and upgrade, we strongly recommend you apply the same PHP settings to both the PHP command-line configuration and to the PHP web server plug-in’s configuration. For more information, see the next section.

Step 1: Find PHP configuration files

This section discusses how you find the configuration files necessary to update required settings.

Find php.ini configuration file

To find the web server configuration, run a phpinfo.php file in your web browser and look for the Loaded Configuration File as follows:

To locate the PHP command-line configuration, enter

php --ini

Use the value of Loaded Configuration file.

If you have only one php.ini file, make the changes in that file. If you have two php.ini files, make the changes in all files. Failure to do so might cause unpredictable performance.

Find OPcache configuration settings

PHP OPcache settings are typically located either in php.ini or opcache.ini. The location might depend on your operating system and PHP version. The OPcache configuration file might have an [opcache] section or settings like opcache.enable.

Use the following guidelines to find it:

  • Apache web server:

    For Ubuntu with Apache, OPcache settings are typically located in php.ini.

    For CentOS with Apache or nginx, OPcache settings are typically located in /etc/php.d/opcache.ini

    If not, use the following command to locate it:

    sudo find / -name 'opcache.ini'
    
  • nginx web server with PHP-FPM: /etc/php5/fpm/php.ini

If you have more than one opcache.ini, modify all of them.

Step 2: How to set PHP options

To set PHP options:

  1. Open a php.ini in a text editor.
  2. Locate your server’s time zone in the available time zone settings
  3. Locate the following setting and uncomment it if necessary:

    date.timezone =
    
  4. Add the time zone setting you found in step 2.
  5. Change the value of memory_limit to one of the values at the beginning of this section.

    For example,

    memory_limit=2G
    
  6. Locate the following setting:

    asp_tags =
    
  7. Make sure its value is set to Off.
  8. Save your changes and exit the text editor.
  9. Open the other php.ini (if they are different) and make the same changes in it.

Step 3: Set OPcache options

To set opcache.ini options:

  1. Open your OpCache configuration file in a text editor:

    • opcache.ini (CentOS)
    • php.ini (Ubuntu)
    • /etc/php5/fpm/php.ini (nginx web server (CentOS or Ubuntu))
  2. Locate opcache.save_comments and uncomment it if necessary.
  3. Make sure its value is set to 1.
  4. Save your changes and exit the text editor.
  5. Restart your web server:

    • Apache, Ubuntu: service apache2 restart
    • Apache, CentOS: service httpd restart
    • nginx, Ubuntu and CentOS: service nginx restart