## OpenLiteSpeed Web Server Users' Manual

### Version 1.8 — Rev. 6

- License
- Introduction
- Installation
- Administration
  - Service Manager
  - Real-Time Stats
- Security
- Configuration
  - Server General
  - Server Log
  - Server Tuning
  - Server Security
  - External Apps
  - Fast CGI App
  - Fast CGI Authorizer
  - LSAPI App
  - Servlet Engine
  - Web Server
  - Piped logger
  - Load Balancer
  - Script Handler
  - App Server Settings
  - Module Configuration
  - Listener General
  - Listener SSL
  - Virtual Host Templates
  - Virtual Host Basic
  - Virtual Host General
  - Virtual Host Security
  - Virtual Host SSL
  - Rewrite
  - Context
  - Static Context
  - Java Web App Context
  - Servlet Context
  - Fast CGI Context
  - LSAPI Context
  - Proxy Context
  - CGI Context
  - Load Balancer Context
  - Redirect Context
  - App Server Context
  - Module Handler Context
  - Web Socket Proxy
- Web Console
  - Admin Console General
  - Admin Console Security
  - Admin Listener General
  - Admin Listener SSL

# LiteSpeed SAPI App

## Table of Contents

### 名称⇑

#### Description

此外部应用程序的唯一名称。 在配置的其他部分中使用该名称时，将使用该名称进行引用。

### 地址⇑

#### Description

外部应用程序使用的唯一套接字地址。 支持IPv4/IPv6套接字和Unix域套接字（UDS）。 IPv4/IPv6套接字可用于网络通信。 只有当外部应用程序与服务器在同一台机器上时，才能使用UDS。

#### Syntax

IPv4 或 IPV6 address:port 或者 UDS://path

#### 例子

127.0.0.1:5434
UDS://tmp/lshttpd/php.sock.

#### 提示

[安全建议] 如果外部应用程序在同一台机器上运行，则首选UDS。如果必须使用IPv4|IPV6, 将IP地址设置为localhost或127.0.0.1，这样外部应用就无法从其他机器上访问。 [性能建议] Unix域套接字一般比IPv4套接字拥有更高的性能。

### 最大连接数⇑

#### Description

指定服务器与外部应用之间可建立的最大并发连接数。该设置控制外部应用程序可同时处理多少个请求。 然而，真正的限制还取决于外部应用本身。如果外部的速度不够快，或者无法处理大量的并发请求，那么将这个值设置得更高也无济于事。

#### Syntax

整数

#### 提示

[性能建议] 设置一个高值并不能直接变成高性能。设置为一个不会使外部应用程序过载的值，将提供最佳的性能/吞吐量。

### 环境⇑

#### Description

为外部应用程序指定额外的环境变量。

#### Syntax

Key=value. Multiple variables can be separated by "ENTER"

### 初次请求超时时间 (secs)⇑

#### Description

指定服务器等待外部应用响应新建立的连接的第一个请求的最大时间 如果服务器在这个限制时间内没有收到外部应用的任何数据，它将把这个连接标记为坏(Bad)。这有助于识别与外部应用程序的通信问题。 这有助于尽快发现与外部应用的通信问题。如果某些请求的处理时间较长，则增加这个限制以避免503错误信息。

#### Syntax

整数

### 重试超时时间 (secs)⇑

#### Description

指定服务器在重试之前，等待出现通信问题的外部应用程序的时间。

#### Syntax

整数

### 持久连接⇑

#### Description

指定在处理完请求后是否要保持连接 持久连接可以提高性能， 但某些FastCGI外部应用程序不完全支持持久连接。默认为 "On"。

#### Syntax

从单选框选择

### 持久连接超时时间⇑

#### Description

指定保持持久连接的最大时间，以秒为单位。
如果设置成"-1",连接将不会超时. 当设置成0或者更大, 连接将在这些秒数后被关闭。

#### Syntax

int

### 响应缓冲⇑

#### Description

指定是否要从外部应用程序缓冲收到的响应。 如果nph-(Non-Parsed-Header)脚本被检测到，则关闭具有完整HTTP头的缓冲响应。

#### Syntax

从列表中选择

### 开机自启⇑

#### Description

指定是否要Web服务器自动启动应用程序。只有运行在同一台机器上的FastCGI和LSAPI应用程序才能自动启动。 地址中的IP必须是本地IP. 通过LiteSpeed CGI守护进程而不是主服务器进程启动,有助于减少系统开销。
Default value: Yes (Through CGI Daemon)

#### Syntax

从列表中选择

### 命令⇑

#### Description

指定包含外部应用程序的执行参数在内的完整命令行。 需要开机自启的值为enable.如果参数中包含空格或制表符,应使用双引号或单引号将其引起。

#### Syntax

Full path to the executable with optional parameters.

#### See Also

开机自启

### Back Log⇑

#### Description

Specifies the backlog of the listening socket. Required if 开机自启 is enabled.

#### Syntax

整数

### 实例数⇑

#### Description

