====== LSPHP Command Line Mode ======






===== Summary =====

Usually, LSPHP(LSAPI + PHP) is managed by LiteSpeed Web Server. In a clustered environment, though, with a single LiteSpeed Web Server or LiteSpeed Web ADC load balancing LSPHP processes running on multiple backend servers, it may be necessary to start LSPHP processes manually. LSPHP is an executable and can be started manually and bound to IPv4, IPv6, or Unix domain socket addresses with the command line option ''-b socket_address''




===== Setup =====

==== Start lsphp from command line on remote server ====

Examples:

Have LSPHP bind to port 3000 on all IPv4 and IPv6 addresses:

  /path/to/lsphp -b [::]:3000

Have LSPHP bind to port 3000 on all IPv4 addresses:

  /path/to/lsphp -b *:3000

Have LSPHP bind to address 192.168.0.2:3000 :

  /path/to/lsphp -b 192.168.0.2:3000

Have LSPHP accept requests on Unix domain socket "/tmp/lsphp_manual.sock":

  /path/to/lsphp -b /tmp/lsphp_manual.sock 

Environment variables (please check [[litespeed_wiki:php:lsapi-environment-variables#environment_variables_configurable_at_lsphp_external_apps|here]] for a list of supported variables) can be added before the LSPHP executable. The `PHP_LSAPI_CHILDREN=nn` is required when run lsphp as a service to handle concurrent requests, `nn` should be, minimum, the concurrent level required by the frontend. It is running PHP in ProcessGroup mode. Note the following are only example figures, and you should adjust it to meet your need.

  PHP_LSAPI_MAX_REQUESTS=5000 PHP_LSAPI_CHILDREN=35 /path/to/lsphp -b IP_address:port

==== Setup LSAPI external app and script handler ====

**WebAdmin Console > Configuration > Server or Virtual Host > External App**

**Address** => ''IP_address: port'' (in step above)\\
**Start By Server** => ''No''





===== Load Balancing Backend PHPs =====

To load balance backend PHPs, create a "load balancer" external app, use backend PHPs (lsapi external app) as members and have script handler use the "load balancer" instead of php external app via Admin Console 

  * Create LSAPI external app for each backend PHP as does in the typical setup above such as 'remote php #1' for remote server #1, 'remote php #2' for remote server #2, ..., 'remote php #n' for remote server #n, etc.

  * Create a Load Balancer external app with backend LSAPI external apps in its workers list.

    Name:   lsphp5_cluster
    Workers:  LSAPI::remote php #1,LSAPI::remote php #2,...,LSAPI::remote php #n

  * Create a script handler for suffix php and tie to the load balancer external app (lsphp5_cluster) just created.

    Suffixes: php
    Handler Type: Load Balancer
    Handler Name: [Server Level]: lsphp5_cluster




===== Note =====

  * PHP scripts on local web server need to be rsync'd over to the remote server with exact path.

  * If local web server is chroot'd, then chroot needs to map to file system root of the remote server. e.g. if web server chroot is ''/usr/local/opt'', then ''/usr/local/opt/lsws/DEFAULT/html'' (default lsws vhost docroot) needs to be rsync'd over and placed on remote server as ''/lsws/DEFAULT/html''.

  * If no chroot, then ''/usr/local/lsws/DEFAULT/html'' should be rsync'd over as ''/usr/local/lsws/DEFAULT/html''.

  * For load balancing backend PHP setup, since PHP runs on different servers, a central shared PHP session storage like memcached, etc is recommended as LSWS load balancing is not session aware. An ideal set up is using LiteSpeed Load Balancer which is session aware in front of LiteSpeed web server clusters.