## 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

# 虚拟主机一般设置

## Table of Contents

### 文档根目录⇑

#### Description

指定此虚拟主机的文档根目录。 推荐使用$VH_ROOT/html。在context中，此目录可以用$DOC_ROOT来引用。

#### Syntax

可以说绝对路径,也可以是相对于$SERVER_ROOT或$VH_ROOT的相对路径。

### 管理员邮箱⇑

#### Description

指定这个虚拟主机管理员的电子邮箱地址。

#### Syntax

Comma separated list of email addresses

### 启用 GZIP 压缩⇑

#### Description

指定是否为此虚拟主机启用GZIP压缩。 这个设置仅在服务器级启用GZIP压缩 设置为 Yes时有效.

#### Syntax

从单选框选择

#### See Also

启用GZIP压缩

### Brotli 压缩⇑

#### Description

指定是否为此虚拟主机启用Brotli压缩。 这个设置仅在服务器级Brotli 压缩等级 (静态文件)设置为一个非零值时有效.

#### Syntax

从单选框选择

#### See Also

Brotli 压缩等级 (静态文件)

### 启用IP地理定位⇑

#### Description

指定是否启用IP地理定位查找。 可以在服务器级别，虚拟主机级别，或context级别设置。

#### Syntax

从单选框选择

#### See Also

使用报头中的客户端IP, 数据库文件路径,

### cgroups⇑

#### Description

如果当前操作系统支持(目前支持RedHat/Centos Linux v7.5+和Ubuntu 18.04+)，则将cgroup设置应用于此CGI进程。 。 当前执行的用户将用于确定要应用的cgroup配置。
在服务器级别将此设置为Disabled将在服务器范围内禁用此设置。 在其他情况下，可以在虚拟主机级别覆盖服务器级别的设置。
默认值:
服务器级别: Off
虚拟主机级别: 继承服务器级别设置

#### Syntax

从列表中选择

### 使用服务器日志⇑

#### Description

指定是否将虚拟主机的日志信息放置到服务器日志文件中，而不是创建独自的日志文件。

#### Syntax

从单选框选择

### 文件路径⇑

#### Description

指定日志文件的路径。

#### Syntax

文件名可以是绝对路径,也可以是相对于$SERVER_ROOT,$VH_ROOT的相对路径。

#### 提示

[性能建议] 将日志文件放在单独的磁盘上。

### 日志级别⇑

#### Description

指定日志记录级别。可用级别（从高到低）为ERROR, WARNING, NOTICE, INFO, 和 DEBUG。 只有当消息等级高于或与当前设置相同时才被记录。 如果您希望将此设置为DEBUG，您也需要设置服务器日志级别为DEBUG。 调试的级别只能在服务器级别通过调试级别控制。

#### Syntax

从列表中选择

#### 提示

[性能建议] 除非调试级别设置为NONE以外的日志级别, 否则DEBUG级别不会对性能产生任何影响，推荐采用。

#### See Also

调试级别

### 回滚大小 (bytes)⇑

#### Description

指定何时日志文件需要回滚，也称为日志循环。 当文件大小超过回滚限制后，在使用的日志文件将在同一目录中被重命名 为log_name.mm_dd_yyyy(.sequence)，一个新的日志文件将被创建。 回滚的日志文件的实际大小有时会比限制值稍微大一些。 将值设置为0将禁用日志循环。

#### Syntax

整数

#### 提示

请用“K”，“M”，“G”代表千字节，兆字节和千兆字节。

### 保留天数⇑

#### Description

指定访问日志文件将被保存在磁盘上多少天。 只有超出指定天数的回滚日志文件会被删除。 当前的日志文件不会被删除，无论它包含了多少天的数据。 如果你不想自动删除过时的、很旧的日志文件， 将该值设置为0。

#### Syntax

整数

### 压缩存档⇑

#### Description

指定是否压缩回滚日志以节省磁盘空间。

#### Syntax

从单选框选择

#### 提示

日志文件是高度可压缩的，建议采取压缩以减少旧日志的磁盘占用量。

### 日志管理⇑

#### Description

指定写入访问日志的地点。这里有三个选项：

1. 写入到服务器的访问日志；
2. 为虚拟主机创建一个访问日志；
3. 禁用访问日志记录

#### Syntax

从列表中选择

### 文件名⇑

#### Description

访问日志的文件名

#### Syntax

文件名可以是绝对路径,也可以是相对于$SERVER_ROOT,$VH_ROOT的相对路径。

#### 提示

[性能建议] 将访问日志文件放在单独的磁盘上。

### 管道日志记录⇑

#### Description

