模块 ngx_http_ssi_module

该ngx_http_ssi_module模块是一个过滤器，用于处理通过它的响应中的 SSI（服务器端包含）命令。目前，支持的 SSI 命令列表不完整。

location / {
    ssi on;
    ...
}

ssi off;

启用或禁用响应中 SSI 命令的处理。

ssi_last_modified off;

允许在 SSI 处理期间保留原始响应中的“Last-Modified”标头字段，以方便响应缓存。

默认情况下，当响应内容在处理过程中被修改时，标头字段将被删除，并且可能包含独立于原始响应而更改的动态生成的元素或部分。

ssi_min_file_chunk 1k;

设置存储在磁盘上的响应部分的最小值，从该最小值开始使用sendfilesize发送它们是有意义的 。

ssi_silent_errors off;

[an error occurred while processing the directive]如果启用，如果在 SSI 处理期间发生错误， 则抑制“ ”字符串的输出。

ssi_types text/html;

除了“ ”之外，还可以处理具有指定 MIME 类型的响应中的 SSI 命令text/html。特殊值“ *”匹配任何 MIME 类型 (0.8.29)。

ssi_value_length 256;

设置 SSI 命令中参数值的最大长度。

SSI 命令具有以下通用格式：

<!--# command parameter1=value1 parameter2=value2 ... -->

支持以下命令：

block

定义可在命令中用作存根的块include。该块可以包含其他 SSI 命令。该命令具有以下参数：

name

块名称。

例子：

<!--# block name="one" -->
stub
<!--# endblock -->

config

设置SSI处理过程中使用的一些参数，即：

errmsg

如果在 SSI 处理期间发生错误，则输出一个字符串。默认情况下，输出以下字符串：

[an error occurred while processing the directive]

timefmt

strftime()传递给用于输出日期和时间的函数的 格式字符串。默认情况下，使用以下格式：

"%A, %d-%b-%Y %H:%M:%S %Z"

“ %s”格式适合输出以秒为单位的时间。

echo

输出变量的值。该命令具有以下参数：

var

变量名。

encoding

编码方法。可能的值包括none、url和 entity。默认情况下，entity使用。

default

一个非标准参数，用于在变量未定义时设置要输出的字符串。(none)默认情况下，输出“ ”。命令

<!--# echo var="name" default="no" -->

替换以下命令序列：

<!--# if expr="$name" --><!--# echo var="name" --><!--#
       else -->no<!--# endif -->

if

执行条件包含。支持以下命令：

<!--# if expr="..." -->
...
<!--# elif expr="..." -->
...
<!--# else -->
...
<!--# endif -->

目前仅支持一层嵌套。该命令具有以下参数：

expr

表达。表达式可以是：

• 变量存在检查：

  <!--# if expr="$name" -->
  

• 变量与文本的比较：

  <!--# if expr="$name = text" -->
  <!--# if expr="$name != text" -->
  

• 变量与正则表达式的比较：

  <!--# if expr="$name = /text/" -->
  <!--# if expr="$name != /text/" -->
  

如果 atext包含变量，则它们的值将被替换。正则表达式可以包含位置和命名捕获，稍后可以通过变量使用这些捕获，例如：

<!--# if expr="$name = /(.+)@(?P<domain>.+)/" -->
    <!--# echo var="1" -->
    <!--# echo var="domain" -->
<!--# endif -->

include

将另一个请求的结果包含到响应中。该命令具有以下参数：

file

指定包含的文件，例如：

<!--# include file="footer.html" -->

virtual

指定包含的请求，例如：

<!--# include virtual="/remote/body.php?argument=value" -->

在一页上指定并由代理服务器或 FastCGI/uwsgi/SCGI/gRPC 服务器处理的多个请求并行运行。如果需要顺序处理，wait 则应使用该参数。

stub

一个非标准参数，用于命名如果包含的请求结果为空正文或在请求处理期间发生错误，则将输出其内容的块，例如：

<!--# block name="one" -->&nbsp;<!--# endblock -->
<!--# include virtual="/remote/body.php?argument=value" stub="one" -->

替换块内容在包含的请求上下文中进行处理。

wait

一个非标准参数，指示在继续 SSI 处理之前等待请求完全完成，例如：

<!--# include virtual="/remote/body.php?argument=value" wait="yes" -->

set

非标准参数，指示将请求处理成功的结果写入指定变量，例如：

<!--# include virtual="/remote/body.php?argument=value" set="one" -->

响应的最大大小由subrequest_output_buffer_size指令 设置 （1.13.10）：

location /remote/ {
    subrequest_output_buffer_size 64k;
    ...
}

在版本 1.13.10 之前，只有使用ngx_http_proxy_module、 ngx_http_memcached_module、 ngx_http_fastcgi_module (1.5.6)、 ngx_http_uwsgi_module (1.5.6) 和ngx_http_scgi_module (1.5.6) 模块 获得的响应结果 可以写入变量。响应的最大大小是使用 proxy_buffer_size、 memcached_buffer_size、 fastcgi_buffer_size、 uwsgi_buffer_size和scgi_buffer_size 指令设置的。

set

设置变量的值。该命令具有以下参数：

var

变量名。

value

变量值。如果指定的值包含变量，则它们的值将被替换。

该ngx_http_ssi_module模块支持两个嵌入变量：

$date_local

当地时区的当前时间。格式由config带有timefmt参数的命令设置。

$date_gmt

GMT 当前时间。格式由config带有timefmt参数的命令设置。