PhpSwitcher - PHP-FPM support

**Nuxwin** · Dec 30th 2015

Soon available through PhpSwitcher: Support for PHP-FPM:

Note: In near future (i-MSCP 1.4.0), it will be also possible to have domains, subdomains with PHP-FPM and other with Fcgid For PHP-FPM support, one master instance will be spawn for each configured PHP version. The plugin will manage these instances separately using their sysvinit scripts (on per instance).

**Nuxwin** · Dec 31st 2015

Hope it is understandable. Any review is welcome:

README file for coming PhpSwitcher version:

Code

# i-MSCP PhpSwitcher plugin v2.0.0
## Introduction
This plugin allows to setup additional PHP versions for your customers.
## Requirements
- i-MSCP version >= 1.2.11
- Either the Fcgid Apache2 httpd server implementation or the PHP-FPM Apache2 httpd server implementation
You can switch to another server implementation by running the following command:
# perl imscp-autoinstall -dar httpd
Note: When asked, it is recommended to choose the per_site INI level (Fcgid), or the per_site pool level (PHP-FPM). This
allows your customers to set differents PHP versions for their domains, subdomains...
## Installation
1. Be sure that all requirements as stated in the requirements section are met
2. Upload the plugin through the plugin management interface
3. Install the plugin through the plugin management interface
4. Compile and install additional PHP versions (see below to know how)
5. Register additional PHP versions through the PhpSwitcher administration interface (see below to know how)
## Update
1. Read the UPDATE file inside the plugin archive
2. Be sure that all requirements as stated in the requirements section are met
3. Upload the plugin through the plugin management interface
4. Update the plugin list through the plugin management interface
5. Re-compile your PHP versions if needed (see the doc/graceful_update howto)
## Setup new PHP versions
At first, you must download, configure, compile and install the PHP versions that you want make available for your
customers. For this, you can either do the job manually, or use the PHP compiler (recommended) that is shipped with this
plugin.
If you choose to compile your additional PHP versions manually, you must not forget to build them with the cgi SAPI,
even if you don't use the Fcgid Apache2 httpd server implementation. Indeed the PHP FastCGI binary is always required
by this plugin.
Be also aware that configuring multiple PHP-FPM instances requires to name your binaries with unique names, this to
avoid any conflict with PHP-FPM master processes. If you don't have any idea of what we are talking about, best is to
simply use the PHP compiler which will do all the work for you.
### PHP compiler
The PHP compiler is a Perl script that downloads, configures, compiles and installs additional PHP versions in one step,
without any human intervention. The script is located in the PhpSwitcher/PhpCompiler directory.
For instance, if you want to setup the PHP 7.0 version, you can run the following command:
# perl /var/www/imscp/gui/plugins/PhpSwitcher/PhpCompiler/php_compiler.pl 7.0
Or if you want to setup any other PHP version (or all) supported by this script, you can run it as follow:
# perl /var/www/imscp/gui/plugins/PhpSwitcher/PhpCompiler/php_compiler.pl %version%
where the %version% parameter can be one of the available PHP version or 'all' to setup all available PHP versions. Note
that the %version% parameter can be used more than once.
#### Supported PHP versions
PHP versions provided by the compiler depend on the httpd server implementation in use. For instance, older PHP versions
such as php4.4 and php5.2 don't provide the fpm SAPI and therefore, the compiler doesn't provide those versions when it
detect that you use the PHP-FPM Apache2 httpd server implementation.
If you use the Fcgid Apache2 httpd server implementation, the following PHP versions are supported:
4.4, 5.2, 5.3, 5.4, 5.5, 5.6 and 7.0
If you use the PHP-FPM Apache2 httpd server implementation, the following PHP versions are supported:
5.3, 5.4, 5.5, 5.6 and 7.0
Note that the supported PHP versions are the last that were available when this plugin version has been released. This
means that by default, the versions provided by the compiler can be lower than the last released on the PHP site. In
such case, you can try to use the --force-last command line option which tells the PHP compiler to download the last
released versions. However, you must be aware that the PHP compiler could fail to apply the needed patches on these
versions. If so, you should create an issue on our bug tracker and with the failure output.
Warning: Even if provided, it is not recommended to install PHP versions that have reached their end of life. You should
really think before providing those versions to your customers because they can cause several security issues.
On January 2016, the following PHP versions are no longer supported by the PHP Team:
- PHP 4.4 Unsupported since 7 Aug 2008
- PHP 5.2 Unsupported since 6 January 2011
- PHP 5.3 Unsupported since 14 August 2014
- PHP 5.4 Unsupported since 3 September 2015
See http://php.net/supported-versions.php for more details.
However, on January 2016, the following PHP versions are still supported by Debian
- PHP 5.4 Supported till febuary 2016 by Debian security team, and till may 2018 by Debian LTS team
Thus, because PHP versions provided by the PHP compiler are patched with Debian patches, you can still provide those
versions to your customers if needed.
#### Building and installation directories
By default, the PHP compiler will build new PHP versions into the /usr/local/src/phpswitcher/php%version% directory and
install them in the /opt/phpswitcher/php%version% directory but you can change this behavior using command line options.
To get list of all available command line options, you can run:
# perl /var/www/imscp/gui/plugins/PhpSwitcher/PhpCompiler/php_compiler.pl --help
#### SSL support for PHP 4.4
SSL support for PHP 4.4 is provided through a self-compiled OpenSSL library (openssl-0.9.8), which is installed in the
PHP 4.4 installation directory (e.g. /opt/phpswitcher/php4.4).
#### Changes made on PHP versions
PHP versions provided by the PHP compiler are almost identical to those which are provided by the Debian team. For each
PHP version, a set of patches is applied on upstream source before compiling them. The patches include the following
changes:
- Multiarch support
- Usage of libtool as provided by Debian instead of the bundled version
- Any patch that fix a bug, a security issue or an FTBFS issue
Majority of the applied patches were pulled from the Debian PHP source packages and adjusted when needed, while some
other were created to resolve FTBFS issues or adjust configuration when needed. Patches which were not pulled from
Debian PHP source packages are prefixed with the `nxw_` prefix.
#### Enabled PHP extensions
Enabled PHP extensions are the same that are enabled in PHP versions provided by Debian team. However, it should be
noted that the db extension is disabled for PHP versions older than 5.3.x due to incompatibility with the Berkeley
Database libraries versions that are shipped with Debian >= Wheezy and Ubuntu >= Precise.
Several extensions are compiled as shared module. See below for more details.
#### Build dependencies
The PHP compiler installs the build dependencies for you but if a package isn't available on your system, it will go
ahead and thus, the configuration process will fail.
#### Parallel Execution (GNU make)
For faster compilation, the parallel execution feature provided by GNU make is enabled whenever possible. This feature
allows to execute many recipes simultaneously. By default, the number of parallel jobs is set according the number of
CPU core available on your system. You can still set the value manually using the --parallel-jobs command line option as
follow:
# perl /var/www/imscp/gui/plugins/PhpSwitcher/PhpCompiler/php_compiler.pl --parallel-jobs 1 7.0
Here, only one recipe will be run at time.
See https://www.gnu.org/software/make/manual/html_node/Parallel.html for further details about this feature.
#### Installation layouts
First, you must note that in all cases, we build the following SAPIs: cli, cgi and fpm. This allows switching on other
httpd server implementation without having to rebuild all PHP versions. This is also needed to build static phpinfo
files (we always use the PHP FastCGI binary to build static phpinfo files).
For all versions provided by the PHP compiler, the following installation layout applies:
#### Common to cgi and fpm SAPIs
- PHP CLI binary: /opt/phpswitcher/php%version%/bin/php
- Master php.ini file: /opt/phpswitcher/php%version%/etc/php/php.ini
- Additional *.ini files: /opt/phpswitcher/php%version%/etc/php/conf.d
#### Specific to cgi SAPI
- PHP FastCGI binary: /opt/phpswitcher/php%version%/bin/php-cgi
- Customer php.ini files: /var/www/fcgi/%domain%/php%version%/php.ini
#### Specific to fpm SAPI
- Customer pool configuration files: /opt/phpswitcher/php%Version%/etc/php-fpm.d/%domain%.conf
- PHP-FPM binary: /opt/phpswitcher/php%version%/sbin/psw-%version%-fpm
- PHP-FPM configuration file: /opt/phpswitcher/php%Version%/etc/php-fpm.conf
- PHP-FPM checkconf script: /usr/local/lib/phpswitcher/psw-%version%-fpm-checkconf
- PHP-FPM instance pid file: /var/run/phpswitcher/psw-%version%-fpm.pid
- PHP-FPM log file: /var/log/phpswitcher/psw-%version%-fpm.log
- PHP-FPM reopenlogs script: /usr/local/lib/phpswitcher/psw-%version%-fpm-reopenlogs
- PHP-FPM sysvinit script: /etc/init.d/psw-%version%-fpm
- PHP-FPM tmpfile: /etc/tmpfiles.d/psw-%version%-fpm.conf
As you can see, we use a specific naming convention for PHP-FPM. This is needed to avoid any conflict between different
PHP-FPM installations that are provided by this plugin, but also to avoid conflicts with PHP-FPM installations that are
provided by your distribution packages.
Note that the `psw` suffix stands for `PhpSwitcher`.
## Configuration
### PHP configuration
This section is only relevant if you installed additional PHP versions with the PHP compiler.
First, it is important to note that it is useless to edit any PHP configuration file located under the /etc/php5
directory for a PHP version that has been built by the PHP compiler. Indeed, the files located under that directory are
only relevant for the PHP versions provided by your distribution.
For the same reasons, it is useless to enable or disable a PHP module using the command line tools php5enmod/php5dismod
that are provided by your distribution. Those tools only operate on the .ini files that are provided by your
distribution.
#### PHP extensions (modules)
For convenience, most of PHP extensions are compiled as shared modules by the PHP compiler. When installing a new PHP
version, the PHP compiler create a specific .ini file that enable most of available PHP extensions. By default, this
file is located at /opt/phpswitcher/php%version%/etc/php/conf.d/modules.ini.
Here, a single INI file is used for ease. This is not like in Debian where an INI file is created for each module. To
enable/disable a specific module, you must just edit the /opt/phpswitcher/php%version%/etc/php/conf.d/modules.ini file
and then, restart the Web server or related PHP-FPM instance, according the httpd server implementation in use.
#### Pecl extensions
If you need to install a Pecl extension for a specific PHP version, you must not use the pecl nor the phpize scripts
that are shipped with your distribution. Instead, you must use those which are provided in the directory of the PHP
version on which you want operate.
For instance, if you want install the FileInfo Pecl extension that was not yet integrated in PHP 5.2, you must process
as follow:
# /opt/phpswitcher/php5.2/bin/pecl install fileinfo
# echo 'extension = fileinfo.so' >> /opt/phpswitcher/php5.2/etc/php/conf.d/modules.ini
#### APCu extension
APCu is a userland cache stripped of opcode caching that comes in replacement of the APC extension. It is a good
complement for PHP versions >= PHP 5.5 that already provide an opcode cache through the OPcache extension.
If you want install this extension for one of your PHP version, you can do as follow:
# /opt/phpswitcher/php%version%/bin/pecl install channel://pecl.php.net/apcu-%version%
# PHP_EXT_DIR=$(/opt/phpswitcher/php%version%/bin/php-config --extension-dir)
# echo "zend_extension = $PHP_EXT_DIR/apcu.so" > /opt/phpswitcher/php%version%/etc/php/conf.d/01_acpu.ini
Note that the APcu version to install depends on your PHP version:
- apcu-4.0.6 for PHP 5.5.x and 5.6.x
- apcu-5.1.2 for PHP 7.0.x
#### IonCube loader
If you want install this extension for one of your PHP version, you can do as follow:
# cd /usr/local/src
# wget http://downloads3.ioncube.com/loader_downloads/ioncube_loaders_lin_x86-64.tar.gz
# tar -xzf ioncube_loaders_lin_x86-64.tar.gz
# cd ioncube
# PHP_EXT_DIR=$(/opt/phpswitcher/php%version%/bin/php-config --extension-dir)
# cp ioncube_loader_lin_%version%.so $PHP_EXT_DIR/ioncube.so
# echo "zend_extension = $PHP_EXT_DIR/ioncube.so" > /opt/phpswitcher/php%version%/etc/php/conf.d/01_ioncube.ini
Once done, you can ensure that all is ok by running the following command:
# /opt/phpswitcher/php4.4/bin/php -v
which should give similar result:
PHP 4.4.9 (cgi-fcgi) (built: May 3 2015 14:16:01)
Copyright (c) 1997-2008 The PHP Group
Zend Engine v1.3.0, Copyright (c) 1998-2004 Zend Technologies
with the ionCube PHP Loader v5.0.2, Copyright (c) 2002-2015, by ionCube Ltd.
Note that in the example above, we assume an amd64 architecture (64 bits OS).
### PHP info files
For each PHP version that is registered through the PhpSwitcher administration interface (see below), a static phpinfo
file is generated, which allows your customers to get PHP information via their own PhpSwitcher interface. This feature,
if not desired, can be disabled by editing the plugin configuration file and by updating the plugin list through the
plugin management interface.
Be aware that because the phpinfo files are static, you must re-generate them each time you made a configuration change
for a specific PHP version (e.g. when you enable or disable a PHP/Pecl extension). This task can be done through the
PhpSwitcher administration interface. Be also aware that because those files are static, some information such as memory
could not matches with those that you have set for your customers (e.g. using the PHP editor provided by i-MSCP).
### Registering a new PHP version in PhpSwitcher
Once you have compiled and installed a new PHP version, you need to register it into the PhpSwitcher plugin to make it
available for your customers. For instance:
1. Login into the panel as administrator and go to the PhpSwitcher administration interface (settings section)
2. Create a new PHP version as follow (exemple for PHP 7.0):
# Common settings (required settings)
- Name: PHP 7.0.2
- Path to PEAR directory: /opt/phpswitcher/php7.0/share/pear
# PHP FastCGI settings (required settings)
- Path to binary: /opt/phpswitcher/php7.0/bin/php-cgi
# PHP-FPM settings (required if you use the PHP-FPM Apache2 httpd server implementation, optional otherwise)
- Path to binary: /opt/phpswitcher/php7.0/sbin/psw-7.0-fpm
- Path to configuration file: /opt/phpswitcher/php7.0/etc/php-fpm.conf
- Path to pool directory: /opt/phpswitcher/php7.0/etc/php-fpm.d
Note that even if only one server implementation is used at time, it is recommended to fills all parameters. This allows
switching httpd server implementation without having to reconfigure the whole. Also, this is in prevision of the future,
when i-MSCP will allow to use multiple httpd server implementations at the same time.
Once done and if all goes well, your customers should be able to switch on new PHP version through their own PhpSwitcher
interface.
## Plugin translation
You can translate this plugin using a gettext translation editor such as poedit. Translation files are located under the
./l10n directory, inside of this plugin archive. Once translated you can send us your translation file (po file) for
integration in future release.
Note that if no translation file exists for your localization in the ./l10n/po directory, you must create it first from
the l10n/PhpSwitcher.pot file. Be aware that your file must be UTF-8, else, it won't be accepted.
## License
i-MSCP PhpSwitcher plugin
@author Laurent Declercq <l.declercq@nuxwin.com>
@copyright (C) 2014-2016 Laurent Declercq <l.declercq@nuxwin.com>
@license i-MSCP License <http://www.i-mscp.net/license-agreement.html>
See the LICENSE file inside the archive for further details.

