Differences

This shows you the differences between two versions of the page.

--- litespeed_wiki:plesk:php_guide [2016/10/14 15:13]
Rob Holda [Guide to Using PHP with Plesk and LSWS]
+++ litespeed_wiki:plesk:php_guide [2019/09/19 19:31]
Lisa Clarke Copyediting
@@ Line 1: / Line 1: @@
-====== Guide to Using PHP with Plesk and LSWS ======
+====== Using PHP with Plesk and LiteSpeed Web Server ======
-LiteSpeed Web Server requires PHP built with [[http://www.litespeedtech.com/products/litespeed-sapi/php|LSAPI]], our optimized SAPI. Plesk has those binary packages built into their multi-version php rpms for CentOS, Ubuntu, and Debian.
+LiteSpeed Web Server v5.4 and later auto-detects and loads all available PHP versions. This means PHP should work with Plesk out-of-the-box after LSWS installation. There is no need to configure individual PHP external apps if you don't have any special requirements.
-For new LSWS installations, the script will automatically do everything necessary, you may skip this guide without any problems.
+If you upgrade LSWS from an earlier version, there may be some existing internal apps and script handlers defined. There is no need to change any settings from LSWS Web Admin Console, as LSWS doesn't have its own native virtual hosts under Plesk. . If you need to change PHP versions or settings, you can simply do so through Plesk Admin (**Domain > PHP Settings**), the same way you would for Apache. LSWS reads Plesk Apache configuration files for virtual hosts and global settings.
-If you have an existing LSWS installation and would like to convert LiteSpeed to support Plesk PHP selector or are want to know how Plesk PHP selector works with LiteSpeed, the following wiki will outline the necessary steps to setup or convert to Plesk PHP selector for LiteSpeed.
+Use this wiki as a means of understanding how LiteSpeed Web Server and Plesk work together in terms of PHP. You shouldn't need to take these steps during installation, because LSWS should //just work// with Plesk PHP right away.
-====== For CentOS/Ubuntu/Debian Users ======
+====== CentOS/Ubuntu/Debian Users ======
+LiteSpeed Web Server requires LSPHP, which Plesk has built into its multi-version PHP rpms for CentOS, Ubuntu, and Debian. LSPHP is automatically installed when you install any version of Plesk Multi-PHP.
+Plesk versions older than 12.0 only support having a single version of PHP set up. Multi-PHP support started in Plesk 12.0. For CentOS/Ubuntu/Debian users, LSPHP will be installed through Plesk PHP CLI packages when you install any PHP version.
-You need to check which version of Plesk you are using. Version of Plesk older than 12.0 may have only one PHP setup, while starting from Plesk 12.0, multiple versions of PHP are supported. If so, for CentOS/Ubuntu/Debian users, lsphp will be installed through plesk-php-cli packages.
-  /opt/plesk/php/5.5/bin/lsphp
   /opt/plesk/php/5.2/bin/lsphp
   /opt/plesk/php/5.3/bin/lsphp
-  /opt/plesk/php/5.6/bin/lsphp
   /opt/plesk/php/5.4/bin/lsphp
+  /opt/plesk/php/5.5/bin/lsphp
+  /opt/plesk/php/5.6/bin/lsphp
   /opt/plesk/php/7.0/bin/lsphp
+  /opt/plesk/php/7.1/bin/lsphp
+  /opt/plesk/php/7.2/bin/lsphp
+  /opt/plesk/php/7.3/bin/lsphp
   plesk-php52-cli
   plesk-php53-cli
   plesk-php54-cli
+  plesk-php55-cli
+  plesk-php56-cli
+  plesk-php70-cli
+  plesk-php71-cli
+  plesk-php72-cli
+  plesk-php73-cli
   plesk-php55-cli
   plesk-php56-cli
   plesk-php70-cli
-if some versions are not installed, you can install them through command line:
+If any PHP versions are not installed, you can install them through the command line:
   plesk sbin autoinstaller --select-product-id plesk --select-release-current  --install-component phpx.x
@@ Line 32: / Line 44: @@
   Plesk 12.5: Ubuntu 12/14, Debian 7/8 and CentOS/RHEL 6, 7 operating systems.
-===== Setting up Multple PHPs for LSWS on Plesk >= 12.0 through script =====
+==== Verify Apache Ignore Modules ====
-To setup/migrate LiteSpeed to support the multi-version, the quickest and easiest way is to download and run script as root user:
-  wget http://www.litespeedtech.com/packages/plesk/migrate_litespeed_plesk_multi_php.sh
+Check the LiteSpeed setting  [[https://www.litespeedtech.com/docs/webserver/config/general#apacheIgnoredModules|Apache Ignore Modules]] located in the LiteSpeed WebAdmin Console under **Server > General > Using Apache Configuration File**. Make sure the following modules are ignored: ''mod_php5,sapi_apache2,python,mod_php4,mod_php7'', otherwise you may experience a "Forbidden: PHP engine is disabled." error, which is possibly caused by a PHP admin setting within those modules.
-  sh migrate_litespeed_plesk_multi_php.sh
-Notes: When set PHP for a domain, PHP running mode should run PHP as FastCGI application instead of FPM application. Current LiteSpeed PHP selector doesn't work with fpm application.
+NOTE: ''mod_fcgid'' should **NOT** be ignored.
-You can also set them up manually by following the steps below, though there is no such need if you run the migration script as above already.
+==== Must use FastCGI Application, not php-fpm ====
-===== Setting up Multple PHPs for LSWS on Plesk >= 12.0 manually =====
-With Plesk 12.0 and Plesk 12.5, you can install and use multiple PHP 5.x and 7.0 versions, built by the Plesk team via Plesk panel, without any additional third-party repositories or the need to build PHP from source yourself!  The corresponding **lsphp** binary has been included to plesk-phpxx-cli package. You will need to verify if those packages exist.
+In Plesk Admin, under **Domains > example.com > PHP settings**, when setting up PHP for a domain, PHP should be run as a ''FastCGI application'' instead of ''FPM application''. Currently the LiteSpeed PHP selector doesn't work with FPM applications.
-==== Verify apache Ignore Modules ====
+{{ :litespeed_wiki:plesk:plesk-php-fastcgi.png?nolink&700 |}}
-Check LiteSpeed configuration [[https://www.litespeedtech.com/docs/webserver/config/general#apacheIgnoredModules|Apache Ingore modules]] through LiteSpeed Web Admin Console -> Server-> General -> Using Apache Configuration File -> Ignore Apache Modules. Make sure the following modules ignored:**mod_php5,sapi_apache2,python,mod_php4**, while "mod_fcgid" should NOT be ignored.
+==== Verify your lsphp installations ====
-==== PHP running mode: FastCGI Application ====
+Please refer to [[https://kb.plesk.com/en/125146|this Plesk documentation]] to ensure Plesk's multi-version PHPs have been installed. It can also be checked through the Plesk GUI under **Add/Remove Components > Web hosting features > Different PHP interpreter versions**. Install them if they are not yet installed.
-Plesk Admin -> Domains-> <example.com>-> PHP settings, when set PHP for a domain, PHP running mode should run PHP as FastCGI application instead of FPM application. Current LiteSpeed PHP selector doesn't work with fpm application.
-{{ :litespeed_wiki:plesk:plesk-php-fastcgi.png?nolink&700 |}}
-==== Verify if lsphps have been installed ====
-Please refer to [[https://kb.plesk.com/en/125146|this plesk documentation]] to ensure plesk multi version PHPs have been installed. It can also be checked through Plesk GUI: Add/Remove Components > Web hosting features > Different PHP interpreters versions. Install them if not yet installed.
 {{ :litespeed_wiki:plesk:php_components.png?nolink&600 |}}
+The LSPHP binary is included in the Pleas PHPxx CLI package and the installation location should be:
-"lsphp" binary is included in plesk-phpxx-cli package and the installation location should be:
   find / | grep /bin/lsphp
@@ Line 91: / Line 91: @@
   ii  plesk-php70-cli                    7.0.8-debian7.0.16063012             amd64        Command-line interface for PHP
-If any plesk-php version not installed, you can install it through command line or Plesk GUI:
+If any plesk-php version is not installed, you can install it through the command line or Plesk GUI:
 Command line:
   plesk sbin autoinstaller --select-product-id plesk --select-release-current  --install-component phpx.x
-  ( x.x means 5.2, 5.3, 5.4, 5.5, 5.6, 7.0, any missing one).
+  ( x.x here can be 5.2, 5.3, 5.4, 5.5, 5.6, 7.0, any missing version).
 GUI:
-Plesk Installer interface and choose the PHP versions you need (Add/Remove Components > Web hosting features > Different PHP interpreters versions).
+Navigate to the Plesk Installer interface and choose the PHP versions you need (**Add/Remove Components > Web hosting features > Different PHP interpreter versions**).
-==== Configure lsphp external apps ====
-Plesk which supports multiple php normally use **php by OS** as system default PHP. "php by OS Vendor" is not recommended since it is usually an very old version of php and also there is no equivalent lsphp provided by OS Vendor. You will have to choose one of plesk lsphp as you want.  We recommend to set lsphp 5.6 as default php for LiteSpeed. You can also set to other version plesk lsphp.
-"php by OS" version can be checked through:
-  /usr/bin/php -i | more
-To setup php 5.6 as default, you will need to copy the related binary from plesk lsphp.
-  cp /opt/plesk/php/5.6/bin/lsphp /usr/bin/lsphp
-  /usr/bin/lsphp -i | more
-  ln -sf /usr/bin/lsphp /usr/local/lsws/fcgi-bin/lsphp5
-  service lsws restart
-There is no change on LSWS external app lsphp5 configuration, however the command binary will be changed through the above symbolic link to the selected plesk lsphp binary.
-Also you need to create all other version of lsphps. In LSWS's WebAdmin Console, under Configuration >> Server >> External App, then "Add" to create external app. In addition to the default lsphp5 application, create **lsphp52/lsphp53/lsphp54/lsphp55/lsphp56**, set socket addresses to be unique to others, usually same as app name and also set the **Command** field to the corresponding lsphp binary location, for example, "**/opt/plesk/php/x.x/bin/lsphp**" (where x.x should be **52,53,54,55,56 or 70**). The rest of settings can be copied from lsphp5. The following is an example snapshot for lsphp56, and the rest will be similar to it.
-{{ :litespeed_wiki:plesk:plesk-lsphp56.png?nolink&500 |}}
-{{:litespeed_wiki:plesk:plesk-multi-php-external-apps.png?700|}}
-If you prefer using the command line instead of the GUI tool, you can edit the LSWS configuration file (usually /usr/local/lsws/conf/httpd_config.xml) by adding the configuration settings ([[litespeed_wiki:plesk:php_guide:multi-php-config|refer here]]) to the <extProcessorList>… </extProcessorList> section.
-==== Set handler for different suffixes ====
-In LSWS Web Admin Console -> Configuration >> Server >> Script Handler, in addition to the default suffixes of **"php"** and **"php5"**, create the related suffixes **"php52"** **"php53"** **"php54"** **"php55"** **"php56"** with **Handler Type** LSAPI and **Handler Name** pointing to the newly created **lsphp52**,**lsphp53**,**lsphp53**,**lsphp54**,**lsphp55**,**lsphp56** External Apps accordingly. If your plesk supports php 7, you should also create suffix **"php70"** pointing to external app **"lsphp70"**.
-If you are a command line Guru and prefer to make the changes through the LSWS configuration file, simply edit the httpd_config.xml file (usually /usr/local/lsws/conf/httpd_config.xml) and add the configuration settings ([[litespeed_wiki:plesk:php_guide:multi-php-handlers|refer here]]) to your server side <scriptHandlerList>… </scriptHandlerList> section.
-{{:litespeed_wiki:plesk:plesk-multi-php-handlers.png?700|}}
-Gracefully restart LSWS to have these changes take effect.
 ==== 403 Forbidden error  ====
-If any suffixes are not properly set up, for example, **"php56"** is not set to handler **lsphp56**, then accounts using PHP 5.6 may still work from Apache but LiteSpeed will return "403 Forbidden" because the related PHP handler has not yet been set for LiteSpeed Web Server.
-===== Installing LSPHP for LSWS for Plesk < 12.0 =====
-If you use a version of Plesk older than 12.0, you may only set up one version of PHP, which is most likely your OS's default version. OS's default version doesn't come with LSPHP bianry.  You may have to choose similar PHP version either from LiteSpeed repository for CentOS users or build from source for Ubuntu/Debian users.
-==== CentOS Users ====
-For CentOS 5, 6, and 7 users, we have a PHP repository with a wide range of PHP options. When LSWS is installed on a CentOS machine through LiteSpeed's Plesk Extension, commonly used PHP packages will be installed automatically after choosing a PHP version. Thus most CentOS users will not need to update or adjust PHP after the initial installation.
-If you prefer to have matching PHP, you can check and install related lsphp versions yourself. The following outlines the steps for manually installing lsphp for your Plesk server after installation. Installation through LiteSpeed repository is recommended, though you can also use Remi Repo or compile yourself.
-=== Installing through LiteSpeed PHP Repository ===
-Check which PHP version is being used by Plesk.
-  rpm -qa | grep php-
- The result may differ between systems. For example, in CentOS6, it may return the default OS version of php 5.3.3.
-  php-common-5.3.3-46.el6_6.x86_64
-  php-mbstring-5.3.3-46.el6_6.x86_64
-  php-cli-5.3.3-46.el6_6.x86_64
-  php-fpm-5.3.3-46.el6_6.x86_64
-  php-mysql-5.3.3-46.el6_6.x86_64
-  php-imap-5.3.3-46.el6_6.x86_64
-  php-xml-5.3.3-46.el6_6.x86_64
-  php-pdo-5.3.3-46.el6_6.x86_64
-  php-gd-5.3.3-46.el6_6.x86_64
-  php-5.3.3-46.el6_6.x86_64
-Next you will need to install the corresponding version of lsphp, in this case it would be lsphp53.
-First make sure that the LiteSpeed Repo is enabled, and then install lsphp with the following command:
-  yum install lsphp53 lsphp53-common lsphp53-mbstring lsphp53-mysql lsphp53-imap lsphp53-xml lsphp53-pdo lsphp53-gd
-As noted above, most CentOS users will be adequately supported by the PHP build automatically installed when they installed LSWS through the Plesk Extension. Despite this, you may still want to add some of the special options available in the LiteSpeed Repository (such as opcode caching or alternate MySQL support packages).
-For example,
-   yum install lsphp53-pecl-apc
-or
-   yum install lsphp56-opcache
-Please see the [[litespeed_wiki:php:rpm#installing_php_from_the_litespeed_repository|LiteSpeed Repository wiki entry]] for a full guide on installing PHP from our repository.
-=== Installing PHP through Remi Repository ===
-Les RPMs de Remi (Remi Repository) is an extensive, widely-used PHP repository, which also includes options to build PHP for LSWS (with LSAPI). Remi Repository contains a variety of uncommon PHP options, and thus will be a good for CentOS users whose applications need less common options.
-Please see the [[litespeed_wiki:php:rpm#installing_php_from_remi_repo|LiteSpeed Repository wiki entry]] for a full guide on installing PHP for LSWS from Remi Repo.
-=== Building PHP from Source ===
-Building PHP from source code is not recommended for CentOS user since RPM installation is much quicker. Users using an OS other than CentOS may have to compile PHP from source. This can be done from the command line or from LSWS's WebAdmin Console using our Build PHP tool.
-Please see the [[litespeed_wiki:php:lsapi|Compiling PHP for LSWS (with LSAPI) wiki]] for a full guide on building PHP for LSWS through the WebAdmin Console.
-==== Debian Users ====
+If any suffixes are not properly setup, for example, ''php56'' is not set to use the ''lsphp56'' handler, then accounts using PHP 5.6 may still work from Apache, but LiteSpeed will return a ''403 Forbidden'' error. This is because the related PHP handler has not yet been set for LiteSpeed Web Server.
-For Debian 8, please follow the instruction to [[litespeed_wiki:php:apt|install php5-litespeed package from repository]] to install php5-litespeed binary from repository or [[litespeed_wiki:php:lsapi|compile PHP from source code]]. For Debian 7, you can  [[litespeed_wiki:php:lsapi|compile PHP from source code]].
-==== Ubuntu Users ====
-For Ubuntu 12 and 14, you need to compile PHP from source code.
 ====== For CloudLinux Users ======
-PHP selector is recommended for your PHP configuration, though you can still use plesk-phpxx if you prefer it.
+===== How to configure LSWS to use the CloudLinix PHP selector on Plesk =====
-Assume that you have installed CloudLinux CageFS , enabled CageFS for all users, PHP-selector and lvemanager also have been installed. If php-selector was not installed, try [[http://docs.cloudlinux.com/index.html?installation.html|this installation guide]]
+On a CloudLinux system, you have a choice of using either Plesk Multi-PHP or CloudLinux PHP Selector. When installing LSWS, the installation script will automatically configure PHP to use Plesk Multi-PHP and to use PHP version 5.6 by default.
-  yum groupinstall alt-php
+The following default external apps are added to LSWS during the installation: ''lsphp5x'' and ''lsphp7x'' are for Plesk Multi-PHP. ''lsphp_selector'' is for CloudLinux PHP Selector.
-  yum update cagefs lvemanager
+{{ :litespeed_wiki:plesk:plesk-installation-php-external-apps.png?800 |}}
-===== Setup native PHP for LiteSpeed =====
+''lsphp_selector'' is configured to use the command: ''/usr/local/bin/lsphp''
-Almost all php versions can be handled by CloudLinux PHP selector directly, while native mode for LiteSpeed need to be installed and configured manually.
+{{ :litespeed_wiki:plesk:plesk-installation-php-external-apps-lsphp-selector.png?700 |}}
-When you install LiteSpeed through plesk-litespeed extension, it will ask you for default PHP version.  you need to find out the native PHP version by printing the PHP interpreter summary as the following command:
+By default, we configure Plesk Multi-PHP 56 as default handler out of the box.
-  selectorctl --summary --show-native-version
+{{ :litespeed_wiki:plesk:plesk-installation-php-external-apps-php-handler-default.png?700 |}}
-.4 e -
+If you want to set CloudLinux PHP Selector as the handler instead, you will need to change **php** and **php5** handlers from ''lsphp56'' to ''lsphp_selector'' as the following, assuming that you have installed CloudLinux CageFS, enabled CageFS for all users, and PHP-Selector and lvemanager have also been installed and configured correctly.
-.1 e -
-.2 e -
-.3 e -
-.4 e -
-.5 e -
-.6 e -
-.0 e -
-  native(5.3) e d
- It lists all available PHP versions and 5.3 is the native and default version.
-choose "5.3" during the installation and extension will install a default list of PHP packages.
-If the wrong version was picked for native mode during this installation, you can correct it manually as the following.
+{{ :litespeed_wiki:plesk:plesk-installation-php-external-apps-php-handler-to-php-selector.png?700 |}}
-Check installed packages:
+If you have not installed and configured CloudLinux PHP Selector yet, you can take a look the following steps before you configure on LSWS as above.
-  rpm -qa | grep php-
-  alt-php-config-1-5.el6.noarch
-  php-cli-5.3.3-46.el6_6.cloudlinux.x86_64
-  php-devel-5.3.3-46.el6_6.cloudlinux.x86_64
-  php-mbstring-5.3.3-46.el6_6.cloudlinux.x86_64
-  php-5.3.3-46.el6_6.cloudlinux.x86_64
-  php-xml-5.3.3-46.el6_6.cloudlinux.x86_64
-  php-common-5.3.3-46.el6_6.cloudlinux.x86_64
-  php-pdo-5.3.3-46.el6_6.cloudlinux.x86_64
-  php-ioncube-loader-4.0.12-1.el6.cloudlinux.x86_64
-  php-gd-5.3.3-46.el6_6.cloudlinux.x86_64
-  php-imap-5.3.3-46.el6_6.cloudlinux.x86_64
-  php-mysql-5.3.3-46.el6_6.cloudlinux.x86_64
-then install similar lsphp packages:
-  yum install lsphp53 lsphp53-common lsphp53-mbstring lsphp53-xml lsphp53-pdo lsphp53-ioncube-loader lsphp53-gd lsphp53-imap lsphp53-mysql
-The PHP binary is installed to /usr/local/lsws/lsphp53/bin/lsphp
-copy the installed binary to /usr/local/bin/
-  cp /usr/local/lsws/lsphp53/bin/lsphp /usr/local/bin/lsphp
-Force update the CageFS:
-  /usr/sbin/cagefsctl --force-update
-===== Config LiteSpeed to use PHP selector =====
-Follow this guide to configure LiteSpeed to use php selector http://docs.cloudlinux.com/index.html?litespeed_support.html.
-.CloudLinux (Admin Console --> Configuration --> Server --> General): CageFS
-.Enable SuExec: Server-> General -> PHP SuEXEC -> Yes
-.LSPHP5 external app runs in SUEXEC non-daemon mode ONLY (Run On Start Up --> Yes or No)
-.In lsphp5 external app (Admin Console --> Configuration --> Server --> External App --> lsphp5)
-Change the following:
-  command => $SERVER_ROOT/fcgi-bin/lsphp5
-to:
-  command => /usr/local/bin/lsphp
-===== Config PHP version for users =====
-PHP Selector provides an easy way to figure out which versions are available and selected for end user from command line. You can get this information by running:
-  /usr/bin/cl-selector --summary php --user _USERNAME_
-  /usr/bin/cl-selector --current=php --user=USERNAME
-will retrieve PHP version set for a particular user.
-  /usr/bin/cl-selector --select=php --version=x.x(or native) --user=USERNAME
-will set desired current PHP version for particular user