PHP Buildpack Configuration

Page last updated:

Defaults

The PHP buildpack stores all of its default configuration settings in the defaults directory.

options.json

The options.json file is the configuration file for the buildpack itself. It instructs the buildpack what to download, where to download it from, and how to install it. It allows you to configure package names and versions (i.e. PHP, HTTPD, or Nginx versions), the web server to use (HTTPD, Nginx, or None), and the PHP extensions that are enabled.

The buildpack overrides the default options.json file with any configuration it finds in the .bp-config/options.json file of your application.

Below is an explanation of the common options you might need to change.

Variable Explanation
WEB_SERVER Sets the web server to use. Must be one of httpd, nginx, or none. This value defaults to httpd.
HTTPD_VERSION Sets the version of Apache HTTPD to use. Currently the build pack supports the latest stable version. This value will default to the latest release that is supported by the build pack.
ADMIN_EMAIL The value used in HTTPD’s configuration for ServerAdmin
NGINX_VERSION Sets the version of Nginx to use. By default, the buildpack uses the latest stable version.
PHP_VERSION Sets the version of PHP to use.
Set to a minor instead of a patch version,
such as "{PHP_70_LATEST}". See options.json.
PHP_EXTENSIONS (DEPRECATED) A list of the extensions to enable. bz2, zlib, curl, and mcrypt are enabled by default.
PHP_MODULES A list of the modules to enable. No modules are explicitly enabled by default, however the buildpack automatically chooses fpm or cli. You can explicitly enable any or all of: fpm, cli, cgi, and pear.
ZEND_EXTENSIONS A list of the Zend extensions to enable. Nothing is enabled by default.
APP_START_CMD When the WEB_SERVER option is set to ‘none,’ this command is used to start your app. If WEB_SERVER and APP_START_CMD are not set, then the buildpack searches for app.php, main.php, run.php, or start.php (in that order). This option accepts arguments.
WEBDIR The root directory of the files served by the web server specified in WEB_SERVER. Defaults to htdocs. Other common settings are public, static, or html. Path is relative to the root of your application.
LIBDIR This path is added to PHP’s include_path. Defaults to lib. Path is relative to the root of your application.
HTTP_PROXY The buildpack downloads uncached dependencies using HTTP. If you are using a proxy for HTTP access, set its URL here.
HTTPS_PROXY The buildpack downloads uncached dependencies using HTTPS. If you are using a proxy for HTTPS access, set its URL here.
ADDITIONAL_PREPROCESS_CMDS A list of additional commands that will run prior to the application starting. For example, you might use this command to run migration scripts or static caching tools before the application launches.

For details about supported versions, please read the release notes for your buildpack version.

HTTPD, Nginx, and PHP configuration

The buildpack automatically configures HTTPD, Nginx, and PHP for your application. This section explains how to modify the configuration.

The .bp-config directory in your application can contain configuration overrides for these components. Name the directories httpd, nginx, and php. We recommend that you use php.ini.d or fpm.d).

NOTE: If you override the php.ini or php-fpm.ini files many other forms of configuration will not work.

For example: .bp-config httpd nginx php

Each directory can contain configuration files that the component understands.

For example, to change HTTPD logging configuration:

$ ls -l .bp-config/httpd/extra/
total 8
-rw-r--r--  1 daniel  staff  396 Jan  3 08:31 httpd-logging.conf

In this example, the httpd-logging.conf file overrides the one provided by the buildpack. We recommend that you copy the default from the buildpack and modify it.

The default configuration files are found in the PHP Buildpack /defaults/config directory

Take care when modifying configurations, as it might cause your application to fail, or cause Cloud Foundry to fail to stage your application.

You can add your own configuration files. The components will not know about these, so you must ensure that they are included. For example, you can add an include directive to the httpd configuration to include your file:

ServerRoot "${HOME}/httpd"
Listen ${PORT}
ServerAdmin "${HTTPD_SERVER_ADMIN}"
ServerName "0.0.0.0"
DocumentRoot "${HOME}/#{WEBDIR}"
Include conf/extra/httpd-modules.conf
Include conf/extra/httpd-directories.conf
Include conf/extra/httpd-mime.conf
Include conf/extra/httpd-logging.conf
Include conf/extra/httpd-mpm.conf
Include conf/extra/httpd-default.conf
Include conf/extra/httpd-remoteip.conf
Include conf/extra/httpd-php.conf
Include conf/extra/httpd-my-special-config.conf # This line includes your additional file.

.bp-config/php/php.ini.d/

The buildpack will add any .bp-config/php/php.ini.d/<file>.ini files it finds in the application to the PHP configuration. This can be used to change any value which is acceptable to php.ini (list of directives).

For example adding a file .bp-config/php/php.ini.d/something.ini to your app, with contents

default_charset="UTF-8"
default_mimetype="text/xhtml"

would override both the default charset and mimetype.

Precedence

In order of highest precedence, php config values come from.

  • php scripts using ini_set() to manually override config files
  • user.ini files (for local values)
  • .bp-config/php/php.ini.d overrides master value but, local value is still the one from user.ini

.bp-config/php/fpm.d/

The buildpack will add any .bp-config/php/fpm.d files it finds in the application to the PHP-FPM configuration. This can bes used to change any value which is acceptable to php-fpm.ini (list of directives)

PHP Extensions

The buildpack will add any .bp-config/php/php.ini.d/<file>.ini files it finds in the application to the PHP configuration. This can be used to enable PHP or ZEND extensions. For example,

extension=redis.so
extension=gd.so
zend_extension=opcache.so

If an extension is already present and enabled in the compiled php, for example intl, you do not need to explicitly enable it to use that extension.

PHP_EXTENSIONS vs. ZEND_EXTENSIONS

PHP has two kinds of extensions, “PHP extensions” and “Zend extensions”. These hook into the PHP executable in different ways.

For this reason, they are specified differently in ini files. Your app will fail if a Zend Extension is specified as a PHP Extension, or vice versa.

If you see this error:

php-fpm | [warn-ioncube] The example Loader is a Zend-Engine extension and not a module (pid 40)
php-fpm | [warn-ioncube] Please specify the Loader using 'zend_extension' in php.ini (pid 40)
php-fpm | NOTICE: PHP message: PHP Fatal error:  Unable to start example Loader module in Unknown on line 0

Try moving the example extension from extension to zend_extension, then re-pushing your application.

If you see this error:

NOTICE: PHP message: PHP Warning:  example MUST be loaded as a Zend extension in Unknown on line 0

Try moving the example extension from zend_extension to extension, then re-pushing your application.

PHP Modules

The following modules can be included by adding it to the PHP_MODULES list:

  • cli, installs php and phar
  • fpm, installs PHP-FPM
  • cgi, installs php-cgi
  • pear, installs Pear

By default, the buildpack installs the cli module when you push a standalone application, and it installs the fpm module when you run a web application. You must specify cgi and pear if you want them installed.

Buildpack Extensions

The buildpack comes with extensions for its default behavior. These are the HTTPD, Nginx, PHP, and NewRelic extensions.

The buildpack is designed with an extension mechanism, allowing application developers to add behavior to the buildpack without modifying the buildpack code.

When an application is pushed, the buildpack runs any extensions found in the .extensions directory of your application.

The Developer Documentation explains how to write extensions.

Create a pull request or raise an issue on the source for this page in GitHub