Display More

**Nuxwin** · Jan 3rd 2016

README file updated. See above. Thank for reviews.

**Nuxwin** · Jan 6th 2016

V2.0.0 on the road (tests in progress).

CHANGELOG will be

Added: doc/graceful_update howto which explains how to mitigate service disruption when recompiling PHP versions
Added: PHP version activation/deactivation feature - Administrator interface
Added: Support for PHP-FPM Apache2 httpd server implementation
Fixed: Backend listeners are registered twice in some contexts (update, reconfiguration)
Fixed: Could not build Pecl extensions - aclocal directory not found - PHP 7.0
Fixed: Missing CLI binary - PHP 4.4
Fixed: PHP 7.0 build failure under Ubuntu Precise (PCRE library too old; usage of bundled version instead)
Refreshed: PHP 5.3.29, 5.4.45, 5.5.31, 5.6.17, 7.0.2 patches (New upstream versions, FPM support and security fixes)
Updated: README and UPDATE files
Updated: Translation files

**Nuxwin** · Jan 9th 2016

Tests are still in progress. Some minor issues to fix and then, first version with PHP-FPM support will be released

Right now, it run. For instance:

phpswitcher_fpm_running.png

**Nuxwin** · Jan 9th 2016

Readme file updated again (see above). Thank you for any review.

**Nuxwin** · Jan 10th 2016

New screeshots for coming 2.0.0 version:

phpswitcher_01.png phpswitcher_02.png phpswitcher_03.png phpswitcher_04.png phpswitcher_05.png

mafioso · Jan 10th 2016

Here some fixes:
README

Typo: "set differents PHP versions?" -> "set different PHP versions?"
Typo: "2. Create a new PHP version as follow (exemple for PHP 7.0):" -> "2. Create a new PHP version as follow (example for PHP 7.0):"
Typo: "Note that even if only one server implementation is used at time, it is recommended to fills all parameters." -> "Note that even if only one server implementation is used at time, it is recommended to fill all parameters."

Plugin itself

Bug: After deleting a subdomain, php switcher settings (may also pool files) still exists
- Create subdomain
- Switch php-Version e.g. to 7.0.2
- Delete subdomain
- Recreate subdomain
- PHP Version in use stay 7.0.2, expected: system default

**Nuxwin** · Jan 10th 2016

@Ninos

Thank you bro for your tests. I''ll now fix all issues

mafioso · Jan 11th 2016

@Nuxwin typo 3, "recommend" instead of "recommended"?

PhpSwitcher - PHP-FPM support

Share

Daily visitors