指定服务器创建的外部应用的最大实例数。这个选项需要开机自启的值为enable. 大多数FastCGI/LSAPI应用程序每个进程实例只能处理一个请求，对于这种类型的应用，实例数应与最大连接数的值相匹配。 而有些FastCGI/LSAPI应用程序可以生成多个子进程以同时处理多个请求. 对于这种类型的应用，应将实例设置为 "1"，并使用环境变量来控制应用可以生成多少个子进程。

#### Syntax

整数

### Run As User⇑

#### Description

The external application will run as this specified user name. If not set, Virtual Host level settings will be inherited.
Default value: Not Set

#### Syntax

Valid username.

#### See Also

extGroup

### 以特定组运行⇑

#### Description

外部应用程序将作为此指定的组名运行。如果未设置，将继承虚拟主机级别的设置。
Default value: Not Set

#### Syntax

Valid group name.

#### See Also

extUser

### umask⇑

#### Description

Sets default umask for this external application's processes. See man 2 umask for details. The default value taken from the server-level umask setting.

#### Syntax

value valid range [000]-[777].

#### See Also

CGI umask

### 开机自启⇑

#### Description

指定是否在服务器启动时启动外部应用程序. 只适用于可以管理自己子进程的外部应用程序，并且实例数值设置为"1"。
如果启用，将在服务器启动时而不是运行时创建外部进程.
When selecting "Yes (Detached mode)", all detached process can be restarted at the Server level or Virtual Host level by touching the '.lsphp_restart.txt' file under the $SERVER_ROOT/admin/tmp/ or $VH_ROOT/ directory respectively.
Default value: Yes (Detached mode)

#### Syntax

从单选框选择

#### 提示

[性能建议] 如果配置的外部进程有很大的启动开销，比如Rails，那么应该启用这个选项来减少首页响应时间。

### 最大空闲时间⇑

#### Description

指定服务器停止外部应用之前的最大空闲时间，以释放空闲资源。 当设置为"-1"时，服务器将不会停止外部应用，除非在ProcessGroup模式下运行, 而在ProcessGroup模式下,闲置的外部应用将在30秒后停止.
默认值为: -1{/val}

#### Syntax

Integer number

#### 提示

This feature is especially useful in the mass hosting environment where, in order to prevent files owned by one virtual host from being accessed by the external application scripts of another virtual host, many different applications are run at the same time in SetUID mode. Set this value low to prevent these external applications from idling unnecessarily.

### 优先级⇑

#### Description

指定外部应用的优先级,值的范围是-20到20. 一个小的数字意味着高优先级.外部应用进程的优先级不能比Web服务器高. 如果该优先级设置一个比服务器的优先级小的数字，则将使用服务器的优先级。

#### Syntax

int

#### See Also

Server 优先级

### 内存软限制 (bytes)⇑

#### Description

以字节为单位指定服务器启动的外部应用进程或程序的内存占用限制。
此限制的目的主要是为了防范软件缺陷或蓄意攻击造成的过度内存使用， 而不是限制正常使用。确保留有足够的内存，否则您的应用程序可能故障并 返回503错误。限制可以在服务器级别或独立的外部应用程序级别设置。如 果未在独立的外部应用程序级别设定限制，将使用服务器级别的限制。
如果在两个级别都没有设置该限制，或者限制值设为0，将使用操 作系统的默认设置。

#### Syntax

整数

#### 提示

[注意] 不要过度调整这个限制。如果您的应用程序需要更多的内存， 这可能会导致503错误。

### 内存硬限制 (bytes)⇑

#### Description

与内存软限制 (bytes)非常相同，但是在一个用户进程中，软限制 可以被放宽到硬限制的数值。硬限制可以在服务器级别或独立的外部应用程序级别设 置。如果未在独立的外部应用程序级别设定限制，将使用服务器级别的限制。
如果在两个级别都没有设置该限制，或者限制值设为0，将使用操 作系统的默认设置。

#### Syntax

整数

#### 提示

[注意] 不要过度调整这个限制。如果您的应用程序需要更多的内存， 这可能会导致503错误。

### 进程软限制⇑

#### Description

限制用户可以创建的进程总数.所有现有的进程都将被计算在这个限制之内,而不仅仅是要启动的新进程。
该限制可以在服务器级别或单个外部应用级别进行设置.如果未在应用级别设置，则将使用服务器级别的限制. 如果该值为0或服务器级和应用级都没有设置,将使用操作系统的默认设置

#### Syntax

整数

#### 提示

PHP scripts can call for forking processes. The main purpose of this limit is as a last line of defense to prevent fork bombs and other attacks caused by PHP processes creating other processes.
Setting this setting too low can severely hurt functionality. The setting will thus be ignored below certain levels.
When Run On Start Up is set to "Yes (Daemon mode)", the actual process limit will be higher than this setting to make sure parent processes are not limited.

### 进程硬限制⇑

#### Description

与进程软限制非常相同，但是，在用户进程中软限制 可以被放宽到硬限制的数值。硬限制可以在服务器级别或独立的外部应用程序级别设 置。如果未在独立的外部应用程序级别设定限制，将使用服务器级别的限制。 如果在两个级别都没有设置该限制，或者限制值设为0，将使用操 作系统的默认设置。

#### Syntax

整数