指定外部应用程序，该应用程序将通过其STDIN流（文件句柄为0）上的pipe接收LiteSpeed发送的访问日志数据。 指定此字段后，访问日志将仅发送到记录器应用程序，而不发送到上一个条目中指定的访问日志文件。
首先必须在外部应用中定义记录器应用程序。 服务器级别的访问日志记录只能使用在服务器级别定义的外部记录器应用程序。 虚拟主机级别的访问日志记录只能使用在虚拟主机级别定义的记录器应用程序。
记录器进程的启动方式与其他外部进程相同 (CGI/FastCGI/LSAPI)过程。这意味着它将作为 在虚拟主机的外部应用程序设置UID模式设置中指定的用户ID，并且永远不会以特权用户运行。
如果配置了多个记录器的实例，LiteSpeed web server将在多个记录器之间执行简单的负载均衡。LiteSpeed服务器始终尝试将记录器应用程序的数量保持在尽可能低的水平。只有当一个记录器应用程序未能及时处理访问日志条目时，服务器才会尝试启动记录器的另一个实例。
如果记录器崩溃，Web服务器将启动另一个实例，但是流缓冲区中的日志数据将丢失。 如果外部记录器无法跟上日志流的速度和数量，则可能会丢失日志数据。

#### Syntax

从列表中选择

### 日志格式⇑

#### Description

指定访问日志的格式。 设置之后，它将覆盖记录头部 的设定。

#### Syntax

字符串。日志格式的语法与Apache 2.0自定义 log format.

#### 例子

一般日志格式（CLF）
"%h %l %u %t \"%r\" %>s %b"
支持虚拟主机的一般日志格式
"%v %h %l %u %t \"%r\" %>s %b"
NCSA扩展/组合日志格式
"%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"
记录Foobar的cookie值
"%{Foobar}C"

#### See Also

记录头部

### 记录头部⇑

#### Description

指定是否记录HTTP请求头: Referer、 UserAgent和Host。

#### Syntax

从复选框中选择

#### 提示

[性能建议] 如果你不需要在访问日志中记录这些头部信息，关闭这个功能。

#### See Also

日志格式

### 字节记录⇑

#### Description

指定带宽字节日志文件的路径。设置后，将创建一份兼容cPanel面板的带宽日志。这将记录 一个请求传输的总字节数，包括请求内容和响应内容。

#### Syntax

文件名可以是绝对路径,也可以是相对于$SERVER_ROOT的相对路径。

#### 提示

[性能建议] 将日志文件放置在一个单独的磁盘上。

### 使用服务器索引文件⇑

#### Description

指定是否使用服务器的索引文件。 如果设置为Yes，那么只有服务器的设置将被使用。 如果设置为No，那么服务器的设置将不会被使用。 如果设置为Addition，那么附加的索引文件可以被添加到此虚拟主机服务器的索引文件列表中。 如果想要禁用此虚拟主机的索引文件，您可以将该值设置为No，并将索引文件栏留空。 field empty.

#### Syntax

从列表中选择

### 索引文件⇑

#### Description

指定URL映射到目录时顺序查找的索引文件名称。 您可以在服务器、虚拟主机和Context级别对其进行自定义。

#### Syntax

Comma-delimited list of index filenames.

#### 提示

[性能建议] 只设置你需要的索引文件。

### 自动索引⇑

#### Description

在目录中，当索引文件中所列的索引文件不可用时，指定运行时是否即时生成目录索引。
此选项可以在虚拟主机级别和context级别中设置，并可以顺着目录树继承，直到被覆盖。 您可以自定义生成的索引页面。请访问在线百科了解如何操作。

#### Syntax

从单选框选择

#### 提示

[安全建议] 建议关闭自动索引，从而尽可能防止泄露机密数据。

#### See Also

索引文件, 自动索引URI

### 自动索引URI⇑

#### Description

在目录中，当索引文件中所列出的索引文件（index）不可用时，指定用来生成索引页面的URI。 LiteSpeed Web服务器使用一个外部脚本来生成索引页面，从而为定制提供最大的灵活性。 默认的脚本生成一个类似于Apache的索引页面。 定制生成的索引页，请访问在线百科。 被索引的目录通过一个环境变量 "LS_AI_PATH"来传递给脚本。

#### Syntax

URI

#### See Also

索引文件, 自动索引

### 自定义错误页面⇑

#### Description

当服务器在处理请求时遇到问题， 服务器将向网络客户端返回错误代码和html页面作为错误消息。 错误代码在HTTP协议中定义（请参阅RFC 2616）。 LiteSpeed Web服务器为每个错误代码都有一个内置的默认错误页面，但是也可以为每个错误代码配置一个自定义页面。 甚至可以进一步自定义这些错误页面，以使其对于每个虚拟主机都是唯独特的。

### 错误代码⇑

#### Description

指定错误页面的HTTP状态码。 只有特定的HTTP状态码才可以自定义错误页面。

#### Syntax

从列表中选择

### URL⇑

#### Description

指定自定义错误页的URL。 当返回相应HTTP状态时服务器会将请求转发到该URL。 如果此URL指向一个不存在的地址，自带的错误页面将被使用。 该URL可以是一个静态文件，动态生成的页面，或者其他网站的页面 （网址开头为"http(s): //"）。 当转发到在其他网站上的页面时，客户端会收到一个重定向状态码 来替代原本的状态码。

#### Syntax

URL

### 启用过期⇑

#### Description

指定是否为静态文件生成Expires头。如果启用，将根据 默认过期和按类型过期生成Expires头。
这可以在服务器，虚拟主机和Context级别设置。低级别的设置将 覆盖高级别的设置。例如，Context级别的设置将覆盖虚拟主机级别的设置， 虚拟主机级别的设置将覆盖服务器级别的设置。

#### Syntax

从单选框选择

### 默认过期⇑

#### Description

指定生成Expires头的默认设置。该设置在启用过期 设为“启用”时有效。它可以被按类型过期覆盖。 除非必要，否则不要在服务器或虚拟主机级别设置该默认值。 因为它会为所有网页生成Expires头。大多数时候，应该是 为不常变动的某些目录在Context级别设置。如果没有默认设置，按类型过期中未指定的类型不会生成Expires头。

#### Syntax

A|Mseconds
文件将在基准时间（A|M）加指定秒数的时间后失效。 “A”代表基准时间为客户端的访问时间，“M”代表文件的最后修改时间。

### 按类型过期⇑

#### Description

为各个MIME类型分别指定Expires头设置。

#### Syntax

逗号分隔的“MIME-类型=A|M秒数”的列表。 文件将在基准时间（A|M）加指定秒数的时间后失效。
“A”代表基准时间为客户端的访问时间，“M”代表文件的最后修改时间。 MIME-类型可使用通配符“*”，如image/*。

### 文件上传⇑

#### Description

通过使用请求正文解析器将文件解析到服务器本地目录中来上传文件时，提供了附加的安全功能。第三方模块可以轻松地在文件本地目录中扫描文件是否存在危害。 当启用通过文件路径传递上传数据或模块在LSI_HKPT_HTTP_BEGIN级别调用LSIAPI的set_parse_req_body时，将使用请求正文解析器。 源代码包中提供的API示例。

#### See Also

Hook::HTTP_BEGIN Priority

### 临时文件路径⇑

#### Description

在扫描请求正文工作时，上传到服务器的文件将存放在临时目录中 默认值为/tmp/lshttpd/.

#### Syntax

Absolute path or path starting with $SERVER_ROOT (for Server and VHost levels) or $VH_ROOT (for VHost levels).

### 临时文件权限⇑

#### Description

设置临时文件路径目录中的文件权限。 服务器级别是全局设置，可以被虚拟主机级别的设置覆盖。

#### Syntax

3 digits octet number. Default value is 666.

### 通过文件路径传递上传数据⇑

#### Description

指定是否按文件路径传递上传数据。 如果启用，则上传时文件路径以及其他一些信息将发送到后端处理程序，而不是文件本身。 这样可以节省CPU资源和文件传输时间，但需要一些更新才能实现。 如果禁用，则文件内容将传输到后端处理程序，请求主体仍解析为文件。

#### Syntax

从单选框选择

#### 提示

[性能] 如果向下兼容不是问题，启用此功能可加快文件上传处理速度。

### 后缀⇑

#### Description

指定将由此脚本处理程序处理的脚本文件后缀。 后缀必须是唯一的。

#### Syntax

Comma delimited list with period "." character prohibited.

#### 提示

服务器将为列表中的第一个后缀自动添加特殊的MIME类型 ("application/x-httpd-[suffix]") 。 例如，将为后缀“ php53”添加MIME类型“ application/x-httpd-php53”。 首先需要在MIME设置设置中设置后缀。
尽管我们在此字段中列出了后缀，但是脚本处理程序使用MIME类型而非后缀来确定要处理的脚本。
[性能和安全建议] 仅指定您真正需要的后缀。

### 类型⇑

#### Description

指定处理这些脚本文件的外部程序类型。 可用类型有：CGI, FastCGI, Web服务器, LSAPI应用程序, 负载均衡器, 或 Servlet引擎。 对于FastCGI, Web服务器和Servlet引擎，需要指定处理器名称。 这是在外部应用部分预设定的外部程序名称。

#### Syntax

从列表中选择

### 处理器名称⇑

#### Description

当处理器类型为FastCGI，Web服务器，LSAPI，负载均衡器或Servlet引擎时， 指定处理脚本文件的外部程序名称。

#### Syntax

从列表中选择

### php.ini 重写⇑

#### Description

用于覆盖当前context（虚拟主机级别或context级别）中的php.ini设置。
支持的指令是：
php_value
php_flag
php_admin_value
php_admin_flag
所有其他行/指令将被忽略。

#### Syntax

Override syntax is similar to Apache, a newline separated list of directives and their values with each directive being prepended by php_value, php_flag, php_admin_value, or php_admin_flag appropriately.

#### 例子

php_value include_path ".:/usr/local/lib/php"
php_admin_flag engine on
php_admin_value open_basedir "